Jump to

• Request
• Response

List Skills

get

/api/v1/skills

Returns the list of skills. You can filter the list by name, version, and whether the skill is in draft mode or published. You also can filter by base name or by base name and version.

Request

Query Parameters

• baseName(required): string
  Include only extended skills from a base with this name.
• baseVersion(required): string
  Include only extended skills from a base with this version. If you include this parameter then you also must include the baseName parameter.
• filterType(required): string
  Include only the versions that are in the specified state (DRAFT or PUBLISHED).

  Allowed Values: [ "DRAFT", "PUBLISHED" ]
• limit: integer(int64)
  The number of items to return.

  Default Value: 100
• name(required): string
  Include only the skills with this name.
• 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
• version(required): string
  Return only this version. If you include this parameter then you also must include the name parameter.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success.

Body ()

Root Schema : SkillsPaginatedData

Type: object

List of skills.

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.

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"The items being returned.",
            "items":{
                "$ref":"#/components/schemas/BotDetail"
            }
        },
        "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"
                        },
                        "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"
                }
            },
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    },
    "description":"List of skills."
}

Nested Schema : items

Type: array

The items being returned.

Show Source

• Array of: object BotDetail
  Skill or digital assistant details.

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

Nested Schema : links

Type: array

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"
        }
    },
    "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"
        }
    },
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : BotDetail

Type: object

Skill or digital assistant details.

Show Source

• baseBot: object BotDetail
  Skill or digital assistant details.
• createdOn: string (date-time)
  Skill or digital assistant creation date.
• fromSkillStore: boolean
  Indicates if the bot was installed from the skill store.
• id: string
  Skill or digital assistant ID.
• multilingualMode: string
  Skill or digital assistant multilingual mode.
• name: string
  Skill or digital assistant name.
• nativeLanguageTags: array nativeLanguageTags
  Native multilingual skill or digital assistant supported language tags.
• platformVersion: string
  Skill or digital assistant platform version.
• primaryLanguageTag: string
  Multilingual skill or digital assistant primary language tag.
• status: string
  Allowed Values: [ "DRAFT", "PUBLISHED" ]

  Skill or digital assistant status.
• version: string
  Skill or digital assistant version.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Skill or digital assistant ID."
        },
        "name":{
            "type":"string",
            "description":"Skill or digital assistant name."
        },
        "version":{
            "type":"string",
            "description":"Skill or digital assistant version."
        },
        "status":{
            "type":"string",
            "description":"Skill or digital assistant status.",
            "enum":[
                "DRAFT",
                "PUBLISHED"
            ]
        },
        "platformVersion":{
            "type":"string",
            "description":"Skill or digital assistant platform version."
        },
        "createdOn":{
            "type":"string",
            "description":"Skill or digital assistant creation date.",
            "format":"date-time"
        },
        "fromSkillStore":{
            "type":"boolean",
            "description":"Indicates if the bot was installed from the skill store."
        },
        "baseBot":{
            "$ref":"#/components/schemas/BotDetail"
        },
        "multilingualMode":{
            "type":"string",
            "description":"Skill or digital assistant multilingual mode."
        },
        "primaryLanguageTag":{
            "type":"string",
            "description":"Multilingual skill or digital assistant primary language tag."
        },
        "nativeLanguageTags":{
            "type":"array",
            "description":"Native multilingual skill or digital assistant supported language tags.",
            "items":{
                "type":"string",
                "description":"Native multilingual skill or digital assistant supported language tags."
            }
        }
    },
    "description":"Skill or digital assistant details."
}

Nested Schema : nativeLanguageTags

Type: array

Native multilingual skill or digital assistant supported language tags.

Show Source

• Array of: string
  Native multilingual skill or digital assistant supported language tags.

{
    "type":"array",
    "description":"Native multilingual skill or digital assistant supported language tags.",
    "items":{
        "type":"string",
        "description":"Native multilingual skill or digital assistant supported language tags."
    }
}

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