List Messages
get
/api/v1/bots/{botId}/bundles
Returns a list of the messages from all the skill's resource bundles, where each object in the response array represents a message for a specific language for a given
key
.Request
Path Parameters
-
botId(required): string
The skill's ID.
Query Parameters
-
filterBy(required): string
The type of messages to retrieve. To get all messages, omit this parameter. Accepted values are
intent
,qna
,configuration
anduser
. -
limit: integer(int64)
The number of items to return.Default Value:
100
-
offset: integer(int64)
The number of items to skip before starting to collect the result set, where
0
is the first item.Default Value:0
-
totalResults: boolean
Whether to return the total number of items that match the request (excluding the paging parameters).Default Value:
false
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Success.
Root Schema : PaginatedBundleEntries
Type:
object
List of a skill's resource bundle messages.
Show Source
-
items: object
PagingDataBundleEntryByKey
List of a skill's resource bundle messages.
Nested Schema : PagingDataBundleEntryByKey
Type:
object
List of a skill's resource bundle messages.
Show Source
-
count: integer
(int32)
The number of items returned.
-
hasMore: boolean
Indicates if there are more items to be returned.
-
items: array
items
The items being returned.
-
limit: integer
(int32)
The maximum number of items to return.
-
links: array
links
-
offset: integer
(int32)
The actual index from which the items are returned.
-
totalResults: integer
(int32)
The total number of items.
Nested Schema : items
Type:
array
The items being returned.
Show Source
-
Array of:
object BundleEntryByKey
The items being returned.
Nested Schema : BundleEntryByKey
Type:
object
The items being returned.
Show Source
-
extensionType: string
Allowed Values:
[ "INHERITED", "CUSTOMIZED" ]
-
key: string
-
languages: object
languages
Additional Properties Allowed: BundleMessage
Nested Schema : BundleMessage
Type:
Show Source
object
-
annotation: string
-
extensionType: string
Allowed Values:
[ "INHERITED", "CUSTOMIZED" ]
-
id: string
-
message: string
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
The filterBy query parameter value is not supported.
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" ]
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" ]