Get Dynamic Entities
get
/api/v1/bots/{botId}/dynamicEntities
Returns the list of dynamic entities for the given skill. You can use this operation to find a dynamic entity's ID.
Request
Path Parameters
-
botId: string
The skill's ID.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Success.
Root Schema : DynamicEntitiesPaginatedData
Type:
object
List of a skill's dynamic entities.
Show Source
-
count(optional):
integer(int32)
The number of items returned.
-
hasMore(optional):
boolean
Indicates if there are more items to be returned.
-
items(optional):
array items
The items being returned.
-
limit(optional):
integer(int32)
The maximum number of items to return.
-
links(optional):
array links
-
offset(optional):
integer(int32)
The actual index from which the items are returned.
-
totalResults(optional):
integer(int32)
The total number of items.
Nested Schema : items
Type:
array
The items being returned.
Show Source
-
Array of:
object NamedEntityDetail
Entity details.
Nested Schema : NamedEntityDetail
Type:
object
Entity details.
Show Source
-
id(optional):
string
Entity ID.
-
name(optional):
string
Entity name.
-
type(optional):
string
Entity type.
Nested Schema : selfLinks
Type:
Show Source
object
-
absolutePath(optional):
string(uri)
-
absolutePathBuilder(optional):
object absolutePathBuilder
-
baseUri(optional):
string(uri)
-
baseUriBuilder(optional):
object baseUriBuilder
-
matchedResources(optional):
array matchedResources
-
matchedURIs(optional):
array matchedURIs
-
path(optional):
string
-
pathParameters(optional):
object pathParameters
Additional Properties Allowed: additionalProperties
-
pathSegments(optional):
array pathSegments
-
queryParameters(optional):
object queryParameters
Additional Properties Allowed: additionalProperties
-
requestUri(optional):
string(uri)
-
requestUriBuilder(optional):
object requestUriBuilder
Nested Schema : Link
Type:
Show Source
object
-
href(optional):
string
URL to the resource
-
rel(optional):
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(optional):
object matrixParameters
Additional Properties Allowed: additionalProperties
-
path(optional):
string
404 Response
The request can't be performed because the specified skill doesn't exist.
Root Schema : RestError
Type:
Show Source
object
-
detail(optional):
string
-
o:ecid(optional):
string
-
o:errorCode(optional):
string
-
o:errorDetails(optional):
array o:errorDetails
-
o:errorPath(optional):
string
-
o:location(optional):
object Location
-
o:opcRequestId(optional):
string
-
status(optional):
integer(int32)
-
title(optional):
string
-
type(optional):
string