Saltar al contenido principal

Get collection

GET 

/api/collections/:collectionIdOrPersonalIdentityName

Gets a specific collection by its id. If you want to retrieve a personal collection use the user identityName

Request

Path Parameters

    collectionIdOrPersonalIdentityName stringrequired

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