Jump to

• Request
• Response

Get Dynamic Entities

get

/api/v1/bots/{botId}/dynamicEntities

Returns the list of dynamic entities for the given skill. You can use this operation to find a dynamic entity's ID.

Request

Path Parameters

• botId: string
  The skill's ID.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success.

Body ()

Root Schema : DynamicEntitiesPaginatedData

Type: object

List of a skill's dynamic entities.

Show Source

• count(optional): integer(int32)
  The number of items returned.
• hasMore(optional): boolean
  Indicates if there are more items to be returned.
• items(optional): array items
  The items being returned.
• limit(optional): integer(int32)
  The maximum number of items to return.
• links(optional): array links
• offset(optional): integer(int32)
  The actual index from which the items are returned.
• totalResults(optional): integer(int32)
  The total number of items.

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"The items being returned.",
            "items":{
                "$ref":"#/components/schemas/NamedEntityDetail"
            }
        },
        "count":{
            "type":"integer",
            "description":"The number of items returned.",
            "format":"int32",
            "nullable":true
        },
        "totalResults":{
            "type":"integer",
            "description":"The total number of items.",
            "format":"int32",
            "nullable":true
        },
        "offset":{
            "type":"integer",
            "description":"The actual index from which the items are returned.",
            "format":"int32",
            "nullable":true
        },
        "limit":{
            "type":"integer",
            "description":"The maximum number of items to return.",
            "format":"int32",
            "nullable":true
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates if there are more items to be returned."
        },
        "links":{
            "type":"array",
            "properties":{
                "selfLinks":{
                    "type":"object",
                    "properties":{
                        "absolutePathBuilder":{
                            "type":"object"
                        },
                        "requestUri":{
                            "type":"string",
                            "format":"uri"
                        },
                        "baseUri":{
                            "type":"string",
                            "format":"uri"
                        },
                        "requestUriBuilder":{
                            "type":"object"
                        },
                        "baseUriBuilder":{
                            "type":"object"
                        },
                        "pathParameters":{
                            "type":"object",
                            "properties":{
                                "empty":{
                                    "type":"boolean"
                                }
                            },
                            "additionalProperties":{
                                "type":"array",
                                "items":{
                                    "type":"string"
                                }
                            }
                        },
                        "queryParameters":{
                            "type":"object",
                            "properties":{
                                "empty":{
                                    "type":"boolean"
                                }
                            },
                            "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",
                                        "properties":{
                                            "empty":{
                                                "type":"boolean"
                                            }
                                        },
                                        "additionalProperties":{
                                            "type":"array",
                                            "items":{
                                                "type":"string"
                                            }
                                        }
                                    },
                                    "path":{
                                        "type":"string"
                                    }
                                }
                            }
                        },
                        "absolutePath":{
                            "type":"string",
                            "format":"uri"
                        },
                        "path":{
                            "type":"string"
                        }
                    },
                    "writeOnly":true
                },
                "empty":{
                    "type":"boolean"
                }
            },
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    },
    "description":"List of a skill's dynamic entities."
}

Nested Schema : items

Type: array

The items being returned.

Show Source

• Array of: object NamedEntityDetail
  Entity details.

{
    "type":"array",
    "description":"The items being returned.",
    "items":{
        "$ref":"#/components/schemas/NamedEntityDetail"
    }
}

Nested Schema : links

Type: array

Show Source

• empty(optional): boolean
• selfLinks(optional): object selfLinks

{
    "type":"array",
    "properties":{
        "selfLinks":{
            "type":"object",
            "properties":{
                "absolutePathBuilder":{
                    "type":"object"
                },
                "requestUri":{
                    "type":"string",
                    "format":"uri"
                },
                "baseUri":{
                    "type":"string",
                    "format":"uri"
                },
                "requestUriBuilder":{
                    "type":"object"
                },
                "baseUriBuilder":{
                    "type":"object"
                },
                "pathParameters":{
                    "type":"object",
                    "properties":{
                        "empty":{
                            "type":"boolean"
                        }
                    },
                    "additionalProperties":{
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    }
                },
                "queryParameters":{
                    "type":"object",
                    "properties":{
                        "empty":{
                            "type":"boolean"
                        }
                    },
                    "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",
                                "properties":{
                                    "empty":{
                                        "type":"boolean"
                                    }
                                },
                                "additionalProperties":{
                                    "type":"array",
                                    "items":{
                                        "type":"string"
                                    }
                                }
                            },
                            "path":{
                                "type":"string"
                            }
                        }
                    }
                },
                "absolutePath":{
                    "type":"string",
                    "format":"uri"
                },
                "path":{
                    "type":"string"
                }
            },
            "writeOnly":true
        },
        "empty":{
            "type":"boolean"
        }
    },
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Show Source

• Array of: object Link

{
    "type":"array",
    "properties":{
        "selfLinks":{
            "type":"object",
            "properties":{
                "absolutePathBuilder":{
                    "type":"object"
                },
                "requestUri":{
                    "type":"string",
                    "format":"uri"
                },
                "baseUri":{
                    "type":"string",
                    "format":"uri"
                },
                "requestUriBuilder":{
                    "type":"object"
                },
                "baseUriBuilder":{
                    "type":"object"
                },
                "pathParameters":{
                    "type":"object",
                    "properties":{
                        "empty":{
                            "type":"boolean"
                        }
                    },
                    "additionalProperties":{
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    }
                },
                "queryParameters":{
                    "type":"object",
                    "properties":{
                        "empty":{
                            "type":"boolean"
                        }
                    },
                    "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",
                                "properties":{
                                    "empty":{
                                        "type":"boolean"
                                    }
                                },
                                "additionalProperties":{
                                    "type":"array",
                                    "items":{
                                        "type":"string"
                                    }
                                }
                            },
                            "path":{
                                "type":"string"
                            }
                        }
                    }
                },
                "absolutePath":{
                    "type":"string",
                    "format":"uri"
                },
                "path":{
                    "type":"string"
                }
            },
            "writeOnly":true
        },
        "empty":{
            "type":"boolean"
        }
    },
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : NamedEntityDetail

Type: object

Entity details.

Show Source

• id(optional): string
  Entity ID.
• name(optional): string
  Entity name.
• type(optional): string
  Entity type.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Entity ID."
        },
        "name":{
            "type":"string",
            "description":"Entity name."
        },
        "type":{
            "type":"string",
            "description":"Entity type."
        }
    },
    "description":"Entity details."
}

Nested Schema : selfLinks

Type: object

Show Source

• absolutePath(optional): string(uri)
• absolutePathBuilder(optional): object absolutePathBuilder
• baseUri(optional): string(uri)
• baseUriBuilder(optional): object baseUriBuilder
• matchedResources(optional): array matchedResources
• matchedURIs(optional): array matchedURIs
• path(optional): string
• pathParameters(optional): object pathParameters
  Additional Properties Allowed: additionalProperties
• pathSegments(optional): array pathSegments
• queryParameters(optional): object queryParameters
  Additional Properties Allowed: additionalProperties
• requestUri(optional): string(uri)
• requestUriBuilder(optional): object requestUriBuilder

{
    "type":"object",
    "properties":{
        "absolutePathBuilder":{
            "type":"object"
        },
        "requestUri":{
            "type":"string",
            "format":"uri"
        },
        "baseUri":{
            "type":"string",
            "format":"uri"
        },
        "requestUriBuilder":{
            "type":"object"
        },
        "baseUriBuilder":{
            "type":"object"
        },
        "pathParameters":{
            "type":"object",
            "properties":{
                "empty":{
                    "type":"boolean"
                }
            },
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "queryParameters":{
            "type":"object",
            "properties":{
                "empty":{
                    "type":"boolean"
                }
            },
            "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",
                        "properties":{
                            "empty":{
                                "type":"boolean"
                            }
                        },
                        "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(optional): string
  URL to the resource
• rel(optional): 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",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    },
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Show Source

• empty(optional): boolean

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    },
    "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",
                "properties":{
                    "empty":{
                        "type":"boolean"
                    }
                },
                "additionalProperties":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            },
            "path":{
                "type":"string"
            }
        }
    }
}

Nested Schema : queryParameters

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    },
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Show Source

• empty(optional): boolean

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    },
    "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(optional): object matrixParameters
  Additional Properties Allowed: additionalProperties
• path(optional): string

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

Nested Schema : matrixParameters

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    },
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Show Source

• empty(optional): boolean

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    },
    "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

The request can't be performed because the specified skill doesn't exist.

Body ()

Root Schema : RestError

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "status":{
            "type":"integer",
            "format":"int32"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "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

• o:colNo(optional): integer(int32)
• o:lineNo(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "o:lineNo":{
            "type":"integer",
            "format":"int32"
        },
        "o:colNo":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Back to Top