Jump to

• Request
• Response

Add Messages

post

/api/v1/bots/{botId}/bundles

If you have a multi-language skill, you can use this method to add messages in other languages to an existing resource bundle entry. A resource bundle entry is a set of messages (strings) for a given key where each message contains the text for a different language (languageTag).

All bundle entries contain a message for the default language, and you use this method to add the translations for other languages. Say, for example, the default language is Spanish, and there is a message with the key "Hello_Message" and the languageTag "default". You can use this method to add a French version of the message with the key "Hello_Message" and the languageTag "fr".

If any objects in the request body are malformed, if a resource bundle entry doesn't exist for a specified key, or any object references a language that already exists for the key, then no changes are made, and the response status is either 400 (non-existing key) or 409 (duplicate). If the request body has some objects with non-existing keys and some objects with duplicate key/language combinations, then the response status is 409 and the response body contains only the objects with duplicate key/language combinations. If there were any objects with non-existing keys, the response body will not report these.

You can't use this method add keys or to modify existing messages or annotations. You also can't use this method to modify bundles in skills that you've pulled from the store.

Request

Path Parameters

• botId(required): string
  The skill's ID.

Supported Media Types

• application/json

Request Body - application/json ()

The messages to add for languages other than the default language.

Root Schema : schema

Type: object

The messages or annotations (or both) to change.

Show Source

• items: array items
  The message to add or change.

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"The message to add or change.",
            "items":{
                "$ref":"#/components/schemas/LanguageBundleEntryInputForm"
            }
        }
    },
    "description":"The messages or annotations (or both) to change."
}

Nested Schema : items

Type: array

The message to add or change.

Show Source

• Array of: object LanguageBundleEntryInputForm
  The message to add or change.

{
    "type":"array",
    "description":"The message to add or change.",
    "items":{
        "$ref":"#/components/schemas/LanguageBundleEntryInputForm"
    }
}

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 and languageTag 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 and de for German. Use default for the skill's primary language.
• message: string
  The text to use in the skill conversation for the specified languageTag and key. This property is required for the POST method and is optional for the PATCH method.

{
    "required":[
        "key",
        "languageTag"
    ],
    "type":"object",
    "properties":{
        "languageTag":{
            "type":"string",
            "description":"Language identifier using IETF BCP 47 language tag. For example, use <code>fr</code> for French and <code>de</code> for German. Use <code>default</code> for the skill's primary language."
        },
        "key":{
            "type":"string",
            "description":"A unique identifier for a message in the default language and all its equivalent strings in other languages. The combination of <code>key</code> and <code>languageTag</code> identifies a specific entry in the resource bundle."
        },
        "annotation":{
            "type":"string",
            "description":"Any information that will be useful for those that may need to reference the message later, such as translators."
        },
        "message":{
            "type":"string",
            "description":"The text to use in the skill conversation for the specified <code>languageTag</code> and <code>key</code>. This property is required for the POST method and is optional for the PATCH method."
        }
    },
    "description":"The message to add or change."
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Array of all the messages that were added to the resource bundle.

Body ()

Root Schema : BundleEntries

Type: array

List of a skill's resource bundle messages.

Show Source

• Array of: object LanguageBundleEntry
  Resource bundle message.

{
    "type":"array",
    "description":"List of a skill's resource bundle messages.",
    "items":{
        "$ref":"#/components/schemas/LanguageBundleEntry"
    }
}

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 and languageTag identifies a specific entry in the resource bundle.
• languageTag: string
  Language identifier using IETF BCP 47 language tag. For example, use fr for French and de for German. Use default 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 and key. 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).

