Saltar al contenido principal

Upsert collection

PUT 

/api/collections/:collectionId

Creates a new collection or updates an existing one.

Request

Path Parameters

    collectionId uuidrequired

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

Success

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