The following objects are used in multiple endpoints within the Document API. The response objects are also used in the endpoints for the CheckIn, Copy, Document Permissions, Move, Renditions, and Version APIs.
Response Body
| Element | Description | Type | Notes |
|---|---|---|---|
| sys_repository | Name of the repository where the document resides. | string | None |
| sys_id | Alphanumeric ID for the document. | string | None |
| sys_primaryType | The document type of the document. | string | Required in request bodies for document creation. |
| sys_title | The title of the document. | string | None |
| sys_name | The name of the document. | string | Can be up to 100 characters. |
| sys_path | The path to the document in the repository. | string | Computed from the sys_name of the document's ancestors. Cannot be used in all HXQL query contexts. |
| sys_parentId | Alphanumeric ID for the document's parent. | string | None |
| sys_parentPath | The path to the document's parent in the repository. | string | None |
| sys_version | The current version of the document. | integer | None |
| sys_versionSeriesId | Alphanumeric ID of the document from which a version was created. | string | None |
| sys_isCheckedIn | True/false indicator of whether the document is checked in. | Boolean | None |
| sys_isFolderish | True/false indicator of whether the documents contain the SysFolderish mixin. | Boolean | None |
| sys_isProxy | True/false indicator of whether the document is a proxy. | Boolean | None |
| sys_isTrashed | True/false indicator of whether the document is in the trash. | Boolean | None |
| sys_isVersion | True/false indicator of whether the document is a version. | Boolean | None |
| sys_isLatestVersion | True/false indicator of whether this is the latest version of the document. | Boolean | None |
| sysgov_hasLegalHold | True/false indicator of whether a legal hold has been placed on the document for retention purposes. | Boolean | When set to true, the document cannot be modified or deleted. |
| sysgov_isRecord | True/false indicator of whether the document has been marked as a record. | Boolean | A document marked as a record can still be modified or deleted if the document is not otherwise under retention. |
| sysgov_retainUntil | The date and time when the document's retention period expires. | date/time | The document cannot be modified or deleted until after the specified date and time are reached. |
| sys_mixinTypes | Restricted list of the document mixins. | array | Restrictions include the following:
|
| sys_lifecycleState | The lifecycle state of the document. | string | None |
| sys_pos | The position of the document within its parent. | integer | Value is NULL in unordered folders. |
| sys_acl | A pseudo-list giving access to ACLs, which need to be used with a suffix specifying which part of the ACL is accessed. | array | Available values are:
|
| creator | Name of the user who created the ACL. | string | None |
| permission | The permission assigned to members of the ACL. | string | None |
| granted | True/false indicator of whether the specified permission has been granted to the ACL members. | Boolean | None |
| user | List of elements applying to the current user within the ACL. | array | None |
| id | Alphanumeric ID for the current user within the ACL. | string | None |
| firstName | First name of the current user within the ACL. | string | None |
| lastName | Last name of the current user within the ACL. | string | None |
| Email address of the current user within the ACL. | string | None | |
| group | List of elements applying to the current group within the ACL. | array | None |
| id | Alphanumeric ID for the current group within the ACL. | string | None |
| name | Name of the current group within the ACL. | string | None |
| end | The date and time when the ACL's rules stop being applied. | date/time | None |
| begin | The date and time when the ACL's rules start being applied. | date/time | None |
| status | The current status of the application of the ACL's rules. | string | None |
| sys_changeToken | String bundle of two integer values for the system change token and the user change token. | string | The system change token is systematically incremented on each update to the document, while the user change token is incremented on demand when a client requests it. |
| sys_contributors | List of elements applying to the users who created or modified the document. | array | None |
| sys_created | The date and time when the document was created. | date/time | None |
| sys_creator | List of elements applying to the user who created the document. | array | None |
| sys_description | Description of the document. | string | None |
| sys_effectiveAcl | A pseudo-list giving access to ACLs and accounting for inheritance from the parents. | array | None |
| sys_fulltextBinary | The full text extracted from blobs of the current document. | string | None |
| sys_lastContributor | List of elements applying to the user who last modified the document. | array | None |
| sys_lockCreated | The date and time when the document was locked by a user. | date/time | None |
| sys_lockOwner | List of elements applying to the user who locked the document. | array | Only the user who locked the document or an admininstrator can remove the lock. |
| sys_modified | The date and time when the document was last modified. | date/time | None |
| sys_pathDepth | The number of folder levels deep into the repository the document is located. | integer | None |
| sys_secpol | List of elements applying to the default system security policies. | array | None |
| additionalProp1 | Placeholder example of a non-system property that can be added to supplement the system properties. | Defined by the user. | None |
Sample Response
{
"sys_repository": "string",
"sys_id": "string",
"sys_primaryType": "string",
"sys_title": "string",
"sys_name": "string",
"sys_path": "string",
"sys_parentId": "string",
"sys_parentPath": "string",
"sys_version": 0,
"sys_versionSeriesId": "string",
"sys_isCheckedIn": true,
"sys_isFolderish": true,
"sys_isProxy": true,
"sys_isTrashed": true,
"sys_isVersion": true,
"sys_isLatestVersion": true,
"sysgov_hasLegalHold": "boolean",
"sysgov_isRecord": "boolean",
"sysgov_retainUntil": "date",
"sys_mixinTypes": [
"string"
],
"sys_lifecycleState": "string",
"sys_pos": 0,
"sys_acl": [
{
"creator": "string",
"permission": "string",
"granted": true,
"user": {
"id": "string",
"firstName": "string",
"lastName": "string",
"email": "string"
},
"group": {
"id": "string",
"name": "string"
},
"end": "2022-03-10T16:15:50Z",
"begin": "2022-03-10T16:15:50Z",
"status": "PENDING"
}
],
"sys_effectiveAcl": [
{
"creator": "string",
"permission": "string",
"granted": true,
"user": {
"id": "string",
"firstName": "string",
"lastName": "string",
"email": "string"
},
"group": {
"id": "string",
"name": "string"
},
"end": "2022-03-10T16:15:50Z",
"begin": "2022-03-10T16:15:50Z",
"status": "PENDING"
}
],
"sys_effectivePermissions": [
"string"
],
"sys_fulltextBinary": "string",
"additionalProp1": {}
}