{
    "type":"object",
    "properties":{
        "createdOn":{
            "type":"string",
            "description":"The date and time, in ISO 8601 format, that the resource was created (for example, <code>2018-10-17T06:50:34.045Z</code>).",
            "format":"date-time",
            "readOnly":true
        },
        "updatedOn":{
            "type":"string",
            "description":"The date and time, in ISO 8601 format, that the resource was last modified (for example, <code>2018-10-17T06:50:34.045Z</code>).",
            "format":"date-time",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "properties":{
                "selfLinks":{
                    "type":"object",
                    "properties":{
                        "absolutePathBuilder":{
                            "type":"object"
                        },
                        "baseUri":{
                            "type":"string",
                            "format":"uri"
                        },
                        "requestUri":{
                            "type":"string",
                            "format":"uri"
                        },
                        "requestUriBuilder":{
                            "type":"object"
                        },
                        "baseUriBuilder":{
                            "type":"object"
                        },
                        "pathParameters":{
                            "type":"object",
                            "additionalProperties":{
                                "type":"array",
                                "items":{
                                    "type":"string"
                                }
                            }
                        },
                        "queryParameters":{
                            "type":"object",
                            "additionalProperties":{
                                "type":"array",
                                "items":{
                                    "type":"string"
                                }
                            }
                        },
                        "matchedURIs":{
                            "type":"array",
                            "items":{
                                "type":"string"
                            }
                        },
                        "matchedResources":{
                            "type":"array",
                            "items":{
                                "type":"object"
                            }
                        },
                        "pathSegments":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "matrixParameters":{
                                        "type":"object",
                                        "additionalProperties":{
                                            "type":"array",
                                            "items":{
                                                "type":"string"
                                            }
                                        }
                                    },
                                    "path":{
                                        "type":"string"
                                    }
                                }
                            }
                        },
                        "absolutePath":{
                            "type":"string",
                            "format":"uri"
                        },
                        "path":{
                            "type":"string"
                        }
                    },
                    "writeOnly":true
                },
                "empty":{
                    "type":"boolean"
                }
            },
            "description":"An array of links to the resource.",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "id":{
            "type":"string",
            "description":"The resource's unique ID.",
            "readOnly":true
        },
        "message":{
            "type":"string",
            "description":"The text to use in the skill conversation for the specified <code>languageTag</code> and <code>key</code>. This property is required for the POST method and is optional for the PATCH method."
        },
        "languageTag":{
            "type":"string",
            "description":"Language identifier using IETF BCP 47 language tag. For example, use <code>fr</code> for French and <code>de</code> for German. Use <code>default</code> for the skill's primary language."
        },
        "key":{
            "type":"string",
            "description":"A unique identifier for a message in the default language and all its equivalent strings in other languages. The combination of <code>key</code> and <code>languageTag</code> identifies a specific entry in the resource bundle."
        },
        "annotation":{
            "type":"string",
            "description":"Any information that will be useful for those that may need to reference the message later, such as translators."
        },
        "extensionType":{
            "type":"string",
            "description":"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.",
            "enum":[
                "INHERITED",
                "CUSTOMIZED"
            ]
        }
    },
    "description":"Resource bundle message."
}

Nested Schema : links

Type: array

Read Only: true

An array of links to the resource.

Show Source

• empty: boolean
• selfLinks: object selfLinks

{
    "type":"array",
    "properties":{
        "selfLinks":{
            "type":"object",
            "properties":{
                "absolutePathBuilder":{
                    "type":"object"
                },
                "baseUri":{
                    "type":"string",
                    "format":"uri"
                },
                "requestUri":{
                    "type":"string",
                    "format":"uri"
                },
                "requestUriBuilder":{
                    "type":"object"
                },
                "baseUriBuilder":{
                    "type":"object"
                },
                "pathParameters":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    }
                },
                "queryParameters":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    }
                },
                "matchedURIs":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "matchedResources":{
                    "type":"array",
                    "items":{
                        "type":"object"
                    }
                },
                "pathSegments":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "matrixParameters":{
                                "type":"object",
                                "additionalProperties":{
                                    "type":"array",
                                    "items":{
                                        "type":"string"
                                    }
                                }
                            },
                            "path":{
                                "type":"string"
                            }
                        }
                    }
                },
                "absolutePath":{
                    "type":"string",
                    "format":"uri"
                },
                "path":{
                    "type":"string"
                }
            },
            "writeOnly":true
        },
        "empty":{
            "type":"boolean"
        }
    },
    "description":"An array of links to the resource.",
    "readOnly":true,
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Show Source

• Array of: object Link

