Finalize or Abort Push Request
put
/api/v1/bots/{botId}/dynamicEntities/{entityId}/pushRequests/{pushRequestId}/{action}
Use this operation to finalize or abort the push request.
- Set the
{action}
toDONE
to close an open push request and then start training the entity. - Set the
{action}
toABORT
to abort the push request. You can't abort a push request if it is training or it has completed.
Request
Path Parameters
-
action(required): string
The action to perform.Allowed Values:
[ "ABORT", "DONE" ]
-
botId(required): string
The ID of the skill that contains the entity.
-
entityId(required): string
The ID of the entity that the push request is for.
-
pushRequestId(required): string
Perform the action on the push request that has this ID.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
202 Response
Action successfully completed.
404 Response
The request can't be performed because the specified skill, entity, or push request 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
Can't perform the action because the push request is not
INPROGRESS
.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" ]