DataWatch

Sample shape for DataWatch.

Sample JSON

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

{
  "owner": "<content-owner>",
  "ownerId": "<owner_id>",
  "watcher": "<watcher-type>",
  "watcherId": "<watcher_id>",
  "type": "<watch-type>"
}

Fields

Field	Type	Required	Notes
`entity`	string • nullable	Server-set	Set by the server. Read-only on writes.
`owner`	`ContentOwner`	Optional
`ownerId`	string	Required
`watcher`	`WatcherType`	Optional
`watcherId`	string	Required
`type`	`WatchType`	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/watch
PUT /api/watch/{id}

Response body

GET /api/watch/owner/{ownerId}
GET /api/watch/watcher/{watcherId}
GET /api/watch/{id}
POST /api/watch
PUT /api/watch/{id}

CLI

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

DataFilter

DataProcess

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