Lists bots collections

GET 
/api/bots/:botId/collections

Lists the collections the bot has access to based on the configured skills and user's permissions.

Request

Path Parameters

botId uuidrequired

Query Parameters

options object

Responses

200

Success

application/json;odata.metadata=minimal;odata.streaming=true

Schema

Schema

count int64

Total items in server

items object[]nullable
Items retrieved
Array [
id uuid
Collection id (GUID)
title stringnullable
Title of the collection
description stringnullable
A brief description of the collection
jobReference stringnullable
Internal field to track jobs associated to this collection
accessMode CollectionAccessMode
Possible values: [Everyone, MembersOnly]
tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
]
continuationToken stringnullable

A continuation token

Example (from schema)

{
  "count": 0,
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "title": "string",
      "description": "string",
      "jobReference": "string",
      "accessMode": "Everyone",
      "tags": [
        {
          "key": "string"
        }
      ]
    }
  ],
  "continuationToken": "string"
}

application/json;odata.metadata=minimal;odata.streaming=false

Schema

Schema

count int64

Total items in server

items object[]nullable
Items retrieved
Array [
id uuid
Collection id (GUID)
title stringnullable
Title of the collection
description stringnullable
A brief description of the collection
jobReference stringnullable
Internal field to track jobs associated to this collection
accessMode CollectionAccessMode
Possible values: [Everyone, MembersOnly]
tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
]
continuationToken stringnullable

A continuation token

Example (from schema)

{
  "count": 0,
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "title": "string",
      "description": "string",
      "jobReference": "string",
      "accessMode": "Everyone",
      "tags": [
        {
          "key": "string"
        }
      ]
    }
  ],
  "continuationToken": "string"
}

application/json;odata.metadata=minimal

Schema

Schema

count int64

Total items in server

items object[]nullable
Items retrieved
Array [
id uuid
Collection id (GUID)
title stringnullable
Title of the collection
description stringnullable
A brief description of the collection
jobReference stringnullable
Internal field to track jobs associated to this collection
accessMode CollectionAccessMode
Possible values: [Everyone, MembersOnly]
tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
]
continuationToken stringnullable

A continuation token

Example (from schema)

{
  "count": 0,
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "title": "string",
      "description": "string",
      "jobReference": "string",
      "accessMode": "Everyone",
      "tags": [
        {
          "key": "string"
        }
      ]
    }
  ],
  "continuationToken": "string"
}

application/json;odata.metadata=full;odata.streaming=true

Schema

Schema

count int64

Total items in server

items object[]nullable
Items retrieved
Array [
id uuid
Collection id (GUID)
title stringnullable
Title of the collection
description stringnullable
A brief description of the collection
jobReference stringnullable
Internal field to track jobs associated to this collection
accessMode CollectionAccessMode
Possible values: [Everyone, MembersOnly]
tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
]
continuationToken stringnullable

A continuation token

Example (from schema)

{
  "count": 0,
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "title": "string",
      "description": "string",
      "jobReference": "string",
      "accessMode": "Everyone",
      "tags": [
        {
          "key": "string"
        }
      ]
    }
  ],
  "continuationToken": "string"
}

application/json;odata.metadata=full;odata.streaming=false

Schema

Schema

count int64

Total items in server

items object[]nullable
Items retrieved
Array [
id uuid
Collection id (GUID)
title stringnullable
Title of the collection
description stringnullable
A brief description of the collection
jobReference stringnullable
Internal field to track jobs associated to this collection
accessMode CollectionAccessMode
Possible values: [Everyone, MembersOnly]
tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
]
continuationToken stringnullable

A continuation token

Example (from schema)

{
  "count": 0,
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "title": "string",
      "description": "string",
      "jobReference": "string",
      "accessMode": "Everyone",
      "tags": [
        {
          "key": "string"
        }
      ]
    }
  ],
  "continuationToken": "string"
}

application/json;odata.metadata=full

Schema

Schema

count int64

Total items in server

items object[]nullable
Items retrieved
Array [
id uuid
Collection id (GUID)
title stringnullable
Title of the collection
description stringnullable
A brief description of the collection
jobReference stringnullable
Internal field to track jobs associated to this collection
accessMode CollectionAccessMode
Possible values: [Everyone, MembersOnly]
tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
]
continuationToken stringnullable

A continuation token

Example (from schema)

{
  "count": 0,
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "title": "string",
      "description": "string",
      "jobReference": "string",
      "accessMode": "Everyone",
      "tags": [
        {
          "key": "string"
        }
      ]
    }
  ],
  "continuationToken": "string"
}

application/json;odata.metadata=none;odata.streaming=true

Schema

Schema

count int64

Total items in server

items object[]nullable
Items retrieved
Array [
id uuid
Collection id (GUID)
title stringnullable
Title of the collection
description stringnullable
A brief description of the collection
jobReference stringnullable
Internal field to track jobs associated to this collection
accessMode CollectionAccessMode
Possible values: [Everyone, MembersOnly]
tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
]
continuationToken stringnullable

A continuation token

Example (from schema)

{
  "count": 0,
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "title": "string",
      "description": "string",
      "jobReference": "string",
      "accessMode": "Everyone",
      "tags": [
        {
          "key": "string"
        }
      ]
    }
  ],
  "continuationToken": "string"
}

application/json;odata.metadata=none;odata.streaming=false

Schema

Schema

count int64

Total items in server

items object[]nullable
Items retrieved
Array [
id uuid
Collection id (GUID)
title stringnullable
Title of the collection
description stringnullable
A brief description of the collection
jobReference stringnullable
Internal field to track jobs associated to this collection
accessMode CollectionAccessMode
Possible values: [Everyone, MembersOnly]
tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
]
continuationToken stringnullable

A continuation token

Example (from schema)

{
  "count": 0,
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "title": "string",
      "description": "string",
      "jobReference": "string",
      "accessMode": "Everyone",
      "tags": [
        {
          "key": "string"
        }
      ]
    }
  ],
  "continuationToken": "string"
}

application/json;odata.metadata=none

Schema

Schema

count int64

Total items in server

items object[]nullable
Items retrieved
Array [
id uuid
Collection id (GUID)
title stringnullable
Title of the collection
description stringnullable
A brief description of the collection
jobReference stringnullable
Internal field to track jobs associated to this collection
accessMode CollectionAccessMode
Possible values: [Everyone, MembersOnly]
tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
]
continuationToken stringnullable

A continuation token

Example (from schema)

{
  "count": 0,
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "title": "string",
      "description": "string",
      "jobReference": "string",
      "accessMode": "Everyone",
      "tags": [
        {
          "key": "string"
        }
      ]
    }
  ],
  "continuationToken": "string"
}

application/json;odata.streaming=true

Schema

Schema

count int64

Total items in server

items object[]nullable
Items retrieved
Array [
id uuid
Collection id (GUID)
title stringnullable
Title of the collection
description stringnullable
A brief description of the collection
jobReference stringnullable
Internal field to track jobs associated to this collection
accessMode CollectionAccessMode
Possible values: [Everyone, MembersOnly]
tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
]
continuationToken stringnullable

A continuation token

Example (from schema)

{
  "count": 0,
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "title": "string",
      "description": "string",
      "jobReference": "string",
      "accessMode": "Everyone",
      "tags": [
        {
          "key": "string"
        }
      ]
    }
  ],
  "continuationToken": "string"
}

application/json;odata.streaming=false

Schema

Schema

count int64

Total items in server

items object[]nullable
Items retrieved
Array [
id uuid
Collection id (GUID)
title stringnullable
Title of the collection
description stringnullable
A brief description of the collection
jobReference stringnullable
Internal field to track jobs associated to this collection
accessMode CollectionAccessMode
Possible values: [Everyone, MembersOnly]
tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
]
continuationToken stringnullable

A continuation token

Example (from schema)

{
  "count": 0,
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "title": "string",
      "description": "string",
      "jobReference": "string",
      "accessMode": "Everyone",
      "tags": [
        {
          "key": "string"
        }
      ]
    }
  ],
  "continuationToken": "string"
}

application/json

Schema

Schema

count int64

Total items in server

items object[]nullable
Items retrieved
Array [
id uuid
Collection id (GUID)
title stringnullable
Title of the collection
description stringnullable
A brief description of the collection
jobReference stringnullable
Internal field to track jobs associated to this collection
accessMode CollectionAccessMode
Possible values: [Everyone, MembersOnly]
tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
]
continuationToken stringnullable

A continuation token

Example (from schema)

{
  "count": 0,
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "title": "string",
      "description": "string",
      "jobReference": "string",
      "accessMode": "Everyone",
      "tags": [
        {
          "key": "string"
        }
      ]
    }
  ],
  "continuationToken": "string"
}

application/xml

Schema

Schema

count int64

Total items in server

items object[]nullable
Items retrieved
Array [
id uuid
Collection id (GUID)
title stringnullable
Title of the collection
description stringnullable
A brief description of the collection
jobReference stringnullable
Internal field to track jobs associated to this collection
accessMode CollectionAccessMode
Possible values: [Everyone, MembersOnly]
tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
]
continuationToken stringnullable

A continuation token

Example (from schema)

<root>
  <count>0</count>
  <items>
    <id>3fa85f64-5717-4562-b3fc-2c963f66afa6</id>
    <title>string</title>
    <description>string</description>
    <jobReference>string</jobReference>
    <accessMode>Everyone</accessMode>
    <tags>
      <key>string</key>
    </tags>
  </items>
  <continuationToken>string</continuationToken>
</root>

text/plain

Schema

Schema

count int64

Total items in server

items object[]nullable
Items retrieved
Array [
id uuid
Collection id (GUID)
title stringnullable
Title of the collection
description stringnullable
A brief description of the collection
jobReference stringnullable
Internal field to track jobs associated to this collection
accessMode CollectionAccessMode
Possible values: [Everyone, MembersOnly]
tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
]
continuationToken stringnullable

A continuation token

Example (from schema)

{
  "count": 0,
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "title": "string",
      "description": "string",
      "jobReference": "string",
      "accessMode": "Everyone",
      "tags": [
        {
          "key": "string"
        }
      ]
    }
  ],
  "continuationToken": "string"
}

application/octet-stream

Schema

Schema

count int64

Total items in server

items object[]nullable
Items retrieved
Array [
id uuid
Collection id (GUID)
title stringnullable
Title of the collection
description stringnullable
A brief description of the collection
jobReference stringnullable
Internal field to track jobs associated to this collection
accessMode CollectionAccessMode
Possible values: [Everyone, MembersOnly]
tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
]
continuationToken stringnullable

A continuation token

Example (from schema)

{
  "count": 0,
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "title": "string",
      "description": "string",
      "jobReference": "string",
      "accessMode": "Everyone",
      "tags": [
        {
          "key": "string"
        }
      ]
    }
  ],
  "continuationToken": "string"
}

text/json

Schema

Schema

count int64

Total items in server

items object[]nullable
Items retrieved
Array [
id uuid
Collection id (GUID)
title stringnullable
Title of the collection
description stringnullable
A brief description of the collection
jobReference stringnullable
Internal field to track jobs associated to this collection
accessMode CollectionAccessMode
Possible values: [Everyone, MembersOnly]
tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
]
continuationToken stringnullable

A continuation token

Example (from schema)

{
  "count": 0,
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "title": "string",
      "description": "string",
      "jobReference": "string",
      "accessMode": "Everyone",
      "tags": [
        {
          "key": "string"
        }
      ]
    }
  ],
  "continuationToken": "string"
}

400

Bad Request

application/json;odata.metadata=minimal;odata.streaming=true

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=minimal;odata.streaming=false

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=minimal

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=full;odata.streaming=true

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=full;odata.streaming=false

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=full

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=none;odata.streaming=true

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=none;odata.streaming=false

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=none

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.streaming=true

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.streaming=false

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/xml

Schema

Schema

error stringnullable

Error message

Example (from schema)

<error>string</error>

text/plain

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/octet-stream

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

text/json

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

401

Unauthorized

application/json;odata.metadata=minimal;odata.streaming=true

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=minimal;odata.streaming=false

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=minimal

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=full;odata.streaming=true

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=full;odata.streaming=false

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=full

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=none;odata.streaming=true

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=none;odata.streaming=false

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=none

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.streaming=true

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.streaming=false

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/xml

Schema

Schema

error stringnullable

Error message

Example (from schema)

<error>string</error>

text/plain

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/octet-stream

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

text/json

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

500

Server Error

application/json;odata.metadata=minimal;odata.streaming=true

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=minimal;odata.streaming=false

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=minimal

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=full;odata.streaming=true

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=full;odata.streaming=false

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=full

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=none;odata.streaming=true

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=none;odata.streaming=false

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=none

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.streaming=true

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.streaming=false

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/xml

Schema

Schema

error stringnullable

Error message

Example (from schema)

<error>string</error>

text/plain

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/octet-stream

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

text/json

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

Loading...