{
    "type":"array",
    "properties":{
        "selfLinks":{
            "type":"object",
            "properties":{
                "absolutePathBuilder":{
                    "type":"object"
                },
                "baseUri":{
                    "type":"string",
                    "format":"uri"
                },
                "requestUri":{
                    "type":"string",
                    "format":"uri"
                },
                "requestUriBuilder":{
                    "type":"object"
                },
                "baseUriBuilder":{
                    "type":"object"
                },
                "pathParameters":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    }
                },
                "queryParameters":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    }
                },
                "matchedURIs":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "matchedResources":{
                    "type":"array",
                    "items":{
                        "type":"object"
                    }
                },
                "pathSegments":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "matrixParameters":{
                                "type":"object",
                                "additionalProperties":{
                                    "type":"array",
                                    "items":{
                                        "type":"string"
                                    }
                                }
                            },
                            "path":{
                                "type":"string"
                            }
                        }
                    }
                },
                "absolutePath":{
                    "type":"string",
                    "format":"uri"
                },
                "path":{
                    "type":"string"
                }
            },
            "writeOnly":true
        },
        "empty":{
            "type":"boolean"
        }
    },
    "description":"An array of links to the resource.",
    "readOnly":true,
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : selfLinks

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "absolutePathBuilder":{
            "type":"object"
        },
        "baseUri":{
            "type":"string",
            "format":"uri"
        },
        "requestUri":{
            "type":"string",
            "format":"uri"
        },
        "requestUriBuilder":{
            "type":"object"
        },
        "baseUriBuilder":{
            "type":"object"
        },
        "pathParameters":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "queryParameters":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "matchedURIs":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "matchedResources":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "pathSegments":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "matrixParameters":{
                        "type":"object",
                        "additionalProperties":{
                            "type":"array",
                            "items":{
                                "type":"string"
                            }
                        }
                    },
                    "path":{
                        "type":"string"
                    }
                }
            }
        },
        "absolutePath":{
            "type":"string",
            "format":"uri"
        },
        "path":{
            "type":"string"
        }
    },
    "writeOnly":true
}

Nested Schema : Link

Type: object

Show Source

• href: string
  URL to the resource
• rel: string
  The relationship with the resource

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"The relationship with the resource"
        },
        "href":{
            "type":"string",
            "description":"URL to the resource"
        }
    }
}

Nested Schema : absolutePathBuilder

Type: object

Nested Schema : baseUriBuilder

Type: object

Nested Schema : matchedResources

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : matchedURIs

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : pathParameters

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : pathSegments

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "matrixParameters":{
                "type":"object",
                "additionalProperties":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            },
            "path":{
                "type":"string"
            }
        }
    }
}

Nested Schema : queryParameters

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : requestUriBuilder

Type: object

Nested Schema : items

Type: object

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : items

Type: object

Show Source

• matrixParameters: object matrixParameters
  Additional Properties Allowed: additionalProperties
• path: string

{
    "type":"object",
    "properties":{
        "matrixParameters":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "path":{
            "type":"string"
        }
    }
}

Nested Schema : matrixParameters

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

400 Response

Either the request body is malformed or one or more objects reference a key that doesn't exist in the skill's resource bundles. You can't use this method to add keys.

Body ()

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.

{
    "type":"object",
    "properties":{
        "invalidEntries":{
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/LanguageBundleEntry"
            }
        },
        "detail":{
            "type":"string",
            "description":"The description of the error."
        }
    },
    "description":"List of the invalid messages."
}

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.

{
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/LanguageBundleEntry"
    }
}

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 and languageTag identifies a specific entry in the resource bundle.
• languageTag: string
  Language identifier using IETF BCP 47 language tag. For example, use fr for French and de for German. Use default 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 and key. 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).

