DataDoc

Sample shape for DataDoc.

Sample JSON

Copy, edit, paste. Server-set fields (id, created, tenantId, …) are omitted from the example — they’re populated by the server on response.

{
  "folderId": "<folder_id>",
  "name": "Example name",
  "context": [
    "<doc-context>"
  ],
  "restrictedTo": [
    "example"
  ],
  "aiAccess": false,
  "archived": false,
  "author": "example"
}

Fields

Field	Type	Required	Notes
`entity`	string • nullable	Server-set	Set by the server. Read-only on writes.
`folderId`	string	Optional
`name`	string	Required
`context`	array<`DocContext`>	Optional
`restrictedTo`	array<string>	Optional
`aiAccess`	boolean	Optional
`archived`	boolean	Optional
`author`	string	Optional
`tenantId`	string	Server-set	Set by the server. Read-only on writes.
`id`	string	Server-set	Set by the server. Read-only on writes.
`created`	string (date-time)	Server-set	Set by the server. Read-only on writes.
`createdBy`	string	Server-set	Set by the server. Read-only on writes.
`updated`	string (date-time)	Server-set	Set by the server. Read-only on writes.
`updatedBy`	string	Server-set	Set by the server. Read-only on writes.
`deleted`	boolean	Server-set	Set by the server. Read-only on writes.

Used by

Request body

POST /api/docs/doc
PUT /api/docs/doc/{docId}

Response body

GET /api/docs/doc/{docId}
GET /api/docs/folder/{folderId}/list
POST /api/docs/doc

CLI

ekso docs doc — see the command branches page for available verbs. Body for create / update verbs typically passed via --data @file.json matching the sample JSON above.

DataCrmContact

DataDocContent

Reference

Core

Items

Process

Fields

Constraints & Rules

People & Access

Time & Finance

Knowledge

Mail & Tickets

Operational

Settings

Sample JSON

Fields

Used by

Request body

Response body

CLI

​Sample JSON

​Fields

​Used by

​Request body

​Response body

​CLI

Sample JSON

Fields

Used by

Request body

Response body

CLI