Documents Plugin

Create a document category.

POST

http://localhost:3000/api/plugins/docs/categories

curl -X POST 'http://localhost:3000/api/plugins/docs/categories' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "tenant": {},
  "tenantId": "string",
  "organization": {},
  "organizationId": "string",
  "sentTo": "string",
  "name": "string",
  "slug": "string",
  "color": "string",
  "icon": "string",
  "description": "string"
}'

const body = `{
  "tenant": {},
  "tenantId": "string",
  "organization": {},
  "organizationId": "string",
  "sentTo": "string",
  "name": "string",
  "slug": "string",
  "color": "string",
  "icon": "string",
  "description": "string"
}`;

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

const data = await response.text();

import requests

body = '''{
  "tenant": {},
  "tenantId": "string",
  "organization": {},
  "organizationId": "string",
  "sentTo": "string",
  "name": "string",
  "slug": "string",
  "color": "string",
  "icon": "string",
  "description": "string"
}'''

response = requests.post(
    'http://localhost:3000/api/plugins/docs/categories',
    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",
  "slug": "string",
  "color": "string",
  "icon": "string",
  "description": "string"
}

201

{
  "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",
  "name": "string",
  "slug": "string",
  "color": "string",
  "icon": "string",
  "description": "string",
  "isSystem": true
}

Body

application/json

tenantobject

tenantIdstring

organizationobjectrequired

organizationIdstringrequired

sentTostring

namestringrequired

slugstring

colorstring

iconstring

descriptionstring

Response

201CreatedDocumentCategory

Category created 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

namestringrequired

slugstringrequired

colorstring

iconstring

descriptionstring

isSystembooleanrequired

409Conflict

A category with this name already exists.

Stack Overflow Website Demo