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 TRAINING.

Request

Path Parameters
Query Parameters
  • To retain the original value set, set this to TRUE. To replace the original value set, set this to FALSE. The default is FALSE.

    When you push data to the push request, the service ignores modify and delete objects in the request body if this parameter is set to FALSE or is omitted.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

201 Response

Push Request created.
Body ()
Root Schema : DynamicEntityPushRequest
Type: object
Push-request metadata.
Show Source

404 Response

Can't create the push request because either the skill or the entity doesn't exist.
Body ()
Root Schema : RestError
Type: object
Show Source
Nested Schema : o:errorDetails
Type: array
Show Source
Nested Schema : Location
Type: object
Show Source

412 Response

Another push request for the entity is in progress.
Body ()
Root Schema : RestError
Type: object
Show Source
Nested Schema : o:errorDetails
Type: array
Show Source
Nested Schema : Location
Type: object
Show Source
Back to Top