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: string
The ID of the skill or digital assistant that contains the entity.
-
entityId: string
Return only the push requests for the entity that has this ID.
Query Parameters
-
limit(optional): integer(int64)
The number of items to return.
-
offset(optional): integer(int64)
The number of items to skip before starting to collect the result set, where
0
is the first item. -
orderBy(optional): 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: string
Return only the push requests with a status that contains this string (case-insensitive).
-
totalResults(optional): boolean
Whether to return the total number of items that match the request (excluding the paging parameters).
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(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 DynamicEntityPushRequest
Push-request metadata.
Nested Schema : DynamicEntityPushRequest
Type:
object
Push-request metadata.
Show Source
-
createdOn(optional):
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
). -
id(optional):
string
Read Only:
true
The resource's unique ID. -
links(optional):
array links
Read Only:
true
An array of links to the resource. -
status(optional):
string
Read Only:
true
Allowed Values:[ "INPROGRESS", "TRAINING", "COMPLETED", "ABORTED", "TERMINATED_BY_ERROR" ]
The status of the push request. -
statusMessage(optional):
string
Read Only:
true
The message associated with the push request. -
updatedOn(optional):
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(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
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 : 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, or entity 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