Update a retrieval document

updateRetrievalDocument(projectReference: ID!, retrievalDocumentId: ID!, input: UpdateRetrievalDocumentInput!): RetrievalDocument!

Requires project.knowledge.write.

Arguments

ArgumentTypeRequiredDescription
projectReferenceID!YesProject UUID or slug.
retrievalDocumentIdID!Yes
inputUpdateRetrievalDocumentInput!Yes

Input fields

input

UpdateRetrievalDocumentInput

FieldTypeRequiredDescription
expectedRevisionString!YesThe revision you read. A changed record is a conflict; a missing record is not_found. Title, source, type and metadata are replaced, and the response includes the new revision.
titleString!Yes
sourceStringNoDefaults to an empty string.
typeStringNoDefaults to an empty string.
metadataJSONObjectNo

Response

Returns RetrievalDocument!. Open the type for its fields and nested types.

FieldTypeDescription
idID!
revisionString!Opaque revision: 64 lowercase hexadecimal characters. Send it as expectedRevision.
titleString!
sourceString!
typeString!
metadataJSONObject!
createdAtDateTime!
updatedAtDateTime!

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql
mutation UpdateRetrievalDocument($projectReference: ID!, $retrievalDocumentId: ID!, $input: UpdateRetrievalDocumentInput!) {
  updateRetrievalDocument(projectReference: $projectReference, retrievalDocumentId: $retrievalDocumentId, input: $input) {
    id
    createdAt
    updatedAt
    metadata
    revision
  }
}
json
{
  "projectReference": "00000000-0000-4000-8000-000000000001",
  "retrievalDocumentId": "00000000-0000-4000-8000-000000000001",
  "input": {
    "expectedRevision": "example",
    "title": "example"
  }
}