{
    "type":"object",
    "properties":{
        "createdOn":{
            "type":"string",
            "description":"The date and time, in ISO 8601 format, that the resource was created (for example, <code>2018-10-17T06:50:34.045Z</code>).",
            "format":"date-time",
            "readOnly":true
        },
        "updatedOn":{
            "type":"string",
            "description":"The date and time, in ISO 8601 format, that the resource was last modified (for example, <code>2018-10-17T06:50:34.045Z</code>).",
            "format":"date-time",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "properties":{
                "selfLinks":{
                    "type":"object",
                    "properties":{
                        "absolutePathBuilder":{
                            "type":"object"
                        },
                        "baseUri":{
                            "type":"string",
                            "format":"uri"
                        },
                        "requestUri":{
                            "type":"string",
                            "format":"uri"
                        },
                        "requestUriBuilder":{
                            "type":"object"
                        },
                        "baseUriBuilder":{
                            "type":"object"
                        },
                        "pathParameters":{
                            "type":"object",
                            "additionalProperties":{
                                "type":"array",
                                "items":{
                                    "type":"string"
                                }
                            }
                        },
                        "queryParameters":{
                            "type":"object",
                            "additionalProperties":{
                                "type":"array",
                                "items":{
                                    "type":"string"
                                }
                            }
                        },
                        "matchedURIs":{
                            "type":"array",
                            "items":{
                                "type":"string"
                            }
                        },
                        "matchedResources":{
                            "type":"array",
                            "items":{
                                "type":"object"
                            }
                        },
                        "pathSegments":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "matrixParameters":{
                                        "type":"object",
                                        "additionalProperties":{
                                            "type":"array",
                                            "items":{
                                                "type":"string"
                                            }
                                        }
                                    },
                                    "path":{
                                        "type":"string"
                                    }
                                }
                            }
                        },
                        "absolutePath":{
                            "type":"string",
                            "format":"uri"
                        },
                        "path":{
                            "type":"string"
                        }
                    },
                    "writeOnly":true
                },
                "empty":{
                    "type":"boolean"
                }
            },
            "description":"An array of links to the resource.",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "id":{
            "type":"string",
            "description":"The resource's unique ID.",
            "readOnly":true
        },
        "message":{
            "type":"string",
            "description":"The text to use in the skill conversation for the specified <code>languageTag</code> and <code>key</code>. This property is required for the POST method and is optional for the PATCH method."
        },
        "languageTag":{
            "type":"string",
            "description":"Language identifier using IETF BCP 47 language tag. For example, use <code>fr</code> for French and <code>de</code> for German. Use <code>default</code> for the skill's primary language."
        },
        "key":{
            "type":"string",
            "description":"A unique identifier for a message in the default language and all its equivalent strings in other languages. The combination of <code>key</code> and <code>languageTag</code> identifies a specific entry in the resource bundle."
        },
        "annotation":{
            "type":"string",
            "description":"Any information that will be useful for those that may need to reference the message later, such as translators."
        },
        "extensionType":{
            "type":"string",
            "description":"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.",
            "enum":[
                "INHERITED",
                "CUSTOMIZED"
            ]
        }
    },
    "description":"Resource bundle message."
}

Nested Schema : links

Type: array

Read Only: true

An array of links to the resource.

Show Source

• empty: boolean
• selfLinks: object selfLinks

{
    "type":"array",
    "properties":{
        "selfLinks":{
            "type":"object",
            "properties":{
                "absolutePathBuilder":{
                    "type":"object"
                },
                "baseUri":{
                    "type":"string",
                    "format":"uri"
                },
                "requestUri":{
                    "type":"string",
                    "format":"uri"
                },
                "requestUriBuilder":{
                    "type":"object"
                },
                "baseUriBuilder":{
                    "type":"object"
                },
                "pathParameters":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    }
                },
                "queryParameters":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    }
                },
                "matchedURIs":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "matchedResources":{
                    "type":"array",
                    "items":{
                        "type":"object"
                    }
                },
                "pathSegments":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "matrixParameters":{
                                "type":"object",
                                "additionalProperties":{
                                    "type":"array",
                                    "items":{
                                        "type":"string"
                                    }
                                }
                            },
                            "path":{
                                "type":"string"
                            }
                        }
                    }
                },
                "absolutePath":{
                    "type":"string",
                    "format":"uri"
                },
                "path":{
                    "type":"string"
                }
            },
            "writeOnly":true
        },
        "empty":{
            "type":"boolean"
        }
    },
    "description":"An array of links to the resource.",
    "readOnly":true,
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Show Source

• Array of: object Link

