List Push Requests
get
/api/v1/bots/{botId}/dynamicEntities/{entityId}/pushRequests
Returns a list of push requests for the specified entity. You can filter the list based on status.
Request
Path Parameters
-
botId(required): string
The ID of the skill or digital assistant that contains the entity.
-
entityId(required): string
Return only the push requests for the entity that has this ID.
Query Parameters
-
limit: integer(int64)
The number of items to return.Default Value:
100
-
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
-
orderBy: string
Comma-delimited list of properties to sort on, major to minor. You can append
:asc
or:desc
to a property to sort in ascending or descending order. For example:updatedOn:desc,name:asc
. The valid sort properties areentityId
,updatedOn
andcreatedOn
. -
status(required): string
Return only the push requests with a status that contains this string (case-insensitive).
-
totalResults: boolean
Whether to return the total number of items that match the request (excluding the paging parameters).Default Value:
false
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Success.
Root Schema : PushRequestPaginatedData
Type:
Show Source
object
-
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 DynamicEntityPushRequest
Push-request metadata.
Nested Schema : DynamicEntityPushRequest
Type:
object
Push-request metadata.
Show Source
-
createdOn: string
(date-time)
Read Only:
true
The date and time, in ISO 8601 format, that the resource was created (for example,2018-10-17T06:50:34.045Z
). -
entityId: string
Read Only:
true
The entity linked to the push request. -
id: string
Read Only:
true
The resource's unique ID. -
links: array
links
Read Only:
true
An array of links to the resource. -
status: string
Read Only:
true
Allowed Values:[ "INPROGRESS", "TRAINING", "COMPLETED", "ABORTED", "TERMINATED_BY_ERROR" ]
The status of the push request. -
statusMessage: string
Read Only:
true
The message associated with the push request. -
updatedOn: string
(date-time)
Read Only:
true
The date and time, in ISO 8601 format, that the resource was last modified (for example,2018-10-17T06:50:34.045Z
).
Nested Schema : links
Type:
array
Read Only:
true
An array of links to the resource.
Show Source
Show Source
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
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 : 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, or entity 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" ]