curl --request GET \
--url https://aodocs.altirnao.com/api/document/v2beta1/documents/{documentId}/states \
--header 'Authorization: Bearer <token>'{
"classId": "<string>",
"className": "<string>",
"domainName": "<string>",
"kind": "<string>",
"libraryId": "<string>",
"libraryName": "<string>",
"states": [
{
"applyActionToDocuments": "DO_NOTHING",
"checkOutSettings": {
"addValidatorToPermissions": true,
"applyPreviousVersionPermissions": true,
"draftActionPrefix": "<string>",
"permissions": [
{
"displayName": "<string>",
"kind": "<string>",
"role": "READER",
"thumbnailPictureUrl": "<string>",
"type": "ANYONE",
"value": "<string>",
"withLink": true
}
]
},
"classReadOnlyDocumentsNotCheckedOut": "DISABLED",
"createdTime": "2023-11-07T05:31:56Z",
"customActions": [
{
"event": "ON_STATE_ENTER_BEFORE_TRANSITION",
"id": "<string>",
"kind": "<string>",
"name": "<string>",
"params": {},
"scriptId": "<string>",
"scriptName": "<string>"
}
],
"description": "<string>",
"displayFlags": [
"HIDDEN_FROM_WORKFLOW_TASKS"
],
"draftDocuments": true,
"hiddenFields": [
{
"id": "<string>",
"name": "<string>"
}
],
"id": "<string>",
"kind": "<string>",
"lastModifiedTime": "2023-11-07T05:31:56Z",
"mandatoryFields": [
{
"id": "<string>",
"name": "<string>"
}
],
"name": "<string>",
"name_i18n": "<string>",
"notifications": {
"actionEmail": {
"customEmail": {
"bodyTemplate": "<string>",
"layout": "NO_LAYOUT",
"senderTemplate": "<string>",
"subjectTemplate": "<string>"
},
"templateEmail": {
"id": "<string>",
"name": "<string>"
}
},
"notificationEmail": {
"customEmail": {
"bodyTemplate": "<string>",
"layout": "NO_LAYOUT",
"senderTemplate": "<string>",
"subjectTemplate": "<string>"
},
"templateEmail": {
"id": "<string>",
"name": "<string>"
}
},
"notifyHumanActionPerformer": true,
"recipients": [
{
"classId": "<string>",
"className": "<string>",
"description": "<string>",
"displayName": "<string>",
"displayName_i18n": "<string>",
"thumbnailPictureUrl": "<string>",
"type": "USER",
"value": "<string>"
}
]
},
"permissions": [
{
"displayName": "<string>",
"kind": "<string>",
"role": "READER",
"thumbnailPictureUrl": "<string>",
"type": "ANYONE",
"value": "<string>",
"withLink": true
}
],
"readOnlyDocumentsNotCheckedOut": true,
"readOnlyFields": [
{
"id": "<string>",
"name": "<string>"
}
],
"resetDocumentPermissions": true,
"transitions": [
{
"createNewDocumentVersion": true,
"createdTime": "2023-11-07T05:31:56Z",
"discardCheckedOutDocument": true,
"elapsedTime": {
"amount": 123,
"unit": "MINUTE"
},
"fixedTime": "2023-11-07T05:31:56Z",
"humanAction": {
"actionId": "<string>",
"appliedName": "<string>",
"appliedName_i18n": "<string>",
"commentPlaceholderText": "<string>",
"commentPlaceholderText_i18n": "<string>",
"mandatoryComment": true,
"name": "<string>",
"name_i18n": "<string>",
"performer": {
"classId": "<string>",
"className": "<string>",
"description": "<string>",
"displayName": "<string>",
"displayName_i18n": "<string>",
"thumbnailPictureUrl": "<string>",
"type": "USER",
"value": "<string>"
},
"reminders": [
{
"audience": "PENDING",
"condition": {
"params": {},
"scriptId": "<string>",
"scriptName": "<string>"
},
"emailTemplateId": "<string>",
"id": "<string>",
"name": "<string>"
}
],
"validateByAll": true
},
"id": "<string>",
"kind": "<string>",
"lastModifiedTime": "2023-11-07T05:31:56Z",
"propertyData": {
"operator": "EQUAL_TO",
"personValue": {
"classId": "<string>",
"className": "<string>",
"description": "<string>",
"displayName": "<string>",
"displayName_i18n": "<string>",
"thumbnailPictureUrl": "<string>",
"type": "USER",
"value": "<string>"
},
"propertyId": "<string>",
"value": "<string>"
},
"propertyTime": "<string>",
"relativeTime": {
"after": true,
"amount": 123,
"propertyId": "<string>",
"unit": "MINUTE"
},
"targetStateId": "<string>",
"targetStateName": "<string>",
"targetStateName_i18n": "<string>",
"transitionType": "NORMAL"
}
]
}
],
"workflowId": "<string>",
"workflowName": "<string>"
}Lists the possible states for the document by the current user.
curl --request GET \
--url https://aodocs.altirnao.com/api/document/v2beta1/documents/{documentId}/states \
--header 'Authorization: Bearer <token>'{
"classId": "<string>",
"className": "<string>",
"domainName": "<string>",
"kind": "<string>",
"libraryId": "<string>",
"libraryName": "<string>",
"states": [
{
"applyActionToDocuments": "DO_NOTHING",
"checkOutSettings": {
"addValidatorToPermissions": true,
"applyPreviousVersionPermissions": true,
"draftActionPrefix": "<string>",
"permissions": [
{
"displayName": "<string>",
"kind": "<string>",
"role": "READER",
"thumbnailPictureUrl": "<string>",
"type": "ANYONE",
"value": "<string>",
"withLink": true
}
]
},
"classReadOnlyDocumentsNotCheckedOut": "DISABLED",
"createdTime": "2023-11-07T05:31:56Z",
"customActions": [
{
"event": "ON_STATE_ENTER_BEFORE_TRANSITION",
"id": "<string>",
"kind": "<string>",
"name": "<string>",
"params": {},
"scriptId": "<string>",
"scriptName": "<string>"
}
],
"description": "<string>",
"displayFlags": [
"HIDDEN_FROM_WORKFLOW_TASKS"
],
"draftDocuments": true,
"hiddenFields": [
{
"id": "<string>",
"name": "<string>"
}
],
"id": "<string>",
"kind": "<string>",
"lastModifiedTime": "2023-11-07T05:31:56Z",
"mandatoryFields": [
{
"id": "<string>",
"name": "<string>"
}
],
"name": "<string>",
"name_i18n": "<string>",
"notifications": {
"actionEmail": {
"customEmail": {
"bodyTemplate": "<string>",
"layout": "NO_LAYOUT",
"senderTemplate": "<string>",
"subjectTemplate": "<string>"
},
"templateEmail": {
"id": "<string>",
"name": "<string>"
}
},
"notificationEmail": {
"customEmail": {
"bodyTemplate": "<string>",
"layout": "NO_LAYOUT",
"senderTemplate": "<string>",
"subjectTemplate": "<string>"
},
"templateEmail": {
"id": "<string>",
"name": "<string>"
}
},
"notifyHumanActionPerformer": true,
"recipients": [
{
"classId": "<string>",
"className": "<string>",
"description": "<string>",
"displayName": "<string>",
"displayName_i18n": "<string>",
"thumbnailPictureUrl": "<string>",
"type": "USER",
"value": "<string>"
}
]
},
"permissions": [
{
"displayName": "<string>",
"kind": "<string>",
"role": "READER",
"thumbnailPictureUrl": "<string>",
"type": "ANYONE",
"value": "<string>",
"withLink": true
}
],
"readOnlyDocumentsNotCheckedOut": true,
"readOnlyFields": [
{
"id": "<string>",
"name": "<string>"
}
],
"resetDocumentPermissions": true,
"transitions": [
{
"createNewDocumentVersion": true,
"createdTime": "2023-11-07T05:31:56Z",
"discardCheckedOutDocument": true,
"elapsedTime": {
"amount": 123,
"unit": "MINUTE"
},
"fixedTime": "2023-11-07T05:31:56Z",
"humanAction": {
"actionId": "<string>",
"appliedName": "<string>",
"appliedName_i18n": "<string>",
"commentPlaceholderText": "<string>",
"commentPlaceholderText_i18n": "<string>",
"mandatoryComment": true,
"name": "<string>",
"name_i18n": "<string>",
"performer": {
"classId": "<string>",
"className": "<string>",
"description": "<string>",
"displayName": "<string>",
"displayName_i18n": "<string>",
"thumbnailPictureUrl": "<string>",
"type": "USER",
"value": "<string>"
},
"reminders": [
{
"audience": "PENDING",
"condition": {
"params": {},
"scriptId": "<string>",
"scriptName": "<string>"
},
"emailTemplateId": "<string>",
"id": "<string>",
"name": "<string>"
}
],
"validateByAll": true
},
"id": "<string>",
"kind": "<string>",
"lastModifiedTime": "2023-11-07T05:31:56Z",
"propertyData": {
"operator": "EQUAL_TO",
"personValue": {
"classId": "<string>",
"className": "<string>",
"description": "<string>",
"displayName": "<string>",
"displayName_i18n": "<string>",
"thumbnailPictureUrl": "<string>",
"type": "USER",
"value": "<string>"
},
"propertyId": "<string>",
"value": "<string>"
},
"propertyTime": "<string>",
"relativeTime": {
"after": true,
"amount": 123,
"propertyId": "<string>",
"unit": "MINUTE"
},
"targetStateId": "<string>",
"targetStateName": "<string>",
"targetStateName_i18n": "<string>",
"transitionType": "NORMAL"
}
]
}
],
"workflowId": "<string>",
"workflowName": "<string>"
}The access token received from the authorization server in the OAuth 2.0 flow.
The ID of the document