Documents Plugin

Apply a bulk action to a set of documents.

POST

http://localhost:3000/api/plugins/docs/documents/bulk

curl -X POST 'http://localhost:3000/api/plugins/docs/documents/bulk' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "ids": [
    "string"
  ],
  "action": "ARCHIVE",
  "categoryIds": [
    "string"
  ],
  "tagIds": [
    "string"
  ],
  "parentId": "string",
  "reason": "string"
}'

const body = `{
  "ids": [
    "string"
  ],
  "action": "ARCHIVE",
  "categoryIds": [
    "string"
  ],
  "tagIds": [
    "string"
  ],
  "parentId": "string",
  "reason": "string"
}`;

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

const data = await response.text();

import requests

body = '''{
  "ids": [
    "string"
  ],
  "action": "ARCHIVE",
  "categoryIds": [
    "string"
  ],
  "tagIds": [
    "string"
  ],
  "parentId": "string",
  "reason": "string"
}'''

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

Request Body

{
  "ids": [
    "string"
  ],
  "action": "ARCHIVE",
  "categoryIds": [
    "string"
  ],
  "tagIds": [
    "string"
  ],
  "parentId": "string",
  "reason": "string"
}

Body

application/json

idsArray<string>required

Target document ids (≤200)

actionstringARCHIVEUNARCHIVESET_CATEGORIESADD_TAGSREMOVE_TAGSKNOWLEDGE_IMPORTKNOWLEDGE_EXCLUDEMOVEDELETEREVIEW_APPROVEREVIEW_REJECTrequired

categoryIdsArray<string>

tagIdsArray<string>

parentIdstring | null

reasonstring

Response

200OK

Per-id bulk results returned.

Stack Overflow Website Demo