v1

latestOpenAPI 3.0.12026-08-061638881007.6 KB
Intents

List intents

get/v1/domains/{domainId}/intents

Path parameters

domainIdstring uuid required

Unique identifier for the domain.

Query parameters

limitinteger

The number of entities to return.

startingAfterstring

Return entity intents starting after given intent. DomainId and IntentId should be separated with underscore (_)

sortBy'id' | 'state.status' | 'details.expiryAt' | 'details.metadata.createdAt' | 'state.lastModifiedAt'

Property name used to sort the query results.

sortOrder'ASC' | 'DESC'

Sort order applied to the query results.

details.payload.typeCoreIntentType[]

Return entities intents matching given intent types.

details.author.domainIdstring uuid

Return entities intents matching given author domain id.

details.author.idstring uuid

Return entities intents matching given author id.

details.author.subjectstring

Return entities intents matching given service-author subject.

details.targetDomainIdstring[]

Return entities intents matching given target domain id.

details.metadata.descriptionstring

Return entities intents with descriptions that contains or equals to provided description.

details.metadata.customPropertiesstring[]

Return entities intents that contains provided custom properties.

state.statusCoreIntentStatus[]

Return entities intents matching given status.

entityIdstring

Return entity intents.

revisioninteger

Return entities intents matching provided revision.

policyIdstring uuid

Return entities intents with matching policy id being executed.

Response

countinteger required
currentStartingAfterstring
nextStartingAfterstring