{
    "type":"array",
    "properties":{
        "selfLinks":{
            "type":"object",
            "properties":{
                "absolutePathBuilder":{
                    "type":"object"
                },
                "baseUri":{
                    "type":"string",
                    "format":"uri"
                },
                "requestUri":{
                    "type":"string",
                    "format":"uri"
                },
                "requestUriBuilder":{
                    "type":"object"
                },
                "baseUriBuilder":{
                    "type":"object"
                },
                "pathParameters":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    }
                },
                "queryParameters":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    }
                },
                "matchedURIs":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "matchedResources":{
                    "type":"array",
                    "items":{
                        "type":"object"
                    }
                },
                "pathSegments":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "matrixParameters":{
                                "type":"object",
                                "additionalProperties":{
                                    "type":"array",
                                    "items":{
                                        "type":"string"
                                    }
                                }
                            },
                            "path":{
                                "type":"string"
                            }
                        }
                    }
                },
                "absolutePath":{
                    "type":"string",
                    "format":"uri"
                },
                "path":{
                    "type":"string"
                }
            },
            "writeOnly":true
        },
        "empty":{
            "type":"boolean"
        }
    },
    "description":"An array of links to the resource.",
    "readOnly":true,
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : selfLinks

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "absolutePathBuilder":{
            "type":"object"
        },
        "baseUri":{
            "type":"string",
            "format":"uri"
        },
        "requestUri":{
            "type":"string",
            "format":"uri"
        },
        "requestUriBuilder":{
            "type":"object"
        },
        "baseUriBuilder":{
            "type":"object"
        },
        "pathParameters":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "queryParameters":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "matchedURIs":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "matchedResources":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "pathSegments":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "matrixParameters":{
                        "type":"object",
                        "additionalProperties":{
                            "type":"array",
                            "items":{
                                "type":"string"
                            }
                        }
                    },
                    "path":{
                        "type":"string"
                    }
                }
            }
        },
        "absolutePath":{
            "type":"string",
            "format":"uri"
        },
        "path":{
            "type":"string"
        }
    },
    "writeOnly":true
}

Nested Schema : Link

Type: object

Show Source

• href: string
  URL to the resource
• rel: string
  The relationship with the resource

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"The relationship with the resource"
        },
        "href":{
            "type":"string",
            "description":"URL to the resource"
        }
    }
}

Nested Schema : absolutePathBuilder

Type: object

Nested Schema : baseUriBuilder

Type: object

Nested Schema : matchedResources

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : matchedURIs

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : pathParameters

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : pathSegments

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "matrixParameters":{
                "type":"object",
                "additionalProperties":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            },
            "path":{
                "type":"string"
            }
        }
    }
}

Nested Schema : queryParameters

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : requestUriBuilder

Type: object

Nested Schema : items

Type: object

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : items

Type: object

Show Source

• matrixParameters: object matrixParameters
  Additional Properties Allowed: additionalProperties
• path: string

{
    "type":"object",
    "properties":{
        "matrixParameters":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "path":{
            "type":"string"
        }
    }
}

Nested Schema : matrixParameters

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

404 Response

A skill with the specified botId does not exist.

Body ()

Root Schema : RestError

Type: object

Show Source

• detail: string
• instance: string
• o:ecid: string
• o:errorCode: string
• o:errorDetails: array o:errorDetails
• o:errorPath: string
• o:location: object Location
• o:opcRequestId: string
• status: integer (int32)
• title: string
• type: string

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "status":{
            "type":"integer",
            "format":"int32"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        },
        "instance":{
            "type":"string"
        },
        "o:ecid":{
            "type":"string"
        },
        "o:opcRequestId":{
            "type":"string"
        },
        "o:errorCode":{
            "type":"string"
        },
        "o:errorPath":{
            "type":"string"
        },
        "o:errorDetails":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RestError"
            }
        },
        "o:location":{
            "$ref":"#/components/schemas/Location"
        }
    }
}

Nested Schema : o:errorDetails

Type: array

Show Source

• Array of: object RestError

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RestError"
    }
}

Nested Schema : Location

Type: object

Show Source

• context: object Context
• o:colNo: integer (int32)
• o:lineNo: integer (int32)
• source: string

{
    "type":"object",
    "properties":{
        "source":{
            "type":"string"
        },
        "context":{
            "$ref":"#/components/schemas/Context"
        },
        "o:lineNo":{
            "type":"integer",
            "format":"int32"
        },
        "o:colNo":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : Context

Type: object

Show Source

• 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" ]

{
    "type":"object",
    "properties":{
        "elementType":{
            "type":"string",
            "enum":[
                "state",
                "defaultTransitionAction",
                "inputParameter",
                "outputParameter",
                "variable",
                "eventMapping",
                "intent",
                "entity"
            ]
        },
        "elementName":{
            "type":"string"
        },
        "subElementType":{
            "type":"string",
            "enum":[
                "stateProperty",
                "componentProperty",
                "transition",
                "transitionAction",
                "property",
                "inputParameter",
                "outputParameter"
            ]
        },
        "subElementName":{
            "type":"string"
        }
    }
}

409 Response

Array of all existing resource bundle messages with key and languageTag pairs that match objects in the request body.

Body ()

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.

{
    "type":"object",
    "properties":{
        "invalidEntries":{
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/LanguageBundleEntry"
            }
        },
        "detail":{
            "type":"string",
            "description":"The description of the error."
        }
    },
    "description":"List of the invalid messages."
}

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.

{
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/LanguageBundleEntry"
    }
}

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 and languageTag identifies a specific entry in the resource bundle.
• languageTag: string
  Language identifier using IETF BCP 47 language tag. For example, use fr for French and de for German. Use default 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 and key. 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).

{
    "type":"object",
    "properties":{
        "createdOn":{
            "type":"string",
            "description":"The date and time, in ISO 8601 format, that the resource was created (for example, <code>2018-10-17T06:50:34.045Z</code>).",
            "format":"date-time",
            "readOnly":true
        },
        "updatedOn":{
            "type":"string",
            "description":"The date and time, in ISO 8601 format, that the resource was last modified (for example, <code>2018-10-17T06:50:34.045Z</code>).",
            "format":"date-time",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "properties":{
                "selfLinks":{
                    "type":"object",
                    "properties":{
                        "absolutePathBuilder":{
                            "type":"object"
                        },
                        "baseUri":{
                            "type":"string",
                            "format":"uri"
                        },
                        "requestUri":{
                            "type":"string",
                            "format":"uri"
                        },
                        "requestUriBuilder":{
                            "type":"object"
                        },
                        "baseUriBuilder":{
                            "type":"object"
                        },
                        "pathParameters":{
                            "type":"object",
                            "additionalProperties":{
                                "type":"array",
                                "items":{
                                    "type":"string"
                                }
                            }
                        },
                        "queryParameters":{
                            "type":"object",
                            "additionalProperties":{
                                "type":"array",
                                "items":{
                                    "type":"string"
                                }
                            }
                        },
                        "matchedURIs":{
                            "type":"array",
                            "items":{
                                "type":"string"
                            }
                        },
                        "matchedResources":{
                            "type":"array",
                            "items":{
                                "type":"object"
                            }
                        },
                        "pathSegments":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "matrixParameters":{
                                        "type":"object",
                                        "additionalProperties":{
                                            "type":"array",
                                            "items":{
                                                "type":"string"
                                            }
                                        }
                                    },
                                    "path":{
                                        "type":"string"
                                    }
                                }
                            }
                        },
                        "absolutePath":{
                            "type":"string",
                            "format":"uri"
                        },
                        "path":{
                            "type":"string"
                        }
                    },
                    "writeOnly":true
                },
                "empty":{
                    "type":"boolean"
                }
            },
            "description":"An array of links to the resource.",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "id":{
            "type":"string",
            "description":"The resource's unique ID.",
            "readOnly":true
        },
        "message":{
            "type":"string",
            "description":"The text to use in the skill conversation for the specified <code>languageTag</code> and <code>key</code>. This property is required for the POST method and is optional for the PATCH method."
        },
        "languageTag":{
            "type":"string",
            "description":"Language identifier using IETF BCP 47 language tag. For example, use <code>fr</code> for French and <code>de</code> for German. Use <code>default</code> for the skill's primary language."
        },
        "key":{
            "type":"string",
            "description":"A unique identifier for a message in the default language and all its equivalent strings in other languages. The combination of <code>key</code> and <code>languageTag</code> identifies a specific entry in the resource bundle."
        },
        "annotation":{
            "type":"string",
            "description":"Any information that will be useful for those that may need to reference the message later, such as translators."
        },
        "extensionType":{
            "type":"string",
            "description":"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.",
            "enum":[
                "INHERITED",
                "CUSTOMIZED"
            ]
        }
    },
    "description":"Resource bundle message."
}

Nested Schema : links

Type: array

Read Only: true

An array of links to the resource.

Show Source

• empty: boolean
• selfLinks: object selfLinks

{
    "type":"array",
    "properties":{
        "selfLinks":{
            "type":"object",
            "properties":{
                "absolutePathBuilder":{
                    "type":"object"
                },
                "baseUri":{
                    "type":"string",
                    "format":"uri"
                },
                "requestUri":{
                    "type":"string",
                    "format":"uri"
                },
                "requestUriBuilder":{
                    "type":"object"
                },
                "baseUriBuilder":{
                    "type":"object"
                },
                "pathParameters":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    }
                },
                "queryParameters":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    }
                },
                "matchedURIs":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "matchedResources":{
                    "type":"array",
                    "items":{
                        "type":"object"
                    }
                },
                "pathSegments":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "matrixParameters":{
                                "type":"object",
                                "additionalProperties":{
                                    "type":"array",
                                    "items":{
                                        "type":"string"
                                    }
                                }
                            },
                            "path":{
                                "type":"string"
                            }
                        }
                    }
                },
                "absolutePath":{
                    "type":"string",
                    "format":"uri"
                },
                "path":{
                    "type":"string"
                }
            },
            "writeOnly":true
        },
        "empty":{
            "type":"boolean"
        }
    },
    "description":"An array of links to the resource.",
    "readOnly":true,
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Show Source

• Array of: object Link

{
    "type":"array",
    "properties":{
        "selfLinks":{
            "type":"object",
            "properties":{
                "absolutePathBuilder":{
                    "type":"object"
                },
                "baseUri":{
                    "type":"string",
                    "format":"uri"
                },
                "requestUri":{
                    "type":"string",
                    "format":"uri"
                },
                "requestUriBuilder":{
                    "type":"object"
                },
                "baseUriBuilder":{
                    "type":"object"
                },
                "pathParameters":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    }
                },
                "queryParameters":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    }
                },
                "matchedURIs":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "matchedResources":{
                    "type":"array",
                    "items":{
                        "type":"object"
                    }
                },
                "pathSegments":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "matrixParameters":{
                                "type":"object",
                                "additionalProperties":{
                                    "type":"array",
                                    "items":{
                                        "type":"string"
                                    }
                                }
                            },
                            "path":{
                                "type":"string"
                            }
                        }
                    }
                },
                "absolutePath":{
                    "type":"string",
                    "format":"uri"
                },
                "path":{
                    "type":"string"
                }
            },
            "writeOnly":true
        },
        "empty":{
            "type":"boolean"
        }
    },
    "description":"An array of links to the resource.",
    "readOnly":true,
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : selfLinks

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "absolutePathBuilder":{
            "type":"object"
        },
        "baseUri":{
            "type":"string",
            "format":"uri"
        },
        "requestUri":{
            "type":"string",
            "format":"uri"
        },
        "requestUriBuilder":{
            "type":"object"
        },
        "baseUriBuilder":{
            "type":"object"
        },
        "pathParameters":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "queryParameters":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "matchedURIs":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "matchedResources":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "pathSegments":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "matrixParameters":{
                        "type":"object",
                        "additionalProperties":{
                            "type":"array",
                            "items":{
                                "type":"string"
                            }
                        }
                    },
                    "path":{
                        "type":"string"
                    }
                }
            }
        },
        "absolutePath":{
            "type":"string",
            "format":"uri"
        },
        "path":{
            "type":"string"
        }
    },
    "writeOnly":true
}

Nested Schema : Link

Type: object

Show Source

• href: string
  URL to the resource
• rel: string
  The relationship with the resource

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"The relationship with the resource"
        },
        "href":{
            "type":"string",
            "description":"URL to the resource"
        }
    }
}

Nested Schema : absolutePathBuilder

Type: object

Nested Schema : baseUriBuilder

Type: object

Nested Schema : matchedResources

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : matchedURIs

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : pathParameters

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : pathSegments

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "matrixParameters":{
                "type":"object",
                "additionalProperties":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            },
            "path":{
                "type":"string"
            }
        }
    }
}

Nested Schema : queryParameters

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : requestUriBuilder

Type: object

Nested Schema : items

Type: object

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : items

Type: object

Show Source

• matrixParameters: object matrixParameters
  Additional Properties Allowed: additionalProperties
• path: string

{
    "type":"object",
    "properties":{
        "matrixParameters":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "path":{
            "type":"string"
        }
    }
}

Nested Schema : matrixParameters

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top