List Digital Assistants
get
/api/v1/digitalAssistants
Returns the list of digital assistants. You can filter the list by name, version, and whether the digital assistant's version is in draft mode or published. You also can filter by base name or by base name and version.
Request
Query Parameters
-
baseName(required): string
Include only extended digital assistants from a base with this name.
-
baseVersion(required): string
Include only extended digital assistants from a base with this version. If you include this parameter then you also must include the
baseName
parameter. -
filterType(required): string
Include only the versions that are in the specified state (
DRAFT
orPUBLISHED
).Allowed Values:[ "DRAFT", "PUBLISHED" ]
-
limit: integer(int64)
The number of items to return.Default Value:
100
-
name(required): string
Include only the digital assistants with this name.
-
offset: integer(int64)
The number of items to skip before starting to collect the result set, where
0
is the first item.Default Value:0
-
totalResults: boolean
Whether to return the total number of items that match the request (excluding the paging parameters).Default Value:
false
-
version(required): string
Return only this version. If you include this parameter then you also must include the
name
parameter.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Success.
Root Schema : DigitalAssistantsPaginatedData
Type:
object
List of digital assistants.
Show Source
-
count: integer
(int32)
The number of items returned.
-
hasMore: boolean
Indicates if there are more items to be returned.
-
items: array
items
The items being returned.
-
limit: integer
(int32)
The maximum number of items to return.
-
links: array
links
-
offset: integer
(int32)
The actual index from which the items are returned.
-
totalResults: integer
(int32)
The total number of items.
Nested Schema : items
Type:
array
The items being returned.
Show Source
-
Array of:
object BotDetail
Skill or digital assistant details.
Nested Schema : BotDetail
Type:
object
Skill or digital assistant details.
Show Source
-
baseBot: object
BotDetail
Skill or digital assistant details.
-
createdOn: string
(date-time)
Skill or digital assistant creation date.
-
fromSkillStore: boolean
Indicates if the bot was installed from the skill store.
-
id: string
Skill or digital assistant ID.
-
multilingualMode: string
Skill or digital assistant multilingual mode.
-
name: string
Skill or digital assistant name.
-
nativeLanguageTags: array
nativeLanguageTags
Native multilingual skill or digital assistant supported language tags.
-
platformVersion: string
Skill or digital assistant platform version.
-
primaryLanguageTag: string
Multilingual skill or digital assistant primary language tag.
-
status: string
Allowed Values:
[ "DRAFT", "PUBLISHED" ]
Skill or digital assistant status. -
version: string
Skill or digital assistant version.
Nested Schema : nativeLanguageTags
Type:
array
Native multilingual skill or digital assistant supported language tags.
Show Source
-
Array of:
string
Native multilingual skill or digital assistant supported language tags.
Nested Schema : selfLinks
Type:
Show Source
object
-
absolutePath: string
(uri)
-
absolutePathBuilder: object
absolutePathBuilder
-
baseUri: string
(uri)
-
baseUriBuilder: object
baseUriBuilder
-
matchedResources: array
matchedResources
-
matchedURIs: array
matchedURIs
-
path: string
-
pathParameters: object
pathParameters
Additional Properties Allowed: additionalProperties
-
pathSegments: array
pathSegments
-
queryParameters: object
queryParameters
Additional Properties Allowed: additionalProperties
-
requestUri: string
(uri)
-
requestUriBuilder: object
requestUriBuilder
Nested Schema : Link
Type:
Show Source
object
-
href: string
URL to the resource
-
rel: string
The relationship with the resource
Nested Schema : absolutePathBuilder
Type:
object
Nested Schema : baseUriBuilder
Type:
object
Nested Schema : requestUriBuilder
Type:
object
Nested Schema : items
Type:
object
Nested Schema : items
Type:
Show Source
object
-
matrixParameters: object
matrixParameters
Additional Properties Allowed: additionalProperties
-
path: string