Skip to main content
GET
/
document
/
v2beta1
/
documents
/
{documentId}
/
transitions
cURL
curl --request GET \
  --url https://aodocs.altirnao.com/api/document/v2beta1/documents/{documentId}/transitions \
  --header 'Authorization: Bearer <token>'
{
  "classId": "<string>",
  "className": "<string>",
  "domainName": "<string>",
  "forcedTransitions": [
    {
      "createNewDocumentVersion": true,
      "createdTime": "2023-11-07T05:31:56Z",
      "discardCheckedOutDocument": true,
      "elapsedTime": {
        "amount": 123,
        "unit": "MINUTE"
      },
      "fieldsUsedAsValidators": [
        {
          "canEdit": true,
          "description": "<string>",
          "description_i18n": "<string>",
          "hidden": true,
          "id": "<string>",
          "kind": "<string>",
          "mandatory": true,
          "multiple": true,
          "name": "<string>",
          "name_i18n": "<string>",
          "rank": 123,
          "readOnly": true,
          "system": true,
          "type": "STRING",
          "values": [
            "<string>"
          ]
        }
      ],
      "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",
      "validators": [
        {
          "comment": "<string>",
          "date": "2023-11-07T05:31:56Z",
          "user": {
            "email": "<string>",
            "kind": "<string>",
            "name": "<string>",
            "thumbnailPictureUrl": "<string>"
          },
          "validated": true
        }
      ]
    }
  ],
  "kind": "<string>",
  "libraryId": "<string>",
  "libraryName": "<string>",
  "transitions": [
    {
      "createNewDocumentVersion": true,
      "createdTime": "2023-11-07T05:31:56Z",
      "discardCheckedOutDocument": true,
      "elapsedTime": {
        "amount": 123,
        "unit": "MINUTE"
      },
      "fieldsUsedAsValidators": [
        {
          "canEdit": true,
          "description": "<string>",
          "description_i18n": "<string>",
          "hidden": true,
          "id": "<string>",
          "kind": "<string>",
          "mandatory": true,
          "multiple": true,
          "name": "<string>",
          "name_i18n": "<string>",
          "rank": 123,
          "readOnly": true,
          "system": true,
          "type": "STRING",
          "values": [
            "<string>"
          ]
        }
      ],
      "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",
      "validators": [
        {
          "comment": "<string>",
          "date": "2023-11-07T05:31:56Z",
          "user": {
            "email": "<string>",
            "kind": "<string>",
            "name": "<string>",
            "thumbnailPictureUrl": "<string>"
          },
          "validated": true
        }
      ]
    }
  ],
  "workflowId": "<string>",
  "workflowName": "<string>"
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

documentId
string
required

The ID of the document

Query Parameters

domain
string

The G Suite domain

securityCode
string

The security code

Response

200 - application/json

A ApiDocumentTransitionList response

classId
string
className
string
domainName
string
forcedTransitions
object[]
kind
string
libraryId
string
libraryName
string
transitions
object[]
workflowId
string
workflowName
string