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(required): 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: 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 NamedEntityDetail
Entity details.
Nested Schema : NamedEntityDetail
Type:
object
Entity details.
Show Source
-
id: string
Entity ID.
-
name: string
Entity name.
-
type: string
Entity type.
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
404 Response
The request can't be performed because the specified skill doesn't exist.
Nested Schema : Context
Type:
Show Source
object
-
elementName: string
-
elementType: string
Allowed Values:
[ "state", "defaultTransitionAction", "inputParameter", "outputParameter", "variable", "eventMapping", "intent", "entity" ]
-
subElementName: string
-
subElementType: string
Allowed Values:
[ "stateProperty", "componentProperty", "transition", "transitionAction", "property", "inputParameter", "outputParameter" ]