Search Components

post

https://{domain}/api/v4/components

Body Params

The input.

sorting

string

enum

Sorting

Members:

Ascending - Ascending from A-Z
Descending - Descending from Z-A

Allowed:

pageNumber

int32 | null

1 to 10000

Page number

pageSize

int32 | null

1 to 100

Page size

int32 | null

direct search around a specific componentId.

parentId

int32 | null

direct search around a specific parentId.

teamId

int32 | null

filter based on a specific team Id

userId

uuid | null

filter based on a specific user Id

textSearch

string | null

search name or description of components

includeRequestedComponent

boolean | null

return the requested component in the result set, default true

includeChildren

boolean | null

return children of requested component

includeParents

boolean | null

return parents of requested component

includePeers

boolean | null

retrun peers of requested component

onlyAdjacentLevel

boolean | null

return only direct parents or children of specific component. only used if IncludeChildren or IncludeParents is true.

subscriberId

int32 | null

filter result based on a subscriber Id

minimumRole

string

enum

Members:

Allowed:

includeHiddenComponents

boolean | null

Include hidden components, default is no.

includeCloudComponents

boolean | null

Include components that have been copied from cloud providers.

excludeLocalComponents

boolean | null

Exnclude components that have been created with-in the account.

sortResultsBy

string

enum

Members:

Allowed:

includeLinkedComponents

boolean | null

returns linked components

Responses

401

Unauthorized

403

Forbidden

405

NotAllowed

Language

Credentials

Bearer

JWT

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success