Upsert collection

PUT 
/api/collections/:collectionId

Creates a new collection or updates an existing one.

Request

Path Parameters

collectionId uuidrequired

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

Body

id uuid
title stringnullable
description stringnullable
accessMode CollectionAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
tags object[]nullable
Array [
key stringnullable
value nullable
]
properties objectnullable

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

Body

id uuid
title stringnullable
description stringnullable
accessMode CollectionAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
tags object[]nullable
Array [
key stringnullable
value nullable
]
properties objectnullable

application/json;odata.metadata=minimal

Body

id uuid
title stringnullable
description stringnullable
accessMode CollectionAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
tags object[]nullable
Array [
key stringnullable
value nullable
]
properties objectnullable

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

Body

id uuid
title stringnullable
description stringnullable
accessMode CollectionAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
tags object[]nullable
Array [
key stringnullable
value nullable
]
properties objectnullable

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

Body

id uuid
title stringnullable
description stringnullable
accessMode CollectionAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
tags object[]nullable
Array [
key stringnullable
value nullable
]
properties objectnullable

application/json;odata.metadata=full

Body

id uuid
title stringnullable
description stringnullable
accessMode CollectionAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
tags object[]nullable
Array [
key stringnullable
value nullable
]
properties objectnullable

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

Body

id uuid
title stringnullable
description stringnullable
accessMode CollectionAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
tags object[]nullable
Array [
key stringnullable
value nullable
]
properties objectnullable

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

Body

id uuid
title stringnullable
description stringnullable
accessMode CollectionAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
tags object[]nullable
Array [
key stringnullable
value nullable
]
properties objectnullable

application/json;odata.metadata=none

Body

id uuid
title stringnullable
description stringnullable
accessMode CollectionAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
tags object[]nullable
Array [
key stringnullable
value nullable
]
properties objectnullable

application/json;odata.streaming=true

Body

id uuid
title stringnullable
description stringnullable
accessMode CollectionAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
tags object[]nullable
Array [
key stringnullable
value nullable
]
properties objectnullable

application/json;odata.streaming=false

Body

id uuid
title stringnullable
description stringnullable
accessMode CollectionAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
tags object[]nullable
Array [
key stringnullable
value nullable
]
properties objectnullable

application/json

Body

id uuid
title stringnullable
description stringnullable
accessMode CollectionAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
tags object[]nullable
Array [
key stringnullable
value nullable
]
properties objectnullable

application/xml

Body

id uuid
title stringnullable
description stringnullable
accessMode CollectionAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
tags object[]nullable
Array [
key stringnullable
value nullable
]
properties objectnullable

text/plain

Body

id uuid
title stringnullable
description stringnullable
accessMode CollectionAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
tags object[]nullable
Array [
key stringnullable
value nullable
]
properties objectnullable

text/json

Body

id uuid
title stringnullable
description stringnullable
accessMode CollectionAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
tags object[]nullable
Array [
key stringnullable
value nullable
]
properties objectnullable

application/*+json

Body

id uuid
title stringnullable
description stringnullable
accessMode CollectionAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
tags object[]nullable
Array [
key stringnullable
value nullable
]
properties objectnullable

Responses

200

Success

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

Schema

Schema

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]

members object[]nullable
Collection members
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
properties objectnullable

Collection properties

documentCount int64
documentsUsedSpace int64
vectorIndexCount int64
vectorIndexUsedSpace int64
syntacticIndexCount int64
syntacticIndexSpace int64

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "string",
  "description": "string",
  "jobReference": "string",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "Reader"
    }
  ],
  "tags": [
    {
      "key": "string"
    }
  ],
  "properties": {},
  "documentCount": 0,
  "documentsUsedSpace": 0,
  "vectorIndexCount": 0,
  "vectorIndexUsedSpace": 0,
  "syntacticIndexCount": 0,
  "syntacticIndexSpace": 0
}

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

Schema

Schema

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]

members object[]nullable
Collection members
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
properties objectnullable

Collection properties

documentCount int64
documentsUsedSpace int64
vectorIndexCount int64
vectorIndexUsedSpace int64
syntacticIndexCount int64
syntacticIndexSpace int64

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "string",
  "description": "string",
  "jobReference": "string",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "Reader"
    }
  ],
  "tags": [
    {
      "key": "string"
    }
  ],
  "properties": {},
  "documentCount": 0,
  "documentsUsedSpace": 0,
  "vectorIndexCount": 0,
  "vectorIndexUsedSpace": 0,
  "syntacticIndexCount": 0,
  "syntacticIndexSpace": 0
}

application/json;odata.metadata=minimal

Schema

Schema

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]

members object[]nullable
Collection members
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
properties objectnullable

Collection properties

documentCount int64
documentsUsedSpace int64
vectorIndexCount int64
vectorIndexUsedSpace int64
syntacticIndexCount int64
syntacticIndexSpace int64

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "string",
  "description": "string",
  "jobReference": "string",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "Reader"
    }
  ],
  "tags": [
    {
      "key": "string"
    }
  ],
  "properties": {},
  "documentCount": 0,
  "documentsUsedSpace": 0,
  "vectorIndexCount": 0,
  "vectorIndexUsedSpace": 0,
  "syntacticIndexCount": 0,
  "syntacticIndexSpace": 0
}

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

Schema

Schema

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]

members object[]nullable
Collection members
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
properties objectnullable

Collection properties

documentCount int64
documentsUsedSpace int64
vectorIndexCount int64
vectorIndexUsedSpace int64
syntacticIndexCount int64
syntacticIndexSpace int64

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "string",
  "description": "string",
  "jobReference": "string",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "Reader"
    }
  ],
  "tags": [
    {
      "key": "string"
    }
  ],
  "properties": {},
  "documentCount": 0,
  "documentsUsedSpace": 0,
  "vectorIndexCount": 0,
  "vectorIndexUsedSpace": 0,
  "syntacticIndexCount": 0,
  "syntacticIndexSpace": 0
}

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

Schema

Schema

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]

members object[]nullable
Collection members
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
properties objectnullable

Collection properties

documentCount int64
documentsUsedSpace int64
vectorIndexCount int64
vectorIndexUsedSpace int64
syntacticIndexCount int64
syntacticIndexSpace int64

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "string",
  "description": "string",
  "jobReference": "string",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "Reader"
    }
  ],
  "tags": [
    {
      "key": "string"
    }
  ],
  "properties": {},
  "documentCount": 0,
  "documentsUsedSpace": 0,
  "vectorIndexCount": 0,
  "vectorIndexUsedSpace": 0,
  "syntacticIndexCount": 0,
  "syntacticIndexSpace": 0
}

application/json;odata.metadata=full

Schema

Schema

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]

members object[]nullable
Collection members
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
properties objectnullable

Collection properties

documentCount int64
documentsUsedSpace int64
vectorIndexCount int64
vectorIndexUsedSpace int64
syntacticIndexCount int64
syntacticIndexSpace int64

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "string",
  "description": "string",
  "jobReference": "string",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "Reader"
    }
  ],
  "tags": [
    {
      "key": "string"
    }
  ],
  "properties": {},
  "documentCount": 0,
  "documentsUsedSpace": 0,
  "vectorIndexCount": 0,
  "vectorIndexUsedSpace": 0,
  "syntacticIndexCount": 0,
  "syntacticIndexSpace": 0
}

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

Schema

Schema

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]

members object[]nullable
Collection members
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
properties objectnullable

Collection properties

documentCount int64
documentsUsedSpace int64
vectorIndexCount int64
vectorIndexUsedSpace int64
syntacticIndexCount int64
syntacticIndexSpace int64

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "string",
  "description": "string",
  "jobReference": "string",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "Reader"
    }
  ],
  "tags": [
    {
      "key": "string"
    }
  ],
  "properties": {},
  "documentCount": 0,
  "documentsUsedSpace": 0,
  "vectorIndexCount": 0,
  "vectorIndexUsedSpace": 0,
  "syntacticIndexCount": 0,
  "syntacticIndexSpace": 0
}

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

Schema

Schema

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]

members object[]nullable
Collection members
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
properties objectnullable

Collection properties

documentCount int64
documentsUsedSpace int64
vectorIndexCount int64
vectorIndexUsedSpace int64
syntacticIndexCount int64
syntacticIndexSpace int64

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "string",
  "description": "string",
  "jobReference": "string",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "Reader"
    }
  ],
  "tags": [
    {
      "key": "string"
    }
  ],
  "properties": {},
  "documentCount": 0,
  "documentsUsedSpace": 0,
  "vectorIndexCount": 0,
  "vectorIndexUsedSpace": 0,
  "syntacticIndexCount": 0,
  "syntacticIndexSpace": 0
}

application/json;odata.metadata=none

Schema

Schema

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]

members object[]nullable
Collection members
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
properties objectnullable

Collection properties

documentCount int64
documentsUsedSpace int64
vectorIndexCount int64
vectorIndexUsedSpace int64
syntacticIndexCount int64
syntacticIndexSpace int64

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "string",
  "description": "string",
  "jobReference": "string",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "Reader"
    }
  ],
  "tags": [
    {
      "key": "string"
    }
  ],
  "properties": {},
  "documentCount": 0,
  "documentsUsedSpace": 0,
  "vectorIndexCount": 0,
  "vectorIndexUsedSpace": 0,
  "syntacticIndexCount": 0,
  "syntacticIndexSpace": 0
}

application/json;odata.streaming=true

Schema

Schema

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]

members object[]nullable
Collection members
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
properties objectnullable

Collection properties

documentCount int64
documentsUsedSpace int64
vectorIndexCount int64
vectorIndexUsedSpace int64
syntacticIndexCount int64
syntacticIndexSpace int64

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "string",
  "description": "string",
  "jobReference": "string",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "Reader"
    }
  ],
  "tags": [
    {
      "key": "string"
    }
  ],
  "properties": {},
  "documentCount": 0,
  "documentsUsedSpace": 0,
  "vectorIndexCount": 0,
  "vectorIndexUsedSpace": 0,
  "syntacticIndexCount": 0,
  "syntacticIndexSpace": 0
}

application/json;odata.streaming=false

Schema

Schema

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]

members object[]nullable
Collection members
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
properties objectnullable

Collection properties

documentCount int64
documentsUsedSpace int64
vectorIndexCount int64
vectorIndexUsedSpace int64
syntacticIndexCount int64
syntacticIndexSpace int64

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "string",
  "description": "string",
  "jobReference": "string",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "Reader"
    }
  ],
  "tags": [
    {
      "key": "string"
    }
  ],
  "properties": {},
  "documentCount": 0,
  "documentsUsedSpace": 0,
  "vectorIndexCount": 0,
  "vectorIndexUsedSpace": 0,
  "syntacticIndexCount": 0,
  "syntacticIndexSpace": 0
}

application/json

Schema

Schema

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]

members object[]nullable
Collection members
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
properties objectnullable

Collection properties

documentCount int64
documentsUsedSpace int64
vectorIndexCount int64
vectorIndexUsedSpace int64
syntacticIndexCount int64
syntacticIndexSpace int64

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "string",
  "description": "string",
  "jobReference": "string",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "Reader"
    }
  ],
  "tags": [
    {
      "key": "string"
    }
  ],
  "properties": {},
  "documentCount": 0,
  "documentsUsedSpace": 0,
  "vectorIndexCount": 0,
  "vectorIndexUsedSpace": 0,
  "syntacticIndexCount": 0,
  "syntacticIndexSpace": 0
}

application/xml

Schema

Schema

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]

members object[]nullable
Collection members
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
properties objectnullable

Collection properties

documentCount int64
documentsUsedSpace int64
vectorIndexCount int64
vectorIndexUsedSpace int64
syntacticIndexCount int64
syntacticIndexSpace int64

Example (from schema)

<root>
  <id>3fa85f64-5717-4562-b3fc-2c963f66afa6</id>
  <title>string</title>
  <description>string</description>
  <jobReference>string</jobReference>
  <accessMode>Everyone</accessMode>
  <members>
    <identity>string</identity>
    <privileges>Reader</privileges>
  </members>
  <tags>
    <key>string</key>
  </tags>
  <properties/>
  <documentCount>0</documentCount>
  <documentsUsedSpace>0</documentsUsedSpace>
  <vectorIndexCount>0</vectorIndexCount>
  <vectorIndexUsedSpace>0</vectorIndexUsedSpace>
  <syntacticIndexCount>0</syntacticIndexCount>
  <syntacticIndexSpace>0</syntacticIndexSpace>
</root>

text/plain

Schema

Schema

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]

members object[]nullable
Collection members
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
properties objectnullable

Collection properties

documentCount int64
documentsUsedSpace int64
vectorIndexCount int64
vectorIndexUsedSpace int64
syntacticIndexCount int64
syntacticIndexSpace int64

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "string",
  "description": "string",
  "jobReference": "string",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "Reader"
    }
  ],
  "tags": [
    {
      "key": "string"
    }
  ],
  "properties": {},
  "documentCount": 0,
  "documentsUsedSpace": 0,
  "vectorIndexCount": 0,
  "vectorIndexUsedSpace": 0,
  "syntacticIndexCount": 0,
  "syntacticIndexSpace": 0
}

application/octet-stream

Schema

Schema

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]

members object[]nullable
Collection members
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
properties objectnullable

Collection properties

documentCount int64
documentsUsedSpace int64
vectorIndexCount int64
vectorIndexUsedSpace int64
syntacticIndexCount int64
syntacticIndexSpace int64

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "string",
  "description": "string",
  "jobReference": "string",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "Reader"
    }
  ],
  "tags": [
    {
      "key": "string"
    }
  ],
  "properties": {},
  "documentCount": 0,
  "documentsUsedSpace": 0,
  "vectorIndexCount": 0,
  "vectorIndexUsedSpace": 0,
  "syntacticIndexCount": 0,
  "syntacticIndexSpace": 0
}

text/json

Schema

Schema

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]

members object[]nullable
Collection members
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
properties objectnullable

Collection properties

documentCount int64
documentsUsedSpace int64
vectorIndexCount int64
vectorIndexUsedSpace int64
syntacticIndexCount int64
syntacticIndexSpace int64

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "string",
  "description": "string",
  "jobReference": "string",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "Reader"
    }
  ],
  "tags": [
    {
      "key": "string"
    }
  ],
  "properties": {},
  "documentCount": 0,
  "documentsUsedSpace": 0,
  "vectorIndexCount": 0,
  "vectorIndexUsedSpace": 0,
  "syntacticIndexCount": 0,
  "syntacticIndexSpace": 0
}

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...