Download OpenAPI specification:Download
Application API uses HTTP Basic Authentication. Authorization header must be constructed from login and password of app-only users (credentials of Codejig users will be rejected).
Resources that do not have any permission restrictions are accessible without authorization HTTP header.
Returns a list of instances of the specified type. Request body controls pagination, ordering and filtering.
Returned instances will not contain collection fields. To get full object refer to GET /api/entity/{typeReference}/{entityId}.
By default, instances are sorted by an identifier in descending order. You can sort on any field that is not a collection. Nulls are considered to be greater than non-null values. References are sorted by the default string view of their type.
Pagination is cursor-based. To get a next page supply the same request body, but set value to a lastValue field as the last element from a previous page. If the lastValue field is empty but a size field is not, the first page of results will be retrieved. If both are empty, all instances of the specified type will be returned.
Filters field expects logical expression written in Reverse Polish notation. Examples of such expressions can be found under the payload examples.
Read permission for the specified type will be checked. Additionally, we will check View deleted permission if you set loadDeleted to true.
| typeReference required | string An identifier or a system name of the data type |
Pagination, ordering and filtering
| order | object Sorting parameters |
| filters | Array of objects or objects A logical expression that we will use to filter result collection. It has to be expressed in Reverse Polish notation. |
| loadDeleted | boolean Default: false If deleted instances should be returned |
| size | integer <int32> Nullable Default: null Size of the page. If not specified, all instances will be returned. |
| lastValue | object The last value from the previous page. Used for cursor-based pagination |
A page of instances
The request lacks valid authorization header or supplied credentials are invalid
Supplied credentials are valid but the access is forbidden
No such type
Create permission for the type will be checked.
| typeReference required | string An identifier or a system name of the data type |
Instance
| metaObject | object (MetaObject) |
| serialNumber | string |
Entity
Instance from the request body does not pass validation logic
The request lacks valid authorization header or supplied credentials are invalid
Supplied credentials are valid but the access is forbidden
No such type
Alias for GET /api/entity/{typeReference}/
| typeReference required | string An identifier or a system name of the data type |
Pagination, ordering and filtering
| order | object Sorting parameters |
| filters | Array of objects or objects A logical expression that we will use to filter result collection. It has to be expressed in Reverse Polish notation. |
| loadDeleted | boolean Default: false If deleted instances should be returned |
| size | integer <int32> Nullable Default: null Size of the page. If not specified, all instances will be returned. |
| lastValue | object The last value from the previous page. Used for cursor-based pagination |
A page of instances
The request lacks valid authorization header or supplied credentials are invalid
Supplied credentials are valid but the access is forbidden
No such type
Get top-level instances and folders of the specified type
| typeReference required | string An identifier or a system name of the data type |
| wholeTree | boolean If the response should contain all instances on all levels of the tree |
Instances and folders
The request lacks valid authorization header or supplied credentials are invalid
Supplied credentials are valid but the access is forbidden
No such type
Read permission for this instance will be checked. Additionally if the instance is deleted we will check View deleted permission (or View history if the instance is snapshot from history) before Read.
| typeReference required | string An identifier or a system name of the data type |
| instanceId required | string An identifier of the instance |
Entity
The request lacks valid authorization header or supplied credentials are invalid
Supplied credentials are valid but the access is forbidden
No such type or instance
Update permission for this instance will be checked. Instance must be active, otherwise response will be 403.
| typeReference required | string An identifier or a system name of the data type |
| instanceId required | string An identifier of the instance |
Instance
| metaObject | object (MetaObject) |
| serialNumber | string |
Entity
Instance from the request body does not pass validation logic
The request lacks valid authorization header or supplied credentials are invalid
Supplied credentials are valid but the access is forbidden
No such type or instance
Update permission for this instance will be checked. Instance must be active, otherwise response will be 403.
| typeReference required | string An identifier or a system name of the data type |
| instanceId required | string An identifier of the instance |
Instance
| metaObject | object (MetaObject) |
| serialNumber | string |
Entity
Instance from the request body does not pass validation logic
The request lacks valid authorization header or supplied credentials are invalid
Supplied credentials are valid but the access is forbidden
No such type or instance
Delete permission for this instance will be checked. Instance must be active, otherwise response will be 403.
| typeReference required | string An identifier or a system name of the data type |
| instanceId required | string An identifier of the instance |
Entity
The request lacks valid authorization header or supplied credentials are invalid
Supplied credentials are valid but the access is forbidden
No such type or instance
Get direct children (instances and folders) of the specified instance
| typeReference required | string An identifier or a system name of the data type |
| instanceId required | string An identifier of the instance |
Instances and folders
The request lacks valid authorization header or supplied credentials are invalid
Supplied credentials are valid but the access is forbidden
No such type or instance
Post permission for this document will be checked.
| typeReference required | string An identifier or a system name of the data type |
| instanceId required | string An identifier of the instance |
Entity
The request lacks valid authorization header or supplied credentials are invalid
Supplied credentials are valid but the access is forbidden
No such type or instance
Unpost permission for this document will be checked.
| typeReference required | string An identifier or a system name of the data type |
| instanceId required | string An identifier of the instance |
Entity
The request lacks valid authorization header or supplied credentials are invalid
Supplied credentials are valid but the access is forbidden
No such type or instance
Get journal records for a document. Returns records grouped by their type.
View posted journal records permission for this document will be checked.
| typeReference required | string An identifier or a system name of the data type |
| instanceId required | string An identifier of the instance |
Journal records
The request lacks valid authorization header or supplied credentials are invalid
Supplied credentials are valid but the access is forbidden
No such type or instance