Skip to main content
POST
Search and filter Policy Components

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

policyId
integer
required

Body

application/json
filter
object
componentData
object
calculateDisplayNames
boolean

If true - will return a 'displayType' field containing a prettified technology field

select
enum<string>[]

If empty - will return all fields (except for tags), if passed will only return selected field

Available options:
id,
policyId,
technology,
name,
componentId,
urgency,
effort,
orgComplexity,
priority,
isCompliant,
currentVersion,
desiredVersion,
recommendedVersion,
status,
extendedSupportAnnualCost,
dueDate,
createdAt,
updatedAt
sort
object

Optional sorting options, if not passed will sort by creation date in ascending order, sorting by a non-unique value will sub-sort by a creation date in ascending order

pageToken
string

Base64 token for pagination

pageSize
integer
default:100

Number of items to return per page

Required range: 1 <= x <= 1000

Response

Success

items
object[]
required
nextPageToken
string | null

Token for fetching the next page of results