Documents Plugin

Share a PRIVATE document with an employee or a team.

POST

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

curl -X POST 'http://localhost:3000/api/plugins/docs/documents/string/shares' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "employeeId": "string",
  "teamId": "string",
  "access": "VIEW"
}'

const body = `{
  "employeeId": "string",
  "teamId": "string",
  "access": "VIEW"
}`;

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

const data = await response.text();

import requests

body = '''{
  "employeeId": "string",
  "teamId": "string",
  "access": "VIEW"
}'''

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

Request Body

{
  "employeeId": "string",
  "teamId": "string",
  "access": "VIEW"
}

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",
  "access": "VIEW",
  "documentId": "string",
  "employeeId": "string",
  "teamId": "string"
}

Body

application/json

employeeIdstring

teamIdstring

accessstringVIEWCOMMENTEDITrequired

Parameters

idstringrequiredpath

Response

201CreatedDocumentShare

Share 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

accessstringVIEWCOMMENTEDITrequired

documentIdstringrequired

employeeIdstring

teamIdstring

400Bad Request

Both or neither of employeeId/teamId supplied.

409Conflict

Document is not PRIVATE, or the share already exists.

Stack Overflow Website Demo