Push Data to Request
patch
/api/v1/bots/{botId}/dynamicEntities/{entityId}/pushRequests/{pushRequestId}/values
Provides an open push request with the entity values to add, delete, and modify.
You can use this operation to push data to an open (
You can use this operation to push data to an open (
INPROGRESS
) push request until you finalize or abort it.Request
Path Parameters
-
botId(required): string
The ID of the skill that contains the entity.
-
entityId(required): string
The ID of the entity to update.
-
pushRequestId(required): string
The ID of the push request that will perform the changes that are specified in the request body.
Supported Media Types
- application/json
The data to add, delete, and modify.
Root Schema : schema
Type:
object
The data to add, delete, and modify.
Show Source
-
add: array
add
The entity values to add.
-
delete: array
delete
The entity values to delete. The service ignores this object if the
copy
query parameter for the push request was omitted or set toFALSE
. -
modify: array
modify
The entity values to modify. The service ignores this object if the
copy
query parameter for the push request was omitted or set toFALSE
.
Nested Schema : add
Type:
array
The entity values to add.
Show Source
-
Array of:
object DynamicEntityPushTempEntityValue
The entity value and its synonyms.
Nested Schema : delete
Type:
array
The entity values to delete. The service ignores this object if the
Show Source
copy
query parameter for the push request was omitted or set to FALSE
.-
Array of:
object DynamicEntityPushTempEntityValue
The entity value and its synonyms.
Nested Schema : modify
Type:
array
The entity values to modify. The service ignores this object if the
Show Source
copy
query parameter for the push request was omitted or set to FALSE
.-
Array of:
object DynamicEntityPushTempEntityValue
The entity value and its synonyms.
Nested Schema : DynamicEntityPushTempEntityValue
Type:
object
The entity value and its synonyms.
Show Source
-
canonicalName(required): string
The entity value.
-
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
). -
id: string
Read Only:
true
The resource's unique ID. -
links: array
links
Read Only:
true
An array of links to the resource. -
nativeLanguageTag: string
The native language tag to use for the entity value. The tag must identify one of the languages that the skill supports. This property is required for native multi-language skills, even for entries for the primary language. This property is not valid for skills that aren't native multi-language.
-
primaryLanguageCanonicalName: string
The entity value (
canonicalName
) for the primary language. This property is required for secondary-language entity values for native multi-language skills. If you include it for a primary-language entity value, then it must be equal to thecanonicalName
value. The property must not be included for skills that aren't native multi-language. -
synonyms: array
synonyms
Synonyms for the entity value.
-
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 : synonyms
Type:
array
Synonyms for the entity value.
Show Source
-
Array of:
string
Synonyms for the entity value.
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
Response
Supported Media Types
- application/json
200 Response
The data was pushed to the request.
404 Response
The request can't be performed because the 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 push the data to the request because the 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" ]