Documents Plugin

Update document metadata by ID.

PUT

http://localhost:3000/api/plugins/docs/documents/{id}

curl -X PUT 'http://localhost:3000/api/plugins/docs/documents/string' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "tenant": {},
  "tenantId": "string",
  "organization": {},
  "organizationId": "string",
  "sentTo": "string",
  "name": "string",
  "icon": "string",
  "color": "string",
  "description": "string",
  "visibility": "ORGANIZATION",
  "categoryIds": [
    "string"
  ],
  "tagIds": [
    "string"
  ],
  "tags": [
    "string"
  ],
  "mentionEmployeeIds": [
    "string"
  ],
  "searchable": true,
  "isLocked": true,
  "summary": "string"
}'

const body = `{
  "tenant": {},
  "tenantId": "string",
  "organization": {},
  "organizationId": "string",
  "sentTo": "string",
  "name": "string",
  "icon": "string",
  "color": "string",
  "description": "string",
  "visibility": "ORGANIZATION",
  "categoryIds": [
    "string"
  ],
  "tagIds": [
    "string"
  ],
  "tags": [
    "string"
  ],
  "mentionEmployeeIds": [
    "string"
  ],
  "searchable": true,
  "isLocked": true,
  "summary": "string"
}`;

const response = await fetch('http://localhost:3000/api/plugins/docs/documents/string', {
  method: 'PUT',
  headers: {
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "tenant": {},
  "tenantId": "string",
  "organization": {},
  "organizationId": "string",
  "sentTo": "string",
  "name": "string",
  "icon": "string",
  "color": "string",
  "description": "string",
  "visibility": "ORGANIZATION",
  "categoryIds": [
    "string"
  ],
  "tagIds": [
    "string"
  ],
  "tags": [
    "string"
  ],
  "mentionEmployeeIds": [
    "string"
  ],
  "searchable": true,
  "isLocked": true,
  "summary": "string"
}'''

response = requests.put(
    'http://localhost:3000/api/plugins/docs/documents/string',
    data=body.encode('utf-8'),
    headers={
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "tenant": {},
  "tenantId": "string",
  "organization": {},
  "organizationId": "string",
  "sentTo": "string",
  "name": "string",
  "icon": "string",
  "color": "string",
  "description": "string",
  "visibility": "ORGANIZATION",
  "categoryIds": [
    "string"
  ],
  "tagIds": [
    "string"
  ],
  "tags": [
    "string"
  ],
  "mentionEmployeeIds": [
    "string"
  ],
  "searchable": true,
  "isLocked": true,
  "summary": "string"
}

200

{
  "deletedAt": "2018-11-21T06:20:32.232Z",
  "createdAt": "2018-11-21T06:20:32.232Z",
  "updatedAt": "2018-11-21T06:20:32.232Z",
  "id": "string",
  "isActive": true,
  "isArchived": false,
  "archivedAt": "2018-11-21T06:20:32.232Z",
  "tenantId": "string",
  "organizationId": "string",
  "kind": "FOLDER",
  "index": 0,
  "name": "string",
  "icon": "string",
  "color": "string",
  "description": "string",
  "contentJson": {},
  "contentHtml": "string",
  "contentBinary": "<binary>",
  "isLocked": true,
  "storageProvider": "LOCAL",
  "storageKey": "string",
  "thumbKey": "string",
  "mimeType": "string",
  "fileSize": 0,
  "sha256": "string",
  "originalFilename": "string",
  "version": 0,
  "extractedText": "string",
  "extractedTextEdited": true,
  "summary": "string",
  "status": "UPLOADED",
  "statusMessage": "string",
  "source": "UPLOAD",
  "knowledgeStatus": "NONE",
  "aiConfidence": 0,
  "searchable": true,
  "reviewStatus": "NONE",
  "reviewReason": "extraction-failed",
  "reviewedAt": "2024-01-15T09:30:00Z",
  "visibility": "ORGANIZATION",
  "externalSource": "string",
  "externalId": "string",
  "metadata": {},
  "parentId": "string",
  "reviewedById": "string"
}

Body

application/json

tenantobject

tenantIdstring

organizationobject

organizationIdstring

sentTostring

namestring

iconstring

colorstring

descriptionstring

visibilitystringORGANIZATIONPRIVATE

categoryIdsArray<string>

tagIdsArray<string>

tagsArray<string>

mentionEmployeeIdsArray<string>

searchableboolean

isLockedboolean

summarystring

Parameters

idstringrequiredpath

Response

200OKDocument

Document updated successfully.

Response fields application/json

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

kindstringFOLDERPAGEFILErequired

indexnumberrequired

Sibling sort order within the parent

namestringrequired

Display name / page title

iconstring

colorstring

descriptionstring

contentJsonobject

contentHtmlstring

contentBinarystring<binary>

isLockedbooleanrequired

storageProviderstringLOCALS3WASABICLOUDINARYDIGITALOCEAN

storageKeystring

thumbKeystring

mimeTypestring

fileSizenumber

sha256string

originalFilenamestring

versionnumberrequired

extractedTextstring

extractedTextEditedbooleanrequired

summarystring

statusstringUPLOADEDPROCESSINGREADYFAILEDrequired

statusMessagestring

sourcestringUPLOADEDITORCHATEMAILINTEGRATIONSYSTEMIMPORTrequired

knowledgeStatusstringNONEQUEUEDINDEXINGINDEXEDFAILEDEXCLUDEDrequired

aiConfidencenumber

searchablebooleanrequired

reviewStatusstringNONEPENDINGAPPROVEDREJECTEDrequired

reviewReasonstringextraction-failedlow-confidenceai-generatedmanual

reviewedAtstring<date-time>

visibilitystringORGANIZATIONPRIVATErequired

externalSourcestring

externalIdstring

metadataobject

parentIdstring

reviewedByIdstring

404Not Found

Document not found.

Stack Overflow Website Demo