Pular para o conteúdo

List intents

Requisição

Segurança
httpAuth
Caminho
domainIdstring, (uuid)obrigatório

Unique identifier for the domain.

Consulta
limitinteger, (int32), [ 1 .. 100 ]

The number of entities to return.

startingAfterstring, non-empty

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

sortBystring

Property name used to sort the query results.

Enum:"id""state.status""details.expiryAt""details.metadata.createdAt""state.lastModifiedAt"
sortOrderstring

Sort order applied to the query results.

Enum:"ASC""DESC"
details.payload.typeArray of strings

Return entities intents matching given intent types.

Items Enum:"v0_NotarizeData""v0_ExecuteExtension""v0_CreateDomain""v0_UpdateDomain""v0_UpdateDomainPermissions""v0_UnlockDomain""v0_LockDomain""v0_CreateUser""v0_UpdateUser""v0_UnlockUser"
Exemplo:details.payload.type=v0_CreateUser&details.payload.type=v0_LockAccount
details.author.domainIdstring, (uuid)

Return entities intents matching given author domain id.

Exemplo:details.author.domainId=8e92eb53-40e7-4809-bb52-7e7b3b41a4be
details.author.idstring, (uuid)

Return entities intents matching given author id.

Exemplo:details.author.id=fdeeeb4b-f987-4ec4-9880-1eb280581d49
details.targetDomainIdArray of strings, (uuid)

Return entities intents matching given target domain id.

Exemplo:details.targetDomainId=fdeeeb4b-f987-4ec4-9880-1eb280581d49
details.metadata.descriptionstring, >= 0 characters

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

Exemplo:details.metadata.description=description1
details.metadata.customPropertiesArray of strings

Return entities intents that contains provided custom properties.

Exemplo:details.metadata.customProperties=key1:value1&details.metadata.customProperties=key2:value2
state.statusArray of strings

Return entities intents matching given status.

Items Enum:"Open""Approved""Executed""Failed""Expired""Rejected""Executing"
Exemplo:state.status=Executed
entityIdstring

Return entity intents.

Exemplo:entityId=90c4cf2f-ebe0-4bf7-91cd-4c45cd02277b
revisioninteger, (int64), >= 1

Return entities intents matching provided revision.

Exemplo:revision=100
policyIdstring, (uuid)

Return entities intents with matching policy id being executed.

Exemplo:policyId=8e92eb53-40e7-4809-bb52-7e7b3b41a4be
curl -i -X GET \
  'https://docs.ripple.com/_mock/pt-br/products/custody/devbox/v1/domains/{domainId}/intents?limit=1&startingAfter=string&sortBy=id&sortOrder=ASC&details.payload.type=v0_CreateUser%2Cv0_LockAccount&details.author.domainId=8e92eb53-40e7-4809-bb52-7e7b3b41a4be&details.author.id=fdeeeb4b-f987-4ec4-9880-1eb280581d49&details.targetDomainId=fdeeeb4b-f987-4ec4-9880-1eb280581d49&details.metadata.description=description1&details.metadata.customProperties=key1%3Avalue1%2Ckey2%3Avalue2&state.status=Executed&entityId=90c4cf2f-ebe0-4bf7-91cd-4c45cd02277b&revision=100&policyId=8e92eb53-40e7-4809-bb52-7e7b3b41a4be' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Respostas

Corpoapplication/json
itemsArray of objectsobrigatório
countinteger, (int32)obrigatório
currentStartingAfterstring
nextStartingAfterstring
Resposta
{
  "items": [
    { … }
  ],
  "count": 0,
  "currentStartingAfter": "string",
  "nextStartingAfter": "string"
}