Skip to main content
PATCH
/
workflow
/
v2beta1
/
workflows
/
{workflowId}
/
states
/
{stateId}
/
transitions
/
{transitionId}
cURL
curl --request PATCH \
  --url https://aodocs.altirnao.com/api/workflow/v2beta1/workflows/{workflowId}/states/{stateId}/transitions/{transitionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "createNewDocumentVersion": true,
  "createdTime": "2023-11-07T05:31:56Z",
  "discardCheckedOutDocument": true,
  "elapsedTime": {
    "amount": 123
  },
  "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>",
      "value": "<string>"
    },
    "reminders": [
      {
        "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": {
    "personValue": {
      "classId": "<string>",
      "className": "<string>",
      "description": "<string>",
      "displayName": "<string>",
      "displayName_i18n": "<string>",
      "thumbnailPictureUrl": "<string>",
      "value": "<string>"
    },
    "propertyId": "<string>",
    "value": "<string>"
  },
  "propertyTime": "<string>",
  "relativeTime": {
    "after": true,
    "amount": 123,
    "propertyId": "<string>"
  },
  "targetStateId": "<string>",
  "targetStateName": "<string>",
  "targetStateName_i18n": "<string>"
}
'
{
  "createNewDocumentVersion": true,
  "createdTime": "2023-11-07T05:31:56Z",
  "discardCheckedOutDocument": true,
  "elapsedTime": {
    "amount": 123
  },
  "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>",
      "value": "<string>"
    },
    "reminders": [
      {
        "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": {
    "personValue": {
      "classId": "<string>",
      "className": "<string>",
      "description": "<string>",
      "displayName": "<string>",
      "displayName_i18n": "<string>",
      "thumbnailPictureUrl": "<string>",
      "value": "<string>"
    },
    "propertyId": "<string>",
    "value": "<string>"
  },
  "propertyTime": "<string>",
  "relativeTime": {
    "after": true,
    "amount": 123,
    "propertyId": "<string>"
  },
  "targetStateId": "<string>",
  "targetStateName": "<string>",
  "targetStateName_i18n": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
workflowId
string
required

The ID of the workflow

​
stateId
string
required

The ID of the workflow state

​
transitionId
string
required

The ID of the workflow state

Query Parameters

​
domain
string

The G Suite domain

​
securityCode
string

The security code

Body

application/json
​
createNewDocumentVersion
boolean

Whether to create a new version of the documents via this transition (redundant with transitionType = VERSION)

​
createdTime
string<date-time>

The time at which the workflow transition was created

​
discardCheckedOutDocument
boolean

Whether to discard draft documents via this transition (redundant with transitionType = DISCARD)

​
elapsedTime
object
​
fixedTime
string<date-time>

The date from which the transition should be triggered (if automatic transition based on static date/time)

​
humanAction
object
​
id
string

The ID of the workflow transition

​
kind
string
​
lastModifiedTime
string<date-time>

The time at which the workflow transition was last modified

​
propertyData
object
​
propertyTime
string

The ID of the date (or date/time) property from whose value the transition should be triggered (if automatic transition based on property value)

​
relativeTime
object
​
targetStateId
string

The ID of the target state of the transition

​
targetStateName
string

The name of the target state of the transition

​
targetStateName_i18n
string

The internationalized name of the target state of the transition

​
transitionType
enum<string>

The type of the transition

Available options:
NORMAL,
CHECK_IN,
CHECK_OUT,
VERSION,
DISCARD

Response

200 - application/json

A ApiWorkflowTransition response

​
createNewDocumentVersion
boolean

Whether to create a new version of the documents via this transition (redundant with transitionType = VERSION)

​
createdTime
string<date-time>

The time at which the workflow transition was created

​
discardCheckedOutDocument
boolean

Whether to discard draft documents via this transition (redundant with transitionType = DISCARD)

​
elapsedTime
object
​
fixedTime
string<date-time>

The date from which the transition should be triggered (if automatic transition based on static date/time)

​
humanAction
object
​
id
string

The ID of the workflow transition

​
kind
string
​
lastModifiedTime
string<date-time>

The time at which the workflow transition was last modified

​
propertyData
object
​
propertyTime
string

The ID of the date (or date/time) property from whose value the transition should be triggered (if automatic transition based on property value)

​
relativeTime
object
​
targetStateId
string

The ID of the target state of the transition

​
targetStateName
string

The name of the target state of the transition

​
targetStateName_i18n
string

The internationalized name of the target state of the transition

​
transitionType
enum<string>

The type of the transition

Available options:
NORMAL,
CHECK_IN,
CHECK_OUT,
VERSION,
DISCARD