Change Messages
patch
/api/v1/bots/{botId}/bundles
Changes messages or associated annotations (or both) in the skill's resource bundles. A message is identified by a
If any object in the request body is malformed, or if any object in the request body references a message that doesn't exist, then no changes are made. You can't add keys to the bundle, and you can't update skills that you've pulled from the store.
key
and a languageTag
.If any object in the request body is malformed, or if any object in the request body references a message that doesn't exist, then no changes are made. You can't add keys to the bundle, and you can't update skills that you've pulled from the store.
Request
Path Parameters
-
botId(required): string
The skill's ID.
Supported Media Types
- application/json
The messages or annotations (or both) to change.
Root Schema : schema
Type:
object
The messages or annotations (or both) to change.
Show Source
-
items: array
items
The message to add or change.
Nested Schema : items
Type:
array
The message to add or change.
Show Source
-
Array of:
object LanguageBundleEntryInputForm
The message to add or change.
Nested Schema : LanguageBundleEntryInputForm
Type:
object
The message to add or change.
Show Source
-
annotation: string
Any information that will be useful for those that may need to reference the message later, such as translators.
-
key(required): string
A unique identifier for a message in the default language and all its equivalent strings in other languages. The combination of
key
andlanguageTag
identifies a specific entry in the resource bundle. -
languageTag(required): string
Language identifier using IETF BCP 47 language tag. For example, use
fr
for French andde
for German. Usedefault
for the skill's primary language. -
message: string
The text to use in the skill conversation for the specified
languageTag
andkey
. This property is required for the POST method and is optional for the PATCH method.
Response
Supported Media Types
- application/json
200 Response
Array of the messages that were changed in the resource bundle.
Root Schema : BundleEntries
Type:
array
List of a skill's resource bundle messages.
Show Source
-
Array of:
object LanguageBundleEntry
Resource bundle message.
Nested Schema : LanguageBundleEntry
Type:
object
Resource bundle message.
Show Source
-
annotation: string
Any information that will be useful for those that may need to reference the message later, such as translators.
-
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
). -
extensionType: string
Allowed Values:
[ "INHERITED", "CUSTOMIZED" ]
If the skill was extended from another skill, then this property shows if the message is a custom message or it was inherited from the original skill. -
id: string
Read Only:
true
The resource's unique ID. -
key: string
A unique identifier for a message in the default language and all its equivalent strings in other languages. The combination of
key
andlanguageTag
identifies a specific entry in the resource bundle. -
languageTag: string
Language identifier using IETF BCP 47 language tag. For example, use
fr
for French andde
for German. Usedefault
for the skill's primary language. -
links: array
links
Read Only:
true
An array of links to the resource. -
message: string
The text to use in the skill conversation for the specified
languageTag
andkey
. This property is required for the POST method and is optional for the PATCH method. -
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
400 Response
Either the request body is malformed or one or more objects reference a
key
and languageTag
pair that doesn't exist in the skill's resource bundles. Note that you can't use this method to add messages. You only can update existing ones.Root Schema : LanguageBundleEntryErrorForm
Type:
object
List of the invalid messages.
Show Source
-
detail: string
The description of the error.
-
invalidEntries: array
invalidEntries
If the request failed because of bad keys or duplicate entries, this contains information about the message objects in the request body that caused the request to fail.
Nested Schema : invalidEntries
Type:
array
If the request failed because of bad keys or duplicate entries, this contains information about the message objects in the request body that caused the request to fail.
Show Source
-
Array of:
object LanguageBundleEntry
Resource bundle message.
Nested Schema : LanguageBundleEntry
Type:
object
Resource bundle message.
Show Source
-
annotation: string
Any information that will be useful for those that may need to reference the message later, such as translators.
-
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
). -
extensionType: string
Allowed Values:
[ "INHERITED", "CUSTOMIZED" ]
If the skill was extended from another skill, then this property shows if the message is a custom message or it was inherited from the original skill. -
id: string
Read Only:
true
The resource's unique ID. -
key: string
A unique identifier for a message in the default language and all its equivalent strings in other languages. The combination of
key
andlanguageTag
identifies a specific entry in the resource bundle. -
languageTag: string
Language identifier using IETF BCP 47 language tag. For example, use
fr
for French andde
for German. Usedefault
for the skill's primary language. -
links: array
links
Read Only:
true
An array of links to the resource. -
message: string
The text to use in the skill conversation for the specified
languageTag
andkey
. This property is required for the POST method and is optional for the PATCH method. -
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
A skill with the specified
botId
does not 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" ]