GET/v1/component/{uuid}/occurrence

List occurrences of a component

Lists occurrences associated with a specific component. Use pageNumber with pageSize, or offset with limit, to control the returned results; you can also sort by a field using sortName and sortOrder.

7 parameters
uuidstringrequired
The UUID of the component whose occurrences to retrieve.
pageNumberstringoptional
The page number to return when using page-based pagination. Defaults to 1 when omitted.
Default:1
pageSizestringoptional
The number of occurrences to return per page when using page-based pagination. Defaults to 100 when omitted.
Default:100
offsetstringoptional
The number of occurrences to skip when using offset-based pagination.
limitstringoptional
The maximum number of occurrences to return when using offset-based pagination.
sortNamestringoptional
The name of the occurrence field to sort by.
sortOrderstringoptional
The sort order to use with `sortName`; the schema lists `asc, desc` as the allowed value.
Allowed:asc, desc

4 status codes
200Returns an array of occurrence objects containing available fields such as the occurrence UUID, creation timestamp, line, location, offset, and symbol.
createdAtintegeroptional
UNIX epoch timestamp in milliseconds
idstringoptional
lineintegeroptional
locationstringoptional
offsetintegeroptional
symbolstringoptional
401Returned when the request is unauthorized.
403Returned when access to the requested project is forbidden.
detailstringrequired
Human-readable explanation specific to this occurrence of the problem
instancestringoptional
Reference URI that identifies the specific occurrence of the problem
statusintegerrequired
HTTP status code generated by the origin server for this occurrence of the problem
titlestringrequired
Short, human-readable summary of the problem type
typestringoptional
A URI reference that identifies the problem type
404Returned when the component could not be found.
detailstringrequired
Human-readable explanation specific to this occurrence of the problem
instancestringoptional
Reference URI that identifies the specific occurrence of the problem
statusintegerrequired
HTTP status code generated by the origin server for this occurrence of the problem
titlestringrequired
Short, human-readable summary of the problem type
typestringoptional
A URI reference that identifies the problem type

Error handling

A 401 indicates an unauthorized request, a 403 indicates that the authenticated user lacks access to the requested project, and a 404 indicates that the component could not be found. The uuid path parameter must be a valid UUID identifying the component. The authenticated user must have the VIEW_PORTFOLIO permission to access occurrences.