List Digital Assistants
GET {{baseUrl}}/odaInstances/:odaInstanceId/digitalAssistants?limit=100&sortOrder=DESC
Returns a page of Digital Assistants that belong to the specified Digital Assistant instance.
If the opc-next-page
header appears in the response, then
there are more items to retrieve. To get the next page in the subsequent
GET request, include the header's value as the page
query parameter.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
id | string | Unique Digital Assistant identifier. | |
category | string | List only Bot resources with this category. | |
name | string | List only Bot resources with this name. Names are unique and may not change. |
Example: MySkill
|
| version
| string | | List only Bot resources with this version. Versions are unique and may not change.
Example: 1.0
|
| namespace
| string | | List only Bot resources with this namespace. Namespaces may not change.
Example: MyNamespace
|
| platformVersion
| string | | List only Bot resources with this platform version.
|
| lifecycleState
| string | | List only the resources that are in this lifecycle state. |
| lifecycleDetails
| string | | List only Bot resources with this lifecycle details.
|
| limit
| number | | The maximum number of items to return per page. |
| page
| string | | The page at which to start retrieving results.
You get this value from the opc-next-page
header in a previous list request.
To retireve the first page, omit this query parameter.
Example: MToxMA==
|
| sortOrder
| string | | Sort the results in this order, use either ASC
(ascending) or DESC
(descending). |
| sortBy
| string | | Sort on this field. You can specify one sort order only. The default sort field is timeCreated
.
The default sort order for timeCreated
and timeUpdated
is descending.
For all other sort fields the default sort order is ascending.
|
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
opc-request-id | string | The client request ID for tracing. This value is included in the opc-request-id response header. | |
Accept | string |
RESPONSES
status: OK
{"items":[{"id":"Ut esse sed ","name":"eiusmod dolore dolor","version":"1.0","displayName":"labore mollit proident quis","namespace":"minim","category":"deserunt in veniam occaecat","lifecycleState":"INACTIVE","lifecycleDetails":"DRAFT","platformVersion":"pariatur eu","timeCreated":"1950-03-30T03:46:47.498Z","timeUpdated":"1998-08-13T06:14:23.139Z","definedTags":{"non0e":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"freeformTags":{"ut80e":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"doloree":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"et016":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},{"id":"magna mollit exercitation ad","name":"incididunt dolore","version":"1.0","displayName":"amet sit commodo dolor","namespace":"officia ad","category":"Excepteur sit nisi veniam","lifecycleState":"FAILED","lifecycleDetails":"PUBLISHED","platformVersion":"mollit sit sint","timeCreated":"2013-04-11T10:36:29.765Z","timeUpdated":"1996-01-21T04:49:48.301Z","definedTags":{"quis_":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"exbb":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"nulla8":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"freeformTags":{"in_2":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"fugiat_55":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"deseruntb":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}}]}