Create Push Request
post
/api/v1/bots/{botId}/dynamicEntities/{entityId}/pushRequests
Creates a push request. After you send this request, call the Push Data to Request operation to provide the entity values to delete, add, and modify.
The request fails if the entity has any push requests that have a status of
The request fails if the entity has any push requests that have a status of
TRAINING
.Request
Path Parameters
-
botId(required): string
The ID of the skill that contains the entity.
-
entityId(required): string
Create the push request for the entity that has this ID.
Query Parameters
-
copy(required): boolean
To retain the original value set, set this to
TRUE
. To replace the original value set, set this toFALSE
. The default isFALSE
.
When you push data to the push request, the service ignoresmodify
anddelete
objects in the request body if this parameter is set toFALSE
or is omitted.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
201 Response
Push Request created.
Root 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
404 Response
Can't create the push request because either the skill or the 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" ]
412 Response
Another push request for the entity is in progress.
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" ]