cURL
curl --request PATCH \
--url https://aodocs.altirnao.com/api/workflow/v2beta1/workflows/{workflowId}/states/{stateId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"annotationEditors": [
{
"classId": "<string>",
"className": "<string>",
"description": "<string>",
"displayName": "<string>",
"displayName_i18n": "<string>",
"thumbnailPictureUrl": "<string>",
"value": "<string>"
}
],
"annotationRestrictedViewers": [
{
"classId": "<string>",
"className": "<string>",
"description": "<string>",
"displayName": "<string>",
"displayName_i18n": "<string>",
"thumbnailPictureUrl": "<string>",
"value": "<string>"
}
],
"annotationViewers": [
{
"classId": "<string>",
"className": "<string>",
"description": "<string>",
"displayName": "<string>",
"displayName_i18n": "<string>",
"thumbnailPictureUrl": "<string>",
"value": "<string>"
}
],
"checkOutSettings": {
"addValidatorToPermissions": true,
"applyPreviousVersionPermissions": true,
"draftActionPrefix": "<string>",
"permissions": [
{
"displayName": "<string>",
"kind": "<string>",
"thumbnailPictureUrl": "<string>",
"value": "<string>",
"withLink": true
}
]
},
"createdTime": "2023-11-07T05:31:56Z",
"customActions": [
{
"id": "<string>",
"kind": "<string>",
"name": "<string>",
"params": {},
"scriptId": "<string>",
"scriptName": "<string>"
}
],
"description": "<string>",
"displayFlags": [],
"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>",
"senderTemplate": "<string>",
"subjectTemplate": "<string>"
},
"templateEmail": {
"id": "<string>",
"name": "<string>"
}
},
"notificationEmail": {
"customEmail": {
"bodyTemplate": "<string>",
"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>",
"value": "<string>"
}
]
},
"permissions": [
{
"displayName": "<string>",
"kind": "<string>",
"thumbnailPictureUrl": "<string>",
"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
},
"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>"
}
]
}
'import requests
url = "https://aodocs.altirnao.com/api/workflow/v2beta1/workflows/{workflowId}/states/{stateId}"
payload = {
"annotationEditors": [
{
"classId": "<string>",
"className": "<string>",
"description": "<string>",
"displayName": "<string>",
"displayName_i18n": "<string>",
"thumbnailPictureUrl": "<string>",
"value": "<string>"
}
],
"annotationRestrictedViewers": [
{
"classId": "<string>",
"className": "<string>",
"description": "<string>",
"displayName": "<string>",
"displayName_i18n": "<string>",
"thumbnailPictureUrl": "<string>",
"value": "<string>"
}
],
"annotationViewers": [
{
"classId": "<string>",
"className": "<string>",
"description": "<string>",
"displayName": "<string>",
"displayName_i18n": "<string>",
"thumbnailPictureUrl": "<string>",
"value": "<string>"
}
],
"checkOutSettings": {
"addValidatorToPermissions": True,
"applyPreviousVersionPermissions": True,
"draftActionPrefix": "<string>",
"permissions": [
{
"displayName": "<string>",
"kind": "<string>",
"thumbnailPictureUrl": "<string>",
"value": "<string>",
"withLink": True
}
]
},
"createdTime": "2023-11-07T05:31:56Z",
"customActions": [
{
"id": "<string>",
"kind": "<string>",
"name": "<string>",
"params": {},
"scriptId": "<string>",
"scriptName": "<string>"
}
],
"description": "<string>",
"displayFlags": [],
"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>",
"senderTemplate": "<string>",
"subjectTemplate": "<string>"
},
"templateEmail": {
"id": "<string>",
"name": "<string>"
}
},
"notificationEmail": {
"customEmail": {
"bodyTemplate": "<string>",
"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>",
"value": "<string>"
}
]
},
"permissions": [
{
"displayName": "<string>",
"kind": "<string>",
"thumbnailPictureUrl": "<string>",
"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 },
"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>"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
annotationEditors: [
{
classId: '<string>',
className: '<string>',
description: '<string>',
displayName: '<string>',
displayName_i18n: '<string>',
thumbnailPictureUrl: '<string>',
value: '<string>'
}
],
annotationRestrictedViewers: [
{
classId: '<string>',
className: '<string>',
description: '<string>',
displayName: '<string>',
displayName_i18n: '<string>',
thumbnailPictureUrl: '<string>',
value: '<string>'
}
],
annotationViewers: [
{
classId: '<string>',
className: '<string>',
description: '<string>',
displayName: '<string>',
displayName_i18n: '<string>',
thumbnailPictureUrl: '<string>',
value: '<string>'
}
],
checkOutSettings: {
addValidatorToPermissions: true,
applyPreviousVersionPermissions: true,
draftActionPrefix: '<string>',
permissions: [
{
displayName: '<string>',
kind: '<string>',
thumbnailPictureUrl: '<string>',
value: '<string>',
withLink: true
}
]
},
createdTime: '2023-11-07T05:31:56Z',
customActions: [
{
id: '<string>',
kind: '<string>',
name: '<string>',
params: {},
scriptId: '<string>',
scriptName: '<string>'
}
],
description: '<string>',
displayFlags: [],
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>',
senderTemplate: '<string>',
subjectTemplate: '<string>'
},
templateEmail: {id: '<string>', name: '<string>'}
},
notificationEmail: {
customEmail: {
bodyTemplate: '<string>',
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>',
value: '<string>'
}
]
},
permissions: [
{
displayName: '<string>',
kind: '<string>',
thumbnailPictureUrl: '<string>',
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},
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>'
}
]
})
};
fetch('https://aodocs.altirnao.com/api/workflow/v2beta1/workflows/{workflowId}/states/{stateId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://aodocs.altirnao.com/api/workflow/v2beta1/workflows/{workflowId}/states/{stateId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'annotationEditors' => [
[
'classId' => '<string>',
'className' => '<string>',
'description' => '<string>',
'displayName' => '<string>',
'displayName_i18n' => '<string>',
'thumbnailPictureUrl' => '<string>',
'value' => '<string>'
]
],
'annotationRestrictedViewers' => [
[
'classId' => '<string>',
'className' => '<string>',
'description' => '<string>',
'displayName' => '<string>',
'displayName_i18n' => '<string>',
'thumbnailPictureUrl' => '<string>',
'value' => '<string>'
]
],
'annotationViewers' => [
[
'classId' => '<string>',
'className' => '<string>',
'description' => '<string>',
'displayName' => '<string>',
'displayName_i18n' => '<string>',
'thumbnailPictureUrl' => '<string>',
'value' => '<string>'
]
],
'checkOutSettings' => [
'addValidatorToPermissions' => true,
'applyPreviousVersionPermissions' => true,
'draftActionPrefix' => '<string>',
'permissions' => [
[
'displayName' => '<string>',
'kind' => '<string>',
'thumbnailPictureUrl' => '<string>',
'value' => '<string>',
'withLink' => true
]
]
],
'createdTime' => '2023-11-07T05:31:56Z',
'customActions' => [
[
'id' => '<string>',
'kind' => '<string>',
'name' => '<string>',
'params' => [
],
'scriptId' => '<string>',
'scriptName' => '<string>'
]
],
'description' => '<string>',
'displayFlags' => [
],
'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>',
'senderTemplate' => '<string>',
'subjectTemplate' => '<string>'
],
'templateEmail' => [
'id' => '<string>',
'name' => '<string>'
]
],
'notificationEmail' => [
'customEmail' => [
'bodyTemplate' => '<string>',
'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>',
'value' => '<string>'
]
]
],
'permissions' => [
[
'displayName' => '<string>',
'kind' => '<string>',
'thumbnailPictureUrl' => '<string>',
'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
],
'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>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://aodocs.altirnao.com/api/workflow/v2beta1/workflows/{workflowId}/states/{stateId}"
payload := strings.NewReader("{\n \"annotationEditors\": [\n {\n \"classId\": \"<string>\",\n \"className\": \"<string>\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"displayName_i18n\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"annotationRestrictedViewers\": [\n {\n \"classId\": \"<string>\",\n \"className\": \"<string>\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"displayName_i18n\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"annotationViewers\": [\n {\n \"classId\": \"<string>\",\n \"className\": \"<string>\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"displayName_i18n\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"checkOutSettings\": {\n \"addValidatorToPermissions\": true,\n \"applyPreviousVersionPermissions\": true,\n \"draftActionPrefix\": \"<string>\",\n \"permissions\": [\n {\n \"displayName\": \"<string>\",\n \"kind\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\",\n \"withLink\": true\n }\n ]\n },\n \"createdTime\": \"2023-11-07T05:31:56Z\",\n \"customActions\": [\n {\n \"id\": \"<string>\",\n \"kind\": \"<string>\",\n \"name\": \"<string>\",\n \"params\": {},\n \"scriptId\": \"<string>\",\n \"scriptName\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"displayFlags\": [],\n \"draftDocuments\": true,\n \"hiddenFields\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"id\": \"<string>\",\n \"kind\": \"<string>\",\n \"lastModifiedTime\": \"2023-11-07T05:31:56Z\",\n \"mandatoryFields\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"name\": \"<string>\",\n \"name_i18n\": \"<string>\",\n \"notifications\": {\n \"actionEmail\": {\n \"customEmail\": {\n \"bodyTemplate\": \"<string>\",\n \"senderTemplate\": \"<string>\",\n \"subjectTemplate\": \"<string>\"\n },\n \"templateEmail\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n },\n \"notificationEmail\": {\n \"customEmail\": {\n \"bodyTemplate\": \"<string>\",\n \"senderTemplate\": \"<string>\",\n \"subjectTemplate\": \"<string>\"\n },\n \"templateEmail\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n },\n \"notifyHumanActionPerformer\": true,\n \"recipients\": [\n {\n \"classId\": \"<string>\",\n \"className\": \"<string>\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"displayName_i18n\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"permissions\": [\n {\n \"displayName\": \"<string>\",\n \"kind\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\",\n \"withLink\": true\n }\n ],\n \"readOnlyDocumentsNotCheckedOut\": true,\n \"readOnlyFields\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"resetDocumentPermissions\": true,\n \"transitions\": [\n {\n \"createNewDocumentVersion\": true,\n \"createdTime\": \"2023-11-07T05:31:56Z\",\n \"discardCheckedOutDocument\": true,\n \"elapsedTime\": {\n \"amount\": 123\n },\n \"fixedTime\": \"2023-11-07T05:31:56Z\",\n \"humanAction\": {\n \"actionId\": \"<string>\",\n \"appliedName\": \"<string>\",\n \"appliedName_i18n\": \"<string>\",\n \"commentPlaceholderText\": \"<string>\",\n \"commentPlaceholderText_i18n\": \"<string>\",\n \"mandatoryComment\": true,\n \"name\": \"<string>\",\n \"name_i18n\": \"<string>\",\n \"performer\": {\n \"classId\": \"<string>\",\n \"className\": \"<string>\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"displayName_i18n\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"reminders\": [\n {\n \"condition\": {\n \"params\": {},\n \"scriptId\": \"<string>\",\n \"scriptName\": \"<string>\"\n },\n \"emailTemplateId\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"validateByAll\": true\n },\n \"id\": \"<string>\",\n \"kind\": \"<string>\",\n \"lastModifiedTime\": \"2023-11-07T05:31:56Z\",\n \"propertyData\": {\n \"personValue\": {\n \"classId\": \"<string>\",\n \"className\": \"<string>\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"displayName_i18n\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"propertyId\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"propertyTime\": \"<string>\",\n \"relativeTime\": {\n \"after\": true,\n \"amount\": 123,\n \"propertyId\": \"<string>\"\n },\n \"targetStateId\": \"<string>\",\n \"targetStateName\": \"<string>\",\n \"targetStateName_i18n\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://aodocs.altirnao.com/api/workflow/v2beta1/workflows/{workflowId}/states/{stateId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"annotationEditors\": [\n {\n \"classId\": \"<string>\",\n \"className\": \"<string>\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"displayName_i18n\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"annotationRestrictedViewers\": [\n {\n \"classId\": \"<string>\",\n \"className\": \"<string>\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"displayName_i18n\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"annotationViewers\": [\n {\n \"classId\": \"<string>\",\n \"className\": \"<string>\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"displayName_i18n\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"checkOutSettings\": {\n \"addValidatorToPermissions\": true,\n \"applyPreviousVersionPermissions\": true,\n \"draftActionPrefix\": \"<string>\",\n \"permissions\": [\n {\n \"displayName\": \"<string>\",\n \"kind\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\",\n \"withLink\": true\n }\n ]\n },\n \"createdTime\": \"2023-11-07T05:31:56Z\",\n \"customActions\": [\n {\n \"id\": \"<string>\",\n \"kind\": \"<string>\",\n \"name\": \"<string>\",\n \"params\": {},\n \"scriptId\": \"<string>\",\n \"scriptName\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"displayFlags\": [],\n \"draftDocuments\": true,\n \"hiddenFields\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"id\": \"<string>\",\n \"kind\": \"<string>\",\n \"lastModifiedTime\": \"2023-11-07T05:31:56Z\",\n \"mandatoryFields\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"name\": \"<string>\",\n \"name_i18n\": \"<string>\",\n \"notifications\": {\n \"actionEmail\": {\n \"customEmail\": {\n \"bodyTemplate\": \"<string>\",\n \"senderTemplate\": \"<string>\",\n \"subjectTemplate\": \"<string>\"\n },\n \"templateEmail\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n },\n \"notificationEmail\": {\n \"customEmail\": {\n \"bodyTemplate\": \"<string>\",\n \"senderTemplate\": \"<string>\",\n \"subjectTemplate\": \"<string>\"\n },\n \"templateEmail\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n },\n \"notifyHumanActionPerformer\": true,\n \"recipients\": [\n {\n \"classId\": \"<string>\",\n \"className\": \"<string>\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"displayName_i18n\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"permissions\": [\n {\n \"displayName\": \"<string>\",\n \"kind\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\",\n \"withLink\": true\n }\n ],\n \"readOnlyDocumentsNotCheckedOut\": true,\n \"readOnlyFields\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"resetDocumentPermissions\": true,\n \"transitions\": [\n {\n \"createNewDocumentVersion\": true,\n \"createdTime\": \"2023-11-07T05:31:56Z\",\n \"discardCheckedOutDocument\": true,\n \"elapsedTime\": {\n \"amount\": 123\n },\n \"fixedTime\": \"2023-11-07T05:31:56Z\",\n \"humanAction\": {\n \"actionId\": \"<string>\",\n \"appliedName\": \"<string>\",\n \"appliedName_i18n\": \"<string>\",\n \"commentPlaceholderText\": \"<string>\",\n \"commentPlaceholderText_i18n\": \"<string>\",\n \"mandatoryComment\": true,\n \"name\": \"<string>\",\n \"name_i18n\": \"<string>\",\n \"performer\": {\n \"classId\": \"<string>\",\n \"className\": \"<string>\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"displayName_i18n\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"reminders\": [\n {\n \"condition\": {\n \"params\": {},\n \"scriptId\": \"<string>\",\n \"scriptName\": \"<string>\"\n },\n \"emailTemplateId\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"validateByAll\": true\n },\n \"id\": \"<string>\",\n \"kind\": \"<string>\",\n \"lastModifiedTime\": \"2023-11-07T05:31:56Z\",\n \"propertyData\": {\n \"personValue\": {\n \"classId\": \"<string>\",\n \"className\": \"<string>\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"displayName_i18n\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"propertyId\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"propertyTime\": \"<string>\",\n \"relativeTime\": {\n \"after\": true,\n \"amount\": 123,\n \"propertyId\": \"<string>\"\n },\n \"targetStateId\": \"<string>\",\n \"targetStateName\": \"<string>\",\n \"targetStateName_i18n\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://aodocs.altirnao.com/api/workflow/v2beta1/workflows/{workflowId}/states/{stateId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"annotationEditors\": [\n {\n \"classId\": \"<string>\",\n \"className\": \"<string>\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"displayName_i18n\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"annotationRestrictedViewers\": [\n {\n \"classId\": \"<string>\",\n \"className\": \"<string>\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"displayName_i18n\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"annotationViewers\": [\n {\n \"classId\": \"<string>\",\n \"className\": \"<string>\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"displayName_i18n\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"checkOutSettings\": {\n \"addValidatorToPermissions\": true,\n \"applyPreviousVersionPermissions\": true,\n \"draftActionPrefix\": \"<string>\",\n \"permissions\": [\n {\n \"displayName\": \"<string>\",\n \"kind\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\",\n \"withLink\": true\n }\n ]\n },\n \"createdTime\": \"2023-11-07T05:31:56Z\",\n \"customActions\": [\n {\n \"id\": \"<string>\",\n \"kind\": \"<string>\",\n \"name\": \"<string>\",\n \"params\": {},\n \"scriptId\": \"<string>\",\n \"scriptName\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"displayFlags\": [],\n \"draftDocuments\": true,\n \"hiddenFields\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"id\": \"<string>\",\n \"kind\": \"<string>\",\n \"lastModifiedTime\": \"2023-11-07T05:31:56Z\",\n \"mandatoryFields\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"name\": \"<string>\",\n \"name_i18n\": \"<string>\",\n \"notifications\": {\n \"actionEmail\": {\n \"customEmail\": {\n \"bodyTemplate\": \"<string>\",\n \"senderTemplate\": \"<string>\",\n \"subjectTemplate\": \"<string>\"\n },\n \"templateEmail\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n },\n \"notificationEmail\": {\n \"customEmail\": {\n \"bodyTemplate\": \"<string>\",\n \"senderTemplate\": \"<string>\",\n \"subjectTemplate\": \"<string>\"\n },\n \"templateEmail\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n },\n \"notifyHumanActionPerformer\": true,\n \"recipients\": [\n {\n \"classId\": \"<string>\",\n \"className\": \"<string>\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"displayName_i18n\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"permissions\": [\n {\n \"displayName\": \"<string>\",\n \"kind\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\",\n \"withLink\": true\n }\n ],\n \"readOnlyDocumentsNotCheckedOut\": true,\n \"readOnlyFields\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"resetDocumentPermissions\": true,\n \"transitions\": [\n {\n \"createNewDocumentVersion\": true,\n \"createdTime\": \"2023-11-07T05:31:56Z\",\n \"discardCheckedOutDocument\": true,\n \"elapsedTime\": {\n \"amount\": 123\n },\n \"fixedTime\": \"2023-11-07T05:31:56Z\",\n \"humanAction\": {\n \"actionId\": \"<string>\",\n \"appliedName\": \"<string>\",\n \"appliedName_i18n\": \"<string>\",\n \"commentPlaceholderText\": \"<string>\",\n \"commentPlaceholderText_i18n\": \"<string>\",\n \"mandatoryComment\": true,\n \"name\": \"<string>\",\n \"name_i18n\": \"<string>\",\n \"performer\": {\n \"classId\": \"<string>\",\n \"className\": \"<string>\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"displayName_i18n\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"reminders\": [\n {\n \"condition\": {\n \"params\": {},\n \"scriptId\": \"<string>\",\n \"scriptName\": \"<string>\"\n },\n \"emailTemplateId\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"validateByAll\": true\n },\n \"id\": \"<string>\",\n \"kind\": \"<string>\",\n \"lastModifiedTime\": \"2023-11-07T05:31:56Z\",\n \"propertyData\": {\n \"personValue\": {\n \"classId\": \"<string>\",\n \"className\": \"<string>\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"displayName_i18n\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"propertyId\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"propertyTime\": \"<string>\",\n \"relativeTime\": {\n \"after\": true,\n \"amount\": 123,\n \"propertyId\": \"<string>\"\n },\n \"targetStateId\": \"<string>\",\n \"targetStateName\": \"<string>\",\n \"targetStateName_i18n\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"annotationEditors": [
{
"classId": "<string>",
"className": "<string>",
"description": "<string>",
"displayName": "<string>",
"displayName_i18n": "<string>",
"thumbnailPictureUrl": "<string>",
"value": "<string>"
}
],
"annotationRestrictedViewers": [
{
"classId": "<string>",
"className": "<string>",
"description": "<string>",
"displayName": "<string>",
"displayName_i18n": "<string>",
"thumbnailPictureUrl": "<string>",
"value": "<string>"
}
],
"annotationViewers": [
{
"classId": "<string>",
"className": "<string>",
"description": "<string>",
"displayName": "<string>",
"displayName_i18n": "<string>",
"thumbnailPictureUrl": "<string>",
"value": "<string>"
}
],
"checkOutSettings": {
"addValidatorToPermissions": true,
"applyPreviousVersionPermissions": true,
"draftActionPrefix": "<string>",
"permissions": [
{
"displayName": "<string>",
"kind": "<string>",
"thumbnailPictureUrl": "<string>",
"value": "<string>",
"withLink": true
}
]
},
"createdTime": "2023-11-07T05:31:56Z",
"customActions": [
{
"id": "<string>",
"kind": "<string>",
"name": "<string>",
"params": {},
"scriptId": "<string>",
"scriptName": "<string>"
}
],
"description": "<string>",
"displayFlags": [],
"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>",
"senderTemplate": "<string>",
"subjectTemplate": "<string>"
},
"templateEmail": {
"id": "<string>",
"name": "<string>"
}
},
"notificationEmail": {
"customEmail": {
"bodyTemplate": "<string>",
"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>",
"value": "<string>"
}
]
},
"permissions": [
{
"displayName": "<string>",
"kind": "<string>",
"thumbnailPictureUrl": "<string>",
"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
},
"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>"
}
]
}workflow
Patch workflowv2beta1workflows states
Updates partially a workflow state configuration (all non-specified field values will remain unchanged).
PATCH
/
workflow
/
v2beta1
/
workflows
/
{workflowId}
/
states
/
{stateId}
cURL
curl --request PATCH \
--url https://aodocs.altirnao.com/api/workflow/v2beta1/workflows/{workflowId}/states/{stateId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"annotationEditors": [
{
"classId": "<string>",
"className": "<string>",
"description": "<string>",
"displayName": "<string>",
"displayName_i18n": "<string>",
"thumbnailPictureUrl": "<string>",
"value": "<string>"
}
],
"annotationRestrictedViewers": [
{
"classId": "<string>",
"className": "<string>",
"description": "<string>",
"displayName": "<string>",
"displayName_i18n": "<string>",
"thumbnailPictureUrl": "<string>",
"value": "<string>"
}
],
"annotationViewers": [
{
"classId": "<string>",
"className": "<string>",
"description": "<string>",
"displayName": "<string>",
"displayName_i18n": "<string>",
"thumbnailPictureUrl": "<string>",
"value": "<string>"
}
],
"checkOutSettings": {
"addValidatorToPermissions": true,
"applyPreviousVersionPermissions": true,
"draftActionPrefix": "<string>",
"permissions": [
{
"displayName": "<string>",
"kind": "<string>",
"thumbnailPictureUrl": "<string>",
"value": "<string>",
"withLink": true
}
]
},
"createdTime": "2023-11-07T05:31:56Z",
"customActions": [
{
"id": "<string>",
"kind": "<string>",
"name": "<string>",
"params": {},
"scriptId": "<string>",
"scriptName": "<string>"
}
],
"description": "<string>",
"displayFlags": [],
"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>",
"senderTemplate": "<string>",
"subjectTemplate": "<string>"
},
"templateEmail": {
"id": "<string>",
"name": "<string>"
}
},
"notificationEmail": {
"customEmail": {
"bodyTemplate": "<string>",
"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>",
"value": "<string>"
}
]
},
"permissions": [
{
"displayName": "<string>",
"kind": "<string>",
"thumbnailPictureUrl": "<string>",
"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
},
"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>"
}
]
}
'import requests
url = "https://aodocs.altirnao.com/api/workflow/v2beta1/workflows/{workflowId}/states/{stateId}"
payload = {
"annotationEditors": [
{
"classId": "<string>",
"className": "<string>",
"description": "<string>",
"displayName": "<string>",
"displayName_i18n": "<string>",
"thumbnailPictureUrl": "<string>",
"value": "<string>"
}
],
"annotationRestrictedViewers": [
{
"classId": "<string>",
"className": "<string>",
"description": "<string>",
"displayName": "<string>",
"displayName_i18n": "<string>",
"thumbnailPictureUrl": "<string>",
"value": "<string>"
}
],
"annotationViewers": [
{
"classId": "<string>",
"className": "<string>",
"description": "<string>",
"displayName": "<string>",
"displayName_i18n": "<string>",
"thumbnailPictureUrl": "<string>",
"value": "<string>"
}
],
"checkOutSettings": {
"addValidatorToPermissions": True,
"applyPreviousVersionPermissions": True,
"draftActionPrefix": "<string>",
"permissions": [
{
"displayName": "<string>",
"kind": "<string>",
"thumbnailPictureUrl": "<string>",
"value": "<string>",
"withLink": True
}
]
},
"createdTime": "2023-11-07T05:31:56Z",
"customActions": [
{
"id": "<string>",
"kind": "<string>",
"name": "<string>",
"params": {},
"scriptId": "<string>",
"scriptName": "<string>"
}
],
"description": "<string>",
"displayFlags": [],
"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>",
"senderTemplate": "<string>",
"subjectTemplate": "<string>"
},
"templateEmail": {
"id": "<string>",
"name": "<string>"
}
},
"notificationEmail": {
"customEmail": {
"bodyTemplate": "<string>",
"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>",
"value": "<string>"
}
]
},
"permissions": [
{
"displayName": "<string>",
"kind": "<string>",
"thumbnailPictureUrl": "<string>",
"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 },
"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>"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
annotationEditors: [
{
classId: '<string>',
className: '<string>',
description: '<string>',
displayName: '<string>',
displayName_i18n: '<string>',
thumbnailPictureUrl: '<string>',
value: '<string>'
}
],
annotationRestrictedViewers: [
{
classId: '<string>',
className: '<string>',
description: '<string>',
displayName: '<string>',
displayName_i18n: '<string>',
thumbnailPictureUrl: '<string>',
value: '<string>'
}
],
annotationViewers: [
{
classId: '<string>',
className: '<string>',
description: '<string>',
displayName: '<string>',
displayName_i18n: '<string>',
thumbnailPictureUrl: '<string>',
value: '<string>'
}
],
checkOutSettings: {
addValidatorToPermissions: true,
applyPreviousVersionPermissions: true,
draftActionPrefix: '<string>',
permissions: [
{
displayName: '<string>',
kind: '<string>',
thumbnailPictureUrl: '<string>',
value: '<string>',
withLink: true
}
]
},
createdTime: '2023-11-07T05:31:56Z',
customActions: [
{
id: '<string>',
kind: '<string>',
name: '<string>',
params: {},
scriptId: '<string>',
scriptName: '<string>'
}
],
description: '<string>',
displayFlags: [],
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>',
senderTemplate: '<string>',
subjectTemplate: '<string>'
},
templateEmail: {id: '<string>', name: '<string>'}
},
notificationEmail: {
customEmail: {
bodyTemplate: '<string>',
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>',
value: '<string>'
}
]
},
permissions: [
{
displayName: '<string>',
kind: '<string>',
thumbnailPictureUrl: '<string>',
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},
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>'
}
]
})
};
fetch('https://aodocs.altirnao.com/api/workflow/v2beta1/workflows/{workflowId}/states/{stateId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://aodocs.altirnao.com/api/workflow/v2beta1/workflows/{workflowId}/states/{stateId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'annotationEditors' => [
[
'classId' => '<string>',
'className' => '<string>',
'description' => '<string>',
'displayName' => '<string>',
'displayName_i18n' => '<string>',
'thumbnailPictureUrl' => '<string>',
'value' => '<string>'
]
],
'annotationRestrictedViewers' => [
[
'classId' => '<string>',
'className' => '<string>',
'description' => '<string>',
'displayName' => '<string>',
'displayName_i18n' => '<string>',
'thumbnailPictureUrl' => '<string>',
'value' => '<string>'
]
],
'annotationViewers' => [
[
'classId' => '<string>',
'className' => '<string>',
'description' => '<string>',
'displayName' => '<string>',
'displayName_i18n' => '<string>',
'thumbnailPictureUrl' => '<string>',
'value' => '<string>'
]
],
'checkOutSettings' => [
'addValidatorToPermissions' => true,
'applyPreviousVersionPermissions' => true,
'draftActionPrefix' => '<string>',
'permissions' => [
[
'displayName' => '<string>',
'kind' => '<string>',
'thumbnailPictureUrl' => '<string>',
'value' => '<string>',
'withLink' => true
]
]
],
'createdTime' => '2023-11-07T05:31:56Z',
'customActions' => [
[
'id' => '<string>',
'kind' => '<string>',
'name' => '<string>',
'params' => [
],
'scriptId' => '<string>',
'scriptName' => '<string>'
]
],
'description' => '<string>',
'displayFlags' => [
],
'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>',
'senderTemplate' => '<string>',
'subjectTemplate' => '<string>'
],
'templateEmail' => [
'id' => '<string>',
'name' => '<string>'
]
],
'notificationEmail' => [
'customEmail' => [
'bodyTemplate' => '<string>',
'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>',
'value' => '<string>'
]
]
],
'permissions' => [
[
'displayName' => '<string>',
'kind' => '<string>',
'thumbnailPictureUrl' => '<string>',
'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
],
'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>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://aodocs.altirnao.com/api/workflow/v2beta1/workflows/{workflowId}/states/{stateId}"
payload := strings.NewReader("{\n \"annotationEditors\": [\n {\n \"classId\": \"<string>\",\n \"className\": \"<string>\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"displayName_i18n\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"annotationRestrictedViewers\": [\n {\n \"classId\": \"<string>\",\n \"className\": \"<string>\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"displayName_i18n\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"annotationViewers\": [\n {\n \"classId\": \"<string>\",\n \"className\": \"<string>\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"displayName_i18n\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"checkOutSettings\": {\n \"addValidatorToPermissions\": true,\n \"applyPreviousVersionPermissions\": true,\n \"draftActionPrefix\": \"<string>\",\n \"permissions\": [\n {\n \"displayName\": \"<string>\",\n \"kind\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\",\n \"withLink\": true\n }\n ]\n },\n \"createdTime\": \"2023-11-07T05:31:56Z\",\n \"customActions\": [\n {\n \"id\": \"<string>\",\n \"kind\": \"<string>\",\n \"name\": \"<string>\",\n \"params\": {},\n \"scriptId\": \"<string>\",\n \"scriptName\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"displayFlags\": [],\n \"draftDocuments\": true,\n \"hiddenFields\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"id\": \"<string>\",\n \"kind\": \"<string>\",\n \"lastModifiedTime\": \"2023-11-07T05:31:56Z\",\n \"mandatoryFields\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"name\": \"<string>\",\n \"name_i18n\": \"<string>\",\n \"notifications\": {\n \"actionEmail\": {\n \"customEmail\": {\n \"bodyTemplate\": \"<string>\",\n \"senderTemplate\": \"<string>\",\n \"subjectTemplate\": \"<string>\"\n },\n \"templateEmail\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n },\n \"notificationEmail\": {\n \"customEmail\": {\n \"bodyTemplate\": \"<string>\",\n \"senderTemplate\": \"<string>\",\n \"subjectTemplate\": \"<string>\"\n },\n \"templateEmail\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n },\n \"notifyHumanActionPerformer\": true,\n \"recipients\": [\n {\n \"classId\": \"<string>\",\n \"className\": \"<string>\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"displayName_i18n\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"permissions\": [\n {\n \"displayName\": \"<string>\",\n \"kind\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\",\n \"withLink\": true\n }\n ],\n \"readOnlyDocumentsNotCheckedOut\": true,\n \"readOnlyFields\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"resetDocumentPermissions\": true,\n \"transitions\": [\n {\n \"createNewDocumentVersion\": true,\n \"createdTime\": \"2023-11-07T05:31:56Z\",\n \"discardCheckedOutDocument\": true,\n \"elapsedTime\": {\n \"amount\": 123\n },\n \"fixedTime\": \"2023-11-07T05:31:56Z\",\n \"humanAction\": {\n \"actionId\": \"<string>\",\n \"appliedName\": \"<string>\",\n \"appliedName_i18n\": \"<string>\",\n \"commentPlaceholderText\": \"<string>\",\n \"commentPlaceholderText_i18n\": \"<string>\",\n \"mandatoryComment\": true,\n \"name\": \"<string>\",\n \"name_i18n\": \"<string>\",\n \"performer\": {\n \"classId\": \"<string>\",\n \"className\": \"<string>\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"displayName_i18n\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"reminders\": [\n {\n \"condition\": {\n \"params\": {},\n \"scriptId\": \"<string>\",\n \"scriptName\": \"<string>\"\n },\n \"emailTemplateId\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"validateByAll\": true\n },\n \"id\": \"<string>\",\n \"kind\": \"<string>\",\n \"lastModifiedTime\": \"2023-11-07T05:31:56Z\",\n \"propertyData\": {\n \"personValue\": {\n \"classId\": \"<string>\",\n \"className\": \"<string>\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"displayName_i18n\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"propertyId\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"propertyTime\": \"<string>\",\n \"relativeTime\": {\n \"after\": true,\n \"amount\": 123,\n \"propertyId\": \"<string>\"\n },\n \"targetStateId\": \"<string>\",\n \"targetStateName\": \"<string>\",\n \"targetStateName_i18n\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://aodocs.altirnao.com/api/workflow/v2beta1/workflows/{workflowId}/states/{stateId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"annotationEditors\": [\n {\n \"classId\": \"<string>\",\n \"className\": \"<string>\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"displayName_i18n\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"annotationRestrictedViewers\": [\n {\n \"classId\": \"<string>\",\n \"className\": \"<string>\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"displayName_i18n\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"annotationViewers\": [\n {\n \"classId\": \"<string>\",\n \"className\": \"<string>\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"displayName_i18n\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"checkOutSettings\": {\n \"addValidatorToPermissions\": true,\n \"applyPreviousVersionPermissions\": true,\n \"draftActionPrefix\": \"<string>\",\n \"permissions\": [\n {\n \"displayName\": \"<string>\",\n \"kind\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\",\n \"withLink\": true\n }\n ]\n },\n \"createdTime\": \"2023-11-07T05:31:56Z\",\n \"customActions\": [\n {\n \"id\": \"<string>\",\n \"kind\": \"<string>\",\n \"name\": \"<string>\",\n \"params\": {},\n \"scriptId\": \"<string>\",\n \"scriptName\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"displayFlags\": [],\n \"draftDocuments\": true,\n \"hiddenFields\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"id\": \"<string>\",\n \"kind\": \"<string>\",\n \"lastModifiedTime\": \"2023-11-07T05:31:56Z\",\n \"mandatoryFields\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"name\": \"<string>\",\n \"name_i18n\": \"<string>\",\n \"notifications\": {\n \"actionEmail\": {\n \"customEmail\": {\n \"bodyTemplate\": \"<string>\",\n \"senderTemplate\": \"<string>\",\n \"subjectTemplate\": \"<string>\"\n },\n \"templateEmail\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n },\n \"notificationEmail\": {\n \"customEmail\": {\n \"bodyTemplate\": \"<string>\",\n \"senderTemplate\": \"<string>\",\n \"subjectTemplate\": \"<string>\"\n },\n \"templateEmail\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n },\n \"notifyHumanActionPerformer\": true,\n \"recipients\": [\n {\n \"classId\": \"<string>\",\n \"className\": \"<string>\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"displayName_i18n\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"permissions\": [\n {\n \"displayName\": \"<string>\",\n \"kind\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\",\n \"withLink\": true\n }\n ],\n \"readOnlyDocumentsNotCheckedOut\": true,\n \"readOnlyFields\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"resetDocumentPermissions\": true,\n \"transitions\": [\n {\n \"createNewDocumentVersion\": true,\n \"createdTime\": \"2023-11-07T05:31:56Z\",\n \"discardCheckedOutDocument\": true,\n \"elapsedTime\": {\n \"amount\": 123\n },\n \"fixedTime\": \"2023-11-07T05:31:56Z\",\n \"humanAction\": {\n \"actionId\": \"<string>\",\n \"appliedName\": \"<string>\",\n \"appliedName_i18n\": \"<string>\",\n \"commentPlaceholderText\": \"<string>\",\n \"commentPlaceholderText_i18n\": \"<string>\",\n \"mandatoryComment\": true,\n \"name\": \"<string>\",\n \"name_i18n\": \"<string>\",\n \"performer\": {\n \"classId\": \"<string>\",\n \"className\": \"<string>\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"displayName_i18n\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"reminders\": [\n {\n \"condition\": {\n \"params\": {},\n \"scriptId\": \"<string>\",\n \"scriptName\": \"<string>\"\n },\n \"emailTemplateId\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"validateByAll\": true\n },\n \"id\": \"<string>\",\n \"kind\": \"<string>\",\n \"lastModifiedTime\": \"2023-11-07T05:31:56Z\",\n \"propertyData\": {\n \"personValue\": {\n \"classId\": \"<string>\",\n \"className\": \"<string>\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"displayName_i18n\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"propertyId\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"propertyTime\": \"<string>\",\n \"relativeTime\": {\n \"after\": true,\n \"amount\": 123,\n \"propertyId\": \"<string>\"\n },\n \"targetStateId\": \"<string>\",\n \"targetStateName\": \"<string>\",\n \"targetStateName_i18n\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://aodocs.altirnao.com/api/workflow/v2beta1/workflows/{workflowId}/states/{stateId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"annotationEditors\": [\n {\n \"classId\": \"<string>\",\n \"className\": \"<string>\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"displayName_i18n\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"annotationRestrictedViewers\": [\n {\n \"classId\": \"<string>\",\n \"className\": \"<string>\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"displayName_i18n\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"annotationViewers\": [\n {\n \"classId\": \"<string>\",\n \"className\": \"<string>\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"displayName_i18n\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"checkOutSettings\": {\n \"addValidatorToPermissions\": true,\n \"applyPreviousVersionPermissions\": true,\n \"draftActionPrefix\": \"<string>\",\n \"permissions\": [\n {\n \"displayName\": \"<string>\",\n \"kind\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\",\n \"withLink\": true\n }\n ]\n },\n \"createdTime\": \"2023-11-07T05:31:56Z\",\n \"customActions\": [\n {\n \"id\": \"<string>\",\n \"kind\": \"<string>\",\n \"name\": \"<string>\",\n \"params\": {},\n \"scriptId\": \"<string>\",\n \"scriptName\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"displayFlags\": [],\n \"draftDocuments\": true,\n \"hiddenFields\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"id\": \"<string>\",\n \"kind\": \"<string>\",\n \"lastModifiedTime\": \"2023-11-07T05:31:56Z\",\n \"mandatoryFields\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"name\": \"<string>\",\n \"name_i18n\": \"<string>\",\n \"notifications\": {\n \"actionEmail\": {\n \"customEmail\": {\n \"bodyTemplate\": \"<string>\",\n \"senderTemplate\": \"<string>\",\n \"subjectTemplate\": \"<string>\"\n },\n \"templateEmail\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n },\n \"notificationEmail\": {\n \"customEmail\": {\n \"bodyTemplate\": \"<string>\",\n \"senderTemplate\": \"<string>\",\n \"subjectTemplate\": \"<string>\"\n },\n \"templateEmail\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n },\n \"notifyHumanActionPerformer\": true,\n \"recipients\": [\n {\n \"classId\": \"<string>\",\n \"className\": \"<string>\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"displayName_i18n\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"permissions\": [\n {\n \"displayName\": \"<string>\",\n \"kind\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\",\n \"withLink\": true\n }\n ],\n \"readOnlyDocumentsNotCheckedOut\": true,\n \"readOnlyFields\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"resetDocumentPermissions\": true,\n \"transitions\": [\n {\n \"createNewDocumentVersion\": true,\n \"createdTime\": \"2023-11-07T05:31:56Z\",\n \"discardCheckedOutDocument\": true,\n \"elapsedTime\": {\n \"amount\": 123\n },\n \"fixedTime\": \"2023-11-07T05:31:56Z\",\n \"humanAction\": {\n \"actionId\": \"<string>\",\n \"appliedName\": \"<string>\",\n \"appliedName_i18n\": \"<string>\",\n \"commentPlaceholderText\": \"<string>\",\n \"commentPlaceholderText_i18n\": \"<string>\",\n \"mandatoryComment\": true,\n \"name\": \"<string>\",\n \"name_i18n\": \"<string>\",\n \"performer\": {\n \"classId\": \"<string>\",\n \"className\": \"<string>\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"displayName_i18n\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"reminders\": [\n {\n \"condition\": {\n \"params\": {},\n \"scriptId\": \"<string>\",\n \"scriptName\": \"<string>\"\n },\n \"emailTemplateId\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"validateByAll\": true\n },\n \"id\": \"<string>\",\n \"kind\": \"<string>\",\n \"lastModifiedTime\": \"2023-11-07T05:31:56Z\",\n \"propertyData\": {\n \"personValue\": {\n \"classId\": \"<string>\",\n \"className\": \"<string>\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"displayName_i18n\": \"<string>\",\n \"thumbnailPictureUrl\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"propertyId\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"propertyTime\": \"<string>\",\n \"relativeTime\": {\n \"after\": true,\n \"amount\": 123,\n \"propertyId\": \"<string>\"\n },\n \"targetStateId\": \"<string>\",\n \"targetStateName\": \"<string>\",\n \"targetStateName_i18n\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"annotationEditors": [
{
"classId": "<string>",
"className": "<string>",
"description": "<string>",
"displayName": "<string>",
"displayName_i18n": "<string>",
"thumbnailPictureUrl": "<string>",
"value": "<string>"
}
],
"annotationRestrictedViewers": [
{
"classId": "<string>",
"className": "<string>",
"description": "<string>",
"displayName": "<string>",
"displayName_i18n": "<string>",
"thumbnailPictureUrl": "<string>",
"value": "<string>"
}
],
"annotationViewers": [
{
"classId": "<string>",
"className": "<string>",
"description": "<string>",
"displayName": "<string>",
"displayName_i18n": "<string>",
"thumbnailPictureUrl": "<string>",
"value": "<string>"
}
],
"checkOutSettings": {
"addValidatorToPermissions": true,
"applyPreviousVersionPermissions": true,
"draftActionPrefix": "<string>",
"permissions": [
{
"displayName": "<string>",
"kind": "<string>",
"thumbnailPictureUrl": "<string>",
"value": "<string>",
"withLink": true
}
]
},
"createdTime": "2023-11-07T05:31:56Z",
"customActions": [
{
"id": "<string>",
"kind": "<string>",
"name": "<string>",
"params": {},
"scriptId": "<string>",
"scriptName": "<string>"
}
],
"description": "<string>",
"displayFlags": [],
"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>",
"senderTemplate": "<string>",
"subjectTemplate": "<string>"
},
"templateEmail": {
"id": "<string>",
"name": "<string>"
}
},
"notificationEmail": {
"customEmail": {
"bodyTemplate": "<string>",
"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>",
"value": "<string>"
}
]
},
"permissions": [
{
"displayName": "<string>",
"kind": "<string>",
"thumbnailPictureUrl": "<string>",
"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
},
"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
google_id_token-a99f12e0google_id_token_legacy-a99f12e0
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The ID of the workflow
The ID of the workflow state
Body
application/json
Users, groups, roles or Everybody allowed to edit annotations while the document is in this workflow state. Used when the document class aclSource is STATE. A user in editors but not in viewers may only view and edit annotations they authored.
Show child attributes
Show child attributes
(Deprecated, no longer enforced) Users, groups, roles or Everybody previously denied annotation access while the document is in this workflow state. Use annotationViewers and annotationEditors instead.
Show child attributes
Show child attributes
Users, groups, roles or Everybody allowed to view annotations while the document is in this workflow state. Used when the document class aclSource is STATE.
Show child attributes
Show child attributes
(Deprecated) The action to apply when entering the workflow state
Available options:
DO_NOTHING, NEW_VERSION, CHECK_IN, DISCARD, CHECK_OUT Show child attributes
Show child attributes
The mode that defined whether documents are read-only if not checked-out at the document class level
Available options:
DISABLED, OPTIONAL, MANDATORY The time at which the workflow state was created
The list of custom actions to apply on the workflow state
Show child attributes
Show child attributes
The description of the workflow state
The flags to control display of the workflow state in the application (HIDDEN_FROM_? where ? = WORKFLOW_TASKS, BROWSEBY or VIEW_FILTERS)
Available options:
HIDDEN_FROM_WORKFLOW_TASKS, HIDDEN_FROM_BROWSEBY, HIDDEN_FROM_VIEW_FILTERS Whether the workflow state is a draft state
The list of fields to be hidden in the workflow state (id is read/write, name is readonly)
Show child attributes
Show child attributes
The ID of the workflow state
The time at which the workflow state was last modified
The list of fields to be mandatory in the workflow state (id is read/write, name is readonly)
Show child attributes
Show child attributes
The name of the workflow state
The internationalized name of the workflow state
Show child attributes
Show child attributes
The list of permissions when inheriting them from the workflow state
Show child attributes
Show child attributes
The mode to control whether the documents are read-only if not checked-out
The list of fields to be read-only in the workflow state (id is read/write, name is readonly)
Show child attributes
Show child attributes
Whether to reset explicit permissions when entering the workflow state
The list of workflow transitions from this workflow state
Show child attributes
Show child attributes
Response
200 - application/json
A ApiWorkflowState response
Users, groups, roles or Everybody allowed to edit annotations while the document is in this workflow state. Used when the document class aclSource is STATE. A user in editors but not in viewers may only view and edit annotations they authored.
Show child attributes
Show child attributes
(Deprecated, no longer enforced) Users, groups, roles or Everybody previously denied annotation access while the document is in this workflow state. Use annotationViewers and annotationEditors instead.
Show child attributes
Show child attributes
Users, groups, roles or Everybody allowed to view annotations while the document is in this workflow state. Used when the document class aclSource is STATE.
Show child attributes
Show child attributes
(Deprecated) The action to apply when entering the workflow state
Available options:
DO_NOTHING, NEW_VERSION, CHECK_IN, DISCARD, CHECK_OUT Show child attributes
Show child attributes
The mode that defined whether documents are read-only if not checked-out at the document class level
Available options:
DISABLED, OPTIONAL, MANDATORY The time at which the workflow state was created
The list of custom actions to apply on the workflow state
Show child attributes
Show child attributes
The description of the workflow state
The flags to control display of the workflow state in the application (HIDDEN_FROM_? where ? = WORKFLOW_TASKS, BROWSEBY or VIEW_FILTERS)
Available options:
HIDDEN_FROM_WORKFLOW_TASKS, HIDDEN_FROM_BROWSEBY, HIDDEN_FROM_VIEW_FILTERS Whether the workflow state is a draft state
The list of fields to be hidden in the workflow state (id is read/write, name is readonly)
Show child attributes
Show child attributes
The ID of the workflow state
The time at which the workflow state was last modified
The list of fields to be mandatory in the workflow state (id is read/write, name is readonly)
Show child attributes
Show child attributes
The name of the workflow state
The internationalized name of the workflow state
Show child attributes
Show child attributes
The list of permissions when inheriting them from the workflow state
Show child attributes
Show child attributes
The mode to control whether the documents are read-only if not checked-out
The list of fields to be read-only in the workflow state (id is read/write, name is readonly)
Show child attributes
Show child attributes
Whether to reset explicit permissions when entering the workflow state
The list of workflow transitions from this workflow state
Show child attributes
Show child attributes
⌘I