Skip to main content
PATCH
/
workflow
/
v2beta1
/
workflows
/
{workflowId}
cURL
curl --request PATCH \
  --url https://aodocs.altirnao.com/api/workflow/v2beta1/workflows/{workflowId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "allowNotificationForAllExternalUsers": true,
  "classId": "<string>",
  "className": "<string>",
  "createdTime": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "initialStateId": "<string>",
  "kind": "<string>",
  "lastModifiedTime": "2023-11-07T05:31:56Z",
  "libraryId": "<string>",
  "libraryName": "<string>",
  "muteNotifications": true,
  "name": "<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"
        }
      ]
    }
  ]
}
'
{
  "allowNotificationForAllExternalUsers": true,
  "classId": "<string>",
  "className": "<string>",
  "createdTime": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "initialStateId": "<string>",
  "kind": "<string>",
  "lastModifiedTime": "2023-11-07T05:31:56Z",
  "libraryId": "<string>",
  "libraryName": "<string>",
  "muteNotifications": true,
  "name": "<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"
        }
      ]
    }
  ]
}

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

Query Parameters

​
domain
string

The G Suite domain

​
securityCode
string

The security code

Body

application/json
​
allowNotificationForAllExternalUsers
boolean

Whether to allow sending notifications also for non-whitelisted external users/groups

​
classId
string

The ID of the document class (read-only field)

​
className
string

The name of the document class (read-only field)

​
createdTime
string<date-time>

The time at which the workflow was created (read-only field)

​
id
string

The ID of the workflow (read-only field)

​
initialStateId
string

The ID of the initial state (read-only field)

​
kind
string
​
lastModifiedTime
string<date-time>

The time at which the workflow was last modified (read-only field)

​
libraryId
string

The ID of the library (read-only field)

​
libraryName
string

The name of the library (read-only field)

​
muteNotifications
boolean

Whether to mute email notifications

​
name
string

The name of the workflow

​
states
object[]

The list of workflow states

Response

200 - application/json

A ApiWorkflow response

​
allowNotificationForAllExternalUsers
boolean

Whether to allow sending notifications also for non-whitelisted external users/groups

​
classId
string

The ID of the document class (read-only field)

​
className
string

The name of the document class (read-only field)

​
createdTime
string<date-time>

The time at which the workflow was created (read-only field)

​
id
string

The ID of the workflow (read-only field)

​
initialStateId
string

The ID of the initial state (read-only field)

​
kind
string
​
lastModifiedTime
string<date-time>

The time at which the workflow was last modified (read-only field)

​
libraryId
string

The ID of the library (read-only field)

​
libraryName
string

The name of the library (read-only field)

​
muteNotifications
boolean

Whether to mute email notifications

​
name
string

The name of the workflow

​
states
object[]

The list of workflow states