Skip to main content
PATCH
/
document
/
v1
/
{documentId}
cURL
curl --request PATCH \
  --url https://aodocs.altirnao.com/api/document/v1/{documentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "acl": [
    {
      "allow": [
        "<string>"
      ],
      "for": [
        "<string>"
      ],
      "kind": "<string>"
    }
  ],
  "attachmentFields": [
    {
      "calculatedSettingsInfo": {},
      "calculatedValueInfo": {
        "error": true
      },
      "description": "<string>",
      "description_i18n": "<string>",
      "editable": true,
      "fieldId": "<string>",
      "fieldName": "<string>",
      "fieldName_i18n": "<string>",
      "hidden": true,
      "kind": "<string>",
      "mandatory": true,
      "metadata": {
        "attachments": [
          {
            "drive": {
              "iconLink": "<string>",
              "kind": "<string>",
              "link": "<string>",
              "permissionsOnDrive": [
                {
                  "additionalRoles": [
                    "<string>"
                  ],
                  "allowlisted": true,
                  "belongsToDomain": true,
                  "email": "<string>",
                  "googleEmailAddress": true,
                  "kind": "<string>",
                  "name": "<string>",
                  "permissionId": "<string>",
                  "role": "<string>",
                  "thumbnailPhotoUrl": "<string>",
                  "type": "<string>",
                  "withLink": true
                }
              ],
              "publishedLink": "<string>",
              "resourceKey": "<string>",
              "revisionId": "<string>"
            },
            "id": "<string>",
            "kind": "<string>",
            "mimeType": "<string>",
            "name": "<string>",
            "oss": {
              "downloadLink": "<string>",
              "kind": "<string>"
            },
            "size": 123,
            "storageType": "OSS"
          }
        ],
        "kind": "<string>"
      },
      "multiple": true,
      "placeholderText": "<string>",
      "rank": 123,
      "readOnly": true,
      "type": "STRING",
      "validation": {
        "audience": {
          "classId": "<string>",
          "className": "<string>",
          "description": "<string>",
          "displayName": "<string>",
          "displayName_i18n": "<string>",
          "thumbnailPictureUrl": "<string>",
          "type": "USER",
          "value": "<string>"
        },
        "errorMessage": "<string>",
        "kind": "<string>",
        "lowerLimit": 123,
        "lowerLimitInclusive": true,
        "mandatoryLeaf": true,
        "regex": "<string>",
        "upperLimit": 123,
        "upperLimitInclusive": true
      },
      "values": [
        "<string>"
      ]
    }
  ],
  "attachments": [
    {
      "autodeskUrn": {
        "status": "READY",
        "urn": "<string>"
      },
      "fileId": "<string>",
      "iconLink": "<string>",
      "kind": "<string>",
      "link": "<string>",
      "mimeType": "<string>",
      "name": "<string>",
      "permissionsOnDrive": [
        {
          "additionalRoles": [
            "<string>"
          ],
          "allowlisted": true,
          "belongsToDomain": true,
          "email": "<string>",
          "googleEmailAddress": true,
          "kind": "<string>",
          "name": "<string>",
          "permissionId": "<string>",
          "role": "<string>",
          "thumbnailPhotoUrl": "<string>",
          "type": "<string>",
          "withLink": true
        }
      ],
      "publishedLink": "<string>",
      "resourceKey": "<string>",
      "revisionId": "<string>",
      "size": 123,
      "storageLocation": "DRIVE"
    }
  ],
  "attachmentsToCopy": [
    {
      "autodeskUrn": {
        "status": "READY",
        "urn": "<string>"
      },
      "fileId": "<string>",
      "iconLink": "<string>",
      "kind": "<string>",
      "link": "<string>",
      "mimeType": "<string>",
      "name": "<string>",
      "permissionsOnDrive": [
        {
          "additionalRoles": [
            "<string>"
          ],
          "allowlisted": true,
          "belongsToDomain": true,
          "email": "<string>",
          "googleEmailAddress": true,
          "kind": "<string>",
          "name": "<string>",
          "permissionId": "<string>",
          "role": "<string>",
          "thumbnailPhotoUrl": "<string>",
          "type": "<string>",
          "withLink": true
        }
      ],
      "publishedLink": "<string>",
      "resourceKey": "<string>",
      "revisionId": "<string>",
      "size": 123,
      "storageLocation": "DRIVE"
    }
  ],
  "categories": [
    {
      "calculatedSettingsInfo": {},
      "calculatedValueInfo": {
        "error": true
      },
      "categoryDefinition": {
        "description": "<string>",
        "dynamicValues": true,
        "folder": true,
        "id": "<string>",
        "kind": "<string>",
        "levelNames": [
          "<string>"
        ],
        "levelNames_i18n": [
          "<string>"
        ],
        "libraryId": "<string>",
        "name": "<string>",
        "tags": true,
        "value": "<string>"
      },
      "definitionId": "<string>",
      "definitionName": "<string>",
      "description": "<string>",
      "description_i18n": "<string>",
      "dynamicValues": true,
      "editable": true,
      "fieldId": "<string>",
      "fieldName": "<string>",
      "fieldName_i18n": "<string>",
      "folder": true,
      "hidden": true,
      "kind": "<string>",
      "levelNames": [
        "<string>"
      ],
      "mandatory": true,
      "multiple": true,
      "placeholderText": "<string>",
      "rank": 123,
      "readOnly": true,
      "type": "STRING",
      "validation": {
        "audience": {
          "classId": "<string>",
          "className": "<string>",
          "description": "<string>",
          "displayName": "<string>",
          "displayName_i18n": "<string>",
          "thumbnailPictureUrl": "<string>",
          "type": "USER",
          "value": "<string>"
        },
        "errorMessage": "<string>",
        "kind": "<string>",
        "lowerLimit": 123,
        "lowerLimitInclusive": true,
        "mandatoryLeaf": true,
        "regex": "<string>",
        "upperLimit": 123,
        "upperLimitInclusive": true
      },
      "values": [
        [
          {
            "ancestors": "<array>",
            "id": "<string>",
            "kind": "<string>",
            "leaf": true,
            "leafInNotOutdatedTree": true,
            "name": "<string>",
            "name_i18n": "<string>",
            "outdated": true,
            "parentId": "<string>",
            "shortName": "<string>",
            "value": "<string>"
          }
        ]
      ]
    }
  ],
  "checkOutBy": "<string>",
  "checkoutDate": "<string>",
  "classId": "<string>",
  "className": "<string>",
  "className_i18n": "<string>",
  "coordinate": "<string>",
  "creationDate": "<string>",
  "deleteAuthor": "<string>",
  "deleted": true,
  "deletedReason": "<string>",
  "deletionDate": "<string>",
  "domainName": "<string>",
  "driveOnlyPermissions": [
    {
      "additionalRoles": [
        "<string>"
      ],
      "allowlisted": true,
      "belongsToDomain": true,
      "email": "<string>",
      "googleEmailAddress": true,
      "kind": "<string>",
      "name": "<string>",
      "permissionId": "<string>",
      "role": "<string>",
      "thumbnailPhotoUrl": "<string>",
      "type": "<string>",
      "withLink": true
    }
  ],
  "editable": true,
  "evaluationError": true,
  "fields": [
    {
      "calculatedSettingsInfo": {},
      "calculatedValueInfo": {
        "error": true
      },
      "description": "<string>",
      "description_i18n": "<string>",
      "editable": true,
      "fieldId": "<string>",
      "fieldName": "<string>",
      "fieldName_i18n": "<string>",
      "hidden": true,
      "kind": "<string>",
      "mandatory": true,
      "metadata": {
        "attachments": [
          {
            "drive": {
              "iconLink": "<string>",
              "kind": "<string>",
              "link": "<string>",
              "permissionsOnDrive": [
                {
                  "additionalRoles": [
                    "<string>"
                  ],
                  "allowlisted": true,
                  "belongsToDomain": true,
                  "email": "<string>",
                  "googleEmailAddress": true,
                  "kind": "<string>",
                  "name": "<string>",
                  "permissionId": "<string>",
                  "role": "<string>",
                  "thumbnailPhotoUrl": "<string>",
                  "type": "<string>",
                  "withLink": true
                }
              ],
              "publishedLink": "<string>",
              "resourceKey": "<string>",
              "revisionId": "<string>"
            },
            "id": "<string>",
            "kind": "<string>",
            "mimeType": "<string>",
            "name": "<string>",
            "oss": {
              "downloadLink": "<string>",
              "kind": "<string>"
            },
            "size": 123,
            "storageType": "OSS"
          }
        ],
        "kind": "<string>"
      },
      "multiple": true,
      "placeholderText": "<string>",
      "rank": 123,
      "readOnly": true,
      "type": "STRING",
      "validation": {
        "audience": {
          "classId": "<string>",
          "className": "<string>",
          "description": "<string>",
          "displayName": "<string>",
          "displayName_i18n": "<string>",
          "thumbnailPictureUrl": "<string>",
          "type": "USER",
          "value": "<string>"
        },
        "errorMessage": "<string>",
        "kind": "<string>",
        "lowerLimit": 123,
        "lowerLimitInclusive": true,
        "mandatoryLeaf": true,
        "regex": "<string>",
        "upperLimit": 123,
        "upperLimitInclusive": true
      },
      "values": [
        "<string>"
      ]
    }
  ],
  "folders": [
    {
      "editable": true,
      "editableDocuments": true,
      "fileId": "<string>",
      "folderAodocsId": "<string>",
      "folderDefinitionId": "<string>",
      "folderIsRoot": true,
      "kind": "<string>",
      "libraryId": "<string>",
      "libraryName": "<string>",
      "name": "<string>",
      "parentFolderAodocsId": "<string>",
      "parentFolderDriveId": "<string>",
      "parentFolderIsRoot": true,
      "permittedOperations": [
        "DELETE"
      ],
      "resourceKey": "<string>",
      "restrictedDownload": true,
      "subfolders": "<array>"
    }
  ],
  "forbiddenOperations": {},
  "fullSizeOfAttachments": 123,
  "iconLink": "<string>",
  "id": "<string>",
  "incomplete": true,
  "initialAuthor": "<string>",
  "invalidValues": true,
  "kind": "<string>",
  "libraryId": "<string>",
  "libraryName": "<string>",
  "modificationDate": "<string>",
  "newPermissions": [
    {
      "additionalRoles": [
        "<string>"
      ],
      "allowlisted": true,
      "belongsToDomain": true,
      "email": "<string>",
      "googleEmailAddress": true,
      "kind": "<string>",
      "name": "<string>",
      "permissionId": "<string>",
      "role": "<string>",
      "thumbnailPhotoUrl": "<string>",
      "type": "<string>",
      "withLink": true
    }
  ],
  "nextVersionName": "<string>",
  "numberOfAttachments": 123,
  "onlyAdminCanChangeAcl": true,
  "onlyAdminCanDelete": true,
  "originalVersionId": "<string>",
  "permissions": [
    {
      "fieldNames": [
        "<string>"
      ],
      "inherited": true,
      "kind": "<string>",
      "name": "<string>",
      "right": "NONE",
      "roleNames": [
        "<string>"
      ],
      "thumbnailPhotoUrl": "<string>",
      "type": "USER",
      "value": "<string>"
    }
  ],
  "permittedOperations": [
    "DELETE"
  ],
  "publishedLink": "<string>",
  "publishedMode": "NONE",
  "referenceCatalogs": [
    {
      "calculatedSettingsInfo": {},
      "calculatedValueInfo": {
        "error": true
      },
      "description": "<string>",
      "description_i18n": "<string>",
      "editable": true,
      "fieldId": "<string>",
      "fieldName": "<string>",
      "fieldName_i18n": "<string>",
      "hidden": true,
      "kind": "<string>",
      "mandatory": true,
      "multiple": true,
      "placeholderText": "<string>",
      "rank": 123,
      "readOnly": true,
      "referenceCatalog": {
        "createdAt": 123,
        "id": "<string>",
        "kind": "<string>",
        "levelNames": [
          "<string>"
        ],
        "modifiedAt": 123,
        "name": "<string>",
        "numberOfValues": 123
      },
      "referenceCatalogId": "<string>",
      "type": "STRING",
      "validation": {
        "audience": {
          "classId": "<string>",
          "className": "<string>",
          "description": "<string>",
          "displayName": "<string>",
          "displayName_i18n": "<string>",
          "thumbnailPictureUrl": "<string>",
          "type": "USER",
          "value": "<string>"
        },
        "errorMessage": "<string>",
        "kind": "<string>",
        "lowerLimit": 123,
        "lowerLimitInclusive": true,
        "mandatoryLeaf": true,
        "regex": "<string>",
        "upperLimit": 123,
        "upperLimitInclusive": true
      },
      "values": [
        {
          "deleted": true,
          "kind": "<string>",
          "leaf": true,
          "name": "<string>",
          "name_i18n": "<string>",
          "parents": "<array>",
          "value": "<string>"
        }
      ]
    }
  ],
  "relatedDocuments": {},
  "restrictedDownload": true,
  "richText": "<string>",
  "sections": [
    {
      "columnCount": 123,
      "description": "<string>",
      "fields": [
        {
          "id": "<string>",
          "type": "<string>"
        }
      ],
      "id": "<string>",
      "name": "<string>",
      "name_i18n": "<string>"
    }
  ],
  "sequenceId": 123,
  "setModifiedDate": true,
  "state": "<string>",
  "stateChangeAuthors": [
    {
      "classId": "<string>",
      "className": "<string>",
      "description": "<string>",
      "displayName": "<string>",
      "displayName_i18n": "<string>",
      "thumbnailPictureUrl": "<string>",
      "type": "USER",
      "value": "<string>"
    }
  ],
  "stateChangeDate": "2023-11-07T05:31:56Z",
  "stateId": "<string>",
  "state_i18n": "<string>",
  "systemFields": [
    {
      "calculatedValueInfo": {
        "error": true
      },
      "displayName": "<string>",
      "editable": true,
      "hidden": true,
      "id": "<string>",
      "kind": "<string>",
      "mandatory": true,
      "readOnly": true,
      "value": "<string>"
    }
  ],
  "tableFields": [
    {
      "calculatedSettingsInfo": {},
      "calculatedValueInfo": {
        "error": true
      },
      "columns": [
        {
          "calculatedSettingsInfo": {},
          "calculatedValueInfo": {
            "error": true
          },
          "categoryDefinition": {
            "description": "<string>",
            "dynamicValues": true,
            "folder": true,
            "id": "<string>",
            "kind": "<string>",
            "levelNames": [
              "<string>"
            ],
            "levelNames_i18n": [
              "<string>"
            ],
            "libraryId": "<string>",
            "name": "<string>",
            "tags": true,
            "value": "<string>"
          },
          "description": "<string>",
          "description_i18n": "<string>",
          "editable": true,
          "fieldId": "<string>",
          "fieldName": "<string>",
          "fieldName_i18n": "<string>",
          "hidden": true,
          "kind": "<string>",
          "mandatory": true,
          "multiple": true,
          "placeholderText": "<string>",
          "rank": 123,
          "readOnly": true,
          "referenceCatalogDefinition": {
            "createdAt": 123,
            "id": "<string>",
            "kind": "<string>",
            "levelNames": [
              "<string>"
            ],
            "modifiedAt": 123,
            "name": "<string>",
            "numberOfValues": 123
          },
          "type": "STRING",
          "validation": {
            "audience": {
              "classId": "<string>",
              "className": "<string>",
              "description": "<string>",
              "displayName": "<string>",
              "displayName_i18n": "<string>",
              "thumbnailPictureUrl": "<string>",
              "type": "USER",
              "value": "<string>"
            },
            "errorMessage": "<string>",
            "kind": "<string>",
            "lowerLimit": 123,
            "lowerLimitInclusive": true,
            "mandatoryLeaf": true,
            "regex": "<string>",
            "upperLimit": 123,
            "upperLimitInclusive": true
          }
        }
      ],
      "description": "<string>",
      "description_i18n": "<string>",
      "editable": true,
      "fieldId": "<string>",
      "fieldName": "<string>",
      "fieldName_i18n": "<string>",
      "hidden": true,
      "kind": "<string>",
      "mandatory": true,
      "multiple": true,
      "placeholderText": "<string>",
      "rank": 123,
      "readOnly": true,
      "type": "STRING",
      "validation": {
        "audience": {
          "classId": "<string>",
          "className": "<string>",
          "description": "<string>",
          "displayName": "<string>",
          "displayName_i18n": "<string>",
          "thumbnailPictureUrl": "<string>",
          "type": "USER",
          "value": "<string>"
        },
        "errorMessage": "<string>",
        "kind": "<string>",
        "lowerLimit": 123,
        "lowerLimitInclusive": true,
        "mandatoryLeaf": true,
        "regex": "<string>",
        "upperLimit": 123,
        "upperLimitInclusive": true
      },
      "values": [
        {
          "categories": {},
          "fields": {},
          "referenceCatalogs": {},
          "rowId": "<string>"
        }
      ]
    }
  ],
  "templateDocumentId": "<string>",
  "title": "<string>",
  "updateAuthor": "<string>",
  "userCanChangeAcl": true,
  "userCanChangeProperties": true,
  "userCanDelete": true,
  "userMapping": {},
  "versionCreated": "2023-11-07T05:31:56Z",
  "versionCreator": "<string>",
  "versionDescription": "<string>",
  "versionId": "<string>",
  "versionLabel": "<string>",
  "versionName": "<string>",
  "versionNumber": "<string>",
  "viewConfiguration": {
    "defaultTabToDisplay": "PROPERTIES",
    "kind": "<string>",
    "orientation": "PORTRAIT",
    "visibleRelations": [
      "<string>"
    ],
    "visibleSections": [
      "INFO"
    ]
  },
  "workflowId": "<string>"
}
'
{
  "acl": [
    {
      "allow": [
        "<string>"
      ],
      "for": [
        "<string>"
      ],
      "kind": "<string>"
    }
  ],
  "attachmentFields": [
    {
      "calculatedSettingsInfo": {},
      "calculatedValueInfo": {
        "error": true
      },
      "description": "<string>",
      "description_i18n": "<string>",
      "editable": true,
      "fieldId": "<string>",
      "fieldName": "<string>",
      "fieldName_i18n": "<string>",
      "hidden": true,
      "kind": "<string>",
      "mandatory": true,
      "metadata": {
        "attachments": [
          {
            "drive": {
              "iconLink": "<string>",
              "kind": "<string>",
              "link": "<string>",
              "permissionsOnDrive": [
                {
                  "additionalRoles": [
                    "<string>"
                  ],
                  "allowlisted": true,
                  "belongsToDomain": true,
                  "email": "<string>",
                  "googleEmailAddress": true,
                  "kind": "<string>",
                  "name": "<string>",
                  "permissionId": "<string>",
                  "role": "<string>",
                  "thumbnailPhotoUrl": "<string>",
                  "type": "<string>",
                  "withLink": true
                }
              ],
              "publishedLink": "<string>",
              "resourceKey": "<string>",
              "revisionId": "<string>"
            },
            "id": "<string>",
            "kind": "<string>",
            "mimeType": "<string>",
            "name": "<string>",
            "oss": {
              "downloadLink": "<string>",
              "kind": "<string>"
            },
            "size": 123,
            "storageType": "OSS"
          }
        ],
        "kind": "<string>"
      },
      "multiple": true,
      "placeholderText": "<string>",
      "rank": 123,
      "readOnly": true,
      "type": "STRING",
      "validation": {
        "audience": {
          "classId": "<string>",
          "className": "<string>",
          "description": "<string>",
          "displayName": "<string>",
          "displayName_i18n": "<string>",
          "thumbnailPictureUrl": "<string>",
          "type": "USER",
          "value": "<string>"
        },
        "errorMessage": "<string>",
        "kind": "<string>",
        "lowerLimit": 123,
        "lowerLimitInclusive": true,
        "mandatoryLeaf": true,
        "regex": "<string>",
        "upperLimit": 123,
        "upperLimitInclusive": true
      },
      "values": [
        "<string>"
      ]
    }
  ],
  "attachments": [
    {
      "autodeskUrn": {
        "status": "READY",
        "urn": "<string>"
      },
      "fileId": "<string>",
      "iconLink": "<string>",
      "kind": "<string>",
      "link": "<string>",
      "mimeType": "<string>",
      "name": "<string>",
      "permissionsOnDrive": [
        {
          "additionalRoles": [
            "<string>"
          ],
          "allowlisted": true,
          "belongsToDomain": true,
          "email": "<string>",
          "googleEmailAddress": true,
          "kind": "<string>",
          "name": "<string>",
          "permissionId": "<string>",
          "role": "<string>",
          "thumbnailPhotoUrl": "<string>",
          "type": "<string>",
          "withLink": true
        }
      ],
      "publishedLink": "<string>",
      "resourceKey": "<string>",
      "revisionId": "<string>",
      "size": 123,
      "storageLocation": "DRIVE"
    }
  ],
  "attachmentsToCopy": [
    {
      "autodeskUrn": {
        "status": "READY",
        "urn": "<string>"
      },
      "fileId": "<string>",
      "iconLink": "<string>",
      "kind": "<string>",
      "link": "<string>",
      "mimeType": "<string>",
      "name": "<string>",
      "permissionsOnDrive": [
        {
          "additionalRoles": [
            "<string>"
          ],
          "allowlisted": true,
          "belongsToDomain": true,
          "email": "<string>",
          "googleEmailAddress": true,
          "kind": "<string>",
          "name": "<string>",
          "permissionId": "<string>",
          "role": "<string>",
          "thumbnailPhotoUrl": "<string>",
          "type": "<string>",
          "withLink": true
        }
      ],
      "publishedLink": "<string>",
      "resourceKey": "<string>",
      "revisionId": "<string>",
      "size": 123,
      "storageLocation": "DRIVE"
    }
  ],
  "categories": [
    {
      "calculatedSettingsInfo": {},
      "calculatedValueInfo": {
        "error": true
      },
      "categoryDefinition": {
        "description": "<string>",
        "dynamicValues": true,
        "folder": true,
        "id": "<string>",
        "kind": "<string>",
        "levelNames": [
          "<string>"
        ],
        "levelNames_i18n": [
          "<string>"
        ],
        "libraryId": "<string>",
        "name": "<string>",
        "tags": true,
        "value": "<string>"
      },
      "definitionId": "<string>",
      "definitionName": "<string>",
      "description": "<string>",
      "description_i18n": "<string>",
      "dynamicValues": true,
      "editable": true,
      "fieldId": "<string>",
      "fieldName": "<string>",
      "fieldName_i18n": "<string>",
      "folder": true,
      "hidden": true,
      "kind": "<string>",
      "levelNames": [
        "<string>"
      ],
      "mandatory": true,
      "multiple": true,
      "placeholderText": "<string>",
      "rank": 123,
      "readOnly": true,
      "type": "STRING",
      "validation": {
        "audience": {
          "classId": "<string>",
          "className": "<string>",
          "description": "<string>",
          "displayName": "<string>",
          "displayName_i18n": "<string>",
          "thumbnailPictureUrl": "<string>",
          "type": "USER",
          "value": "<string>"
        },
        "errorMessage": "<string>",
        "kind": "<string>",
        "lowerLimit": 123,
        "lowerLimitInclusive": true,
        "mandatoryLeaf": true,
        "regex": "<string>",
        "upperLimit": 123,
        "upperLimitInclusive": true
      },
      "values": [
        [
          {
            "ancestors": "<array>",
            "id": "<string>",
            "kind": "<string>",
            "leaf": true,
            "leafInNotOutdatedTree": true,
            "name": "<string>",
            "name_i18n": "<string>",
            "outdated": true,
            "parentId": "<string>",
            "shortName": "<string>",
            "value": "<string>"
          }
        ]
      ]
    }
  ],
  "checkOutBy": "<string>",
  "checkoutDate": "<string>",
  "classId": "<string>",
  "className": "<string>",
  "className_i18n": "<string>",
  "coordinate": "<string>",
  "creationDate": "<string>",
  "deleteAuthor": "<string>",
  "deleted": true,
  "deletedReason": "<string>",
  "deletionDate": "<string>",
  "domainName": "<string>",
  "driveOnlyPermissions": [
    {
      "additionalRoles": [
        "<string>"
      ],
      "allowlisted": true,
      "belongsToDomain": true,
      "email": "<string>",
      "googleEmailAddress": true,
      "kind": "<string>",
      "name": "<string>",
      "permissionId": "<string>",
      "role": "<string>",
      "thumbnailPhotoUrl": "<string>",
      "type": "<string>",
      "withLink": true
    }
  ],
  "editable": true,
  "evaluationError": true,
  "fields": [
    {
      "calculatedSettingsInfo": {},
      "calculatedValueInfo": {
        "error": true
      },
      "description": "<string>",
      "description_i18n": "<string>",
      "editable": true,
      "fieldId": "<string>",
      "fieldName": "<string>",
      "fieldName_i18n": "<string>",
      "hidden": true,
      "kind": "<string>",
      "mandatory": true,
      "metadata": {
        "attachments": [
          {
            "drive": {
              "iconLink": "<string>",
              "kind": "<string>",
              "link": "<string>",
              "permissionsOnDrive": [
                {
                  "additionalRoles": [
                    "<string>"
                  ],
                  "allowlisted": true,
                  "belongsToDomain": true,
                  "email": "<string>",
                  "googleEmailAddress": true,
                  "kind": "<string>",
                  "name": "<string>",
                  "permissionId": "<string>",
                  "role": "<string>",
                  "thumbnailPhotoUrl": "<string>",
                  "type": "<string>",
                  "withLink": true
                }
              ],
              "publishedLink": "<string>",
              "resourceKey": "<string>",
              "revisionId": "<string>"
            },
            "id": "<string>",
            "kind": "<string>",
            "mimeType": "<string>",
            "name": "<string>",
            "oss": {
              "downloadLink": "<string>",
              "kind": "<string>"
            },
            "size": 123,
            "storageType": "OSS"
          }
        ],
        "kind": "<string>"
      },
      "multiple": true,
      "placeholderText": "<string>",
      "rank": 123,
      "readOnly": true,
      "type": "STRING",
      "validation": {
        "audience": {
          "classId": "<string>",
          "className": "<string>",
          "description": "<string>",
          "displayName": "<string>",
          "displayName_i18n": "<string>",
          "thumbnailPictureUrl": "<string>",
          "type": "USER",
          "value": "<string>"
        },
        "errorMessage": "<string>",
        "kind": "<string>",
        "lowerLimit": 123,
        "lowerLimitInclusive": true,
        "mandatoryLeaf": true,
        "regex": "<string>",
        "upperLimit": 123,
        "upperLimitInclusive": true
      },
      "values": [
        "<string>"
      ]
    }
  ],
  "folders": [
    {
      "editable": true,
      "editableDocuments": true,
      "fileId": "<string>",
      "folderAodocsId": "<string>",
      "folderDefinitionId": "<string>",
      "folderIsRoot": true,
      "kind": "<string>",
      "libraryId": "<string>",
      "libraryName": "<string>",
      "name": "<string>",
      "parentFolderAodocsId": "<string>",
      "parentFolderDriveId": "<string>",
      "parentFolderIsRoot": true,
      "permittedOperations": [
        "DELETE"
      ],
      "resourceKey": "<string>",
      "restrictedDownload": true,
      "subfolders": "<array>"
    }
  ],
  "forbiddenOperations": {},
  "fullSizeOfAttachments": 123,
  "iconLink": "<string>",
  "id": "<string>",
  "incomplete": true,
  "initialAuthor": "<string>",
  "invalidValues": true,
  "kind": "<string>",
  "libraryId": "<string>",
  "libraryName": "<string>",
  "modificationDate": "<string>",
  "newPermissions": [
    {
      "additionalRoles": [
        "<string>"
      ],
      "allowlisted": true,
      "belongsToDomain": true,
      "email": "<string>",
      "googleEmailAddress": true,
      "kind": "<string>",
      "name": "<string>",
      "permissionId": "<string>",
      "role": "<string>",
      "thumbnailPhotoUrl": "<string>",
      "type": "<string>",
      "withLink": true
    }
  ],
  "nextVersionName": "<string>",
  "numberOfAttachments": 123,
  "onlyAdminCanChangeAcl": true,
  "onlyAdminCanDelete": true,
  "originalVersionId": "<string>",
  "permissions": [
    {
      "fieldNames": [
        "<string>"
      ],
      "inherited": true,
      "kind": "<string>",
      "name": "<string>",
      "right": "NONE",
      "roleNames": [
        "<string>"
      ],
      "thumbnailPhotoUrl": "<string>",
      "type": "USER",
      "value": "<string>"
    }
  ],
  "permittedOperations": [
    "DELETE"
  ],
  "publishedLink": "<string>",
  "publishedMode": "NONE",
  "referenceCatalogs": [
    {
      "calculatedSettingsInfo": {},
      "calculatedValueInfo": {
        "error": true
      },
      "description": "<string>",
      "description_i18n": "<string>",
      "editable": true,
      "fieldId": "<string>",
      "fieldName": "<string>",
      "fieldName_i18n": "<string>",
      "hidden": true,
      "kind": "<string>",
      "mandatory": true,
      "multiple": true,
      "placeholderText": "<string>",
      "rank": 123,
      "readOnly": true,
      "referenceCatalog": {
        "createdAt": 123,
        "id": "<string>",
        "kind": "<string>",
        "levelNames": [
          "<string>"
        ],
        "modifiedAt": 123,
        "name": "<string>",
        "numberOfValues": 123
      },
      "referenceCatalogId": "<string>",
      "type": "STRING",
      "validation": {
        "audience": {
          "classId": "<string>",
          "className": "<string>",
          "description": "<string>",
          "displayName": "<string>",
          "displayName_i18n": "<string>",
          "thumbnailPictureUrl": "<string>",
          "type": "USER",
          "value": "<string>"
        },
        "errorMessage": "<string>",
        "kind": "<string>",
        "lowerLimit": 123,
        "lowerLimitInclusive": true,
        "mandatoryLeaf": true,
        "regex": "<string>",
        "upperLimit": 123,
        "upperLimitInclusive": true
      },
      "values": [
        {
          "deleted": true,
          "kind": "<string>",
          "leaf": true,
          "name": "<string>",
          "name_i18n": "<string>",
          "parents": "<array>",
          "value": "<string>"
        }
      ]
    }
  ],
  "relatedDocuments": {},
  "restrictedDownload": true,
  "richText": "<string>",
  "sections": [
    {
      "columnCount": 123,
      "description": "<string>",
      "fields": [
        {
          "id": "<string>",
          "type": "<string>"
        }
      ],
      "id": "<string>",
      "name": "<string>",
      "name_i18n": "<string>"
    }
  ],
  "sequenceId": 123,
  "setModifiedDate": true,
  "state": "<string>",
  "stateChangeAuthors": [
    {
      "classId": "<string>",
      "className": "<string>",
      "description": "<string>",
      "displayName": "<string>",
      "displayName_i18n": "<string>",
      "thumbnailPictureUrl": "<string>",
      "type": "USER",
      "value": "<string>"
    }
  ],
  "stateChangeDate": "2023-11-07T05:31:56Z",
  "stateId": "<string>",
  "state_i18n": "<string>",
  "systemFields": [
    {
      "calculatedValueInfo": {
        "error": true
      },
      "displayName": "<string>",
      "editable": true,
      "hidden": true,
      "id": "<string>",
      "kind": "<string>",
      "mandatory": true,
      "readOnly": true,
      "value": "<string>"
    }
  ],
  "tableFields": [
    {
      "calculatedSettingsInfo": {},
      "calculatedValueInfo": {
        "error": true
      },
      "columns": [
        {
          "calculatedSettingsInfo": {},
          "calculatedValueInfo": {
            "error": true
          },
          "categoryDefinition": {
            "description": "<string>",
            "dynamicValues": true,
            "folder": true,
            "id": "<string>",
            "kind": "<string>",
            "levelNames": [
              "<string>"
            ],
            "levelNames_i18n": [
              "<string>"
            ],
            "libraryId": "<string>",
            "name": "<string>",
            "tags": true,
            "value": "<string>"
          },
          "description": "<string>",
          "description_i18n": "<string>",
          "editable": true,
          "fieldId": "<string>",
          "fieldName": "<string>",
          "fieldName_i18n": "<string>",
          "hidden": true,
          "kind": "<string>",
          "mandatory": true,
          "multiple": true,
          "placeholderText": "<string>",
          "rank": 123,
          "readOnly": true,
          "referenceCatalogDefinition": {
            "createdAt": 123,
            "id": "<string>",
            "kind": "<string>",
            "levelNames": [
              "<string>"
            ],
            "modifiedAt": 123,
            "name": "<string>",
            "numberOfValues": 123
          },
          "type": "STRING",
          "validation": {
            "audience": {
              "classId": "<string>",
              "className": "<string>",
              "description": "<string>",
              "displayName": "<string>",
              "displayName_i18n": "<string>",
              "thumbnailPictureUrl": "<string>",
              "type": "USER",
              "value": "<string>"
            },
            "errorMessage": "<string>",
            "kind": "<string>",
            "lowerLimit": 123,
            "lowerLimitInclusive": true,
            "mandatoryLeaf": true,
            "regex": "<string>",
            "upperLimit": 123,
            "upperLimitInclusive": true
          }
        }
      ],
      "description": "<string>",
      "description_i18n": "<string>",
      "editable": true,
      "fieldId": "<string>",
      "fieldName": "<string>",
      "fieldName_i18n": "<string>",
      "hidden": true,
      "kind": "<string>",
      "mandatory": true,
      "multiple": true,
      "placeholderText": "<string>",
      "rank": 123,
      "readOnly": true,
      "type": "STRING",
      "validation": {
        "audience": {
          "classId": "<string>",
          "className": "<string>",
          "description": "<string>",
          "displayName": "<string>",
          "displayName_i18n": "<string>",
          "thumbnailPictureUrl": "<string>",
          "type": "USER",
          "value": "<string>"
        },
        "errorMessage": "<string>",
        "kind": "<string>",
        "lowerLimit": 123,
        "lowerLimitInclusive": true,
        "mandatoryLeaf": true,
        "regex": "<string>",
        "upperLimit": 123,
        "upperLimitInclusive": true
      },
      "values": [
        {
          "categories": {},
          "fields": {},
          "referenceCatalogs": {},
          "rowId": "<string>"
        }
      ]
    }
  ],
  "templateDocumentId": "<string>",
  "title": "<string>",
  "updateAuthor": "<string>",
  "userCanChangeAcl": true,
  "userCanChangeProperties": true,
  "userCanDelete": true,
  "userMapping": {},
  "versionCreated": "2023-11-07T05:31:56Z",
  "versionCreator": "<string>",
  "versionDescription": "<string>",
  "versionId": "<string>",
  "versionLabel": "<string>",
  "versionName": "<string>",
  "versionNumber": "<string>",
  "viewConfiguration": {
    "defaultTabToDisplay": "PROPERTIES",
    "kind": "<string>",
    "orientation": "PORTRAIT",
    "visibleRelations": [
      "<string>"
    ],
    "visibleSections": [
      "INFO"
    ]
  },
  "workflowId": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
documentId
string
required

The ID of the document

Query Parameters

​
securityCode
string

The security code

​
domain
string

The G Suite domain

​
executionOptions
enum<string>[]

To disable custom script executions and workflow email notifications, you can use the following options: SKIP_CUSTOM_SCRIPT_EXECUTIONS, SKIP_WORKFLOW_EMAIL_SENDING.

Available options:
SKIP_WORKFLOW_EMAIL_SENDING,
SKIP_CUSTOM_SCRIPT_EXECUTION,
FAIL_ON_INCOMPLETE

Body

application/json
​
acl
object[]
​
attachmentFields
object[]
​
attachments
object[]

The list of attachments

​
attachmentsToCopy
object[]

The list of attachments to copy (for create/patch)

​
categories
object[]

The list of category fields (only the values are editable)

​
checkOutBy
string

The email of the user who checked-out the document (read-only field)

​
checkoutDate
string

The time at which the document was checked-out (read-only field)

​
classId
string

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

​
className
string

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

​
className_i18n
string

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

​
coordinate
string

The coordinate of the sequence for the document (..[.]) (read-only field)

​
creationDate
string

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

​
deleteAuthor
string

The email of the user who deleted the document (read-only field)

​
deleted
boolean

Whether the document is deleted (read-only field)

​
deletedReason
string

The reason for deleting the document (read-only field)

​
deletionDate
string

The time at which the document was deleted (read-only field)

​
domainName
string

The name of the domain (read-only field)

​
driveOnlyPermissions
object[]

The list of additional permissions configured in Secured Folder libraries

​
editable
boolean

Whether the current user can edit the document (read-only field)

​
evaluationError
boolean

Whether there is an evaluation error on at least one field of the document (read-only field)

​
fields
object[]

The list of native fields (values and metadata are editable)

​
folders
object[]

The location of the document (folder path as list of folders)

​
forbiddenOperations
object

The map of the forbidden operations to the current user and the reasons why they are forbidden (read-only field)

​
fullSizeOfAttachments
integer<int64>

The summed size (in octet) of the attachments (read-only field)

​
iconLink
string

The link to the icon relative to the attachment (read-only field)

​
id
string

The ID of the document (read-only field)

​
incomplete
boolean

Whether there are missing mandatory fields on the document (read-only field)

​
initialAuthor
string

The email of the user who created the document (read-only field)

​
invalidValues
boolean

Whether there are invalid values for fields of the document (read-only field)

​
kind
string
​
libraryId
string

The ID of the library (read-only field)

​
libraryName
string

The name of the library (read-only field)

​
modificationDate
string

The time at which the document was last modified (read-only field after document creation)

​
newPermissions
object[]

The new permissions to apply

​
nextVersionName
string

The next version name (read-only field)

​
numberOfAttachments
integer<int32>

The number of attachments in the document (read-only field)

​
onlyAdminCanChangeAcl
boolean

Whether only administrators can modify the permissions of the document

​
onlyAdminCanDelete
boolean

Whether only administrators can be delete the document

​
originalVersionId
string

Id of the original version if this version was created by restoring a previous version, otherwise null

​
permissions
object[]

The list of permissions relative to the document

​
permittedOperations
enum<string>[]

The list of permitted operations to the current user (read-only field)

Available options:
DELETE,
RENAME,
MODIFY_ACL,
VIEW_ACL,
MOVE_TO_ANOTHER_FOLDER,
EXPORT,
EDIT_PROPERTIES,
COPY,
CREATE_COPY_FROM,
EXPORT_COPY,
CREATE_NEW_VERSION,
ATTACHMENT_VERSION_REPLACE,
ATTACHMENT_VERSION_CREATE,
ADD_NEW_ATTACHMENT_FROM_DRIVE,
ATTACH_ENCRYPTED_FILE,
OPEN_IN_OFFICE,
PUBLISH,
UNPUBLISH,
RESTORE_REVISION,
REVERT_TO_THIS_REVISION,
CREATE_RELATED_DOCUMENT,
DOWNLOAD,
DOWNLOAD_ATTACHMENT,
NOTIFY_USERS,
CHECK_IN,
CHECK_OUT,
DISCARD_CHECKOUT,
FORCE_DISCARD_CHECKOUT,
EDIT_TAGS,
PERFORM_HUMAN_WORKFLOW_ACTIONS,
VIEW_DRAFT,
SHARE_PUBLICLY,
VIEW_HISTORY,
VIEW_VERSIONS,
ADD_COMMENT,
SET_TEMPLATE_AS_DEFAULT,
SET_TEMPLATE_VISIBILITY_SCOPE,
DELETE_COMMENT,
KNOW_DRAFT,
FORCE_PARALLEL_TRANSITION,
CHANGE_WORKFLOW_STATE_DIRECTLY,
SEE_HIDDEN_FIELDS,
VIEW_TRASHED_ITEM,
UNTRASH,
PERMANENTLY_DELETE,
VIEW_DRIVEONLY_ACL,
MODIFY_DRIVEONLY_ACL,
NON_GOOGLE_USERS_SUPPORT,
SUPPORTS_LIVE_EVALUATION,
ALLOWLIST_NOT_ENFORCED,
CREATE_SUBFOLDER,
CREATE_DOCUMENT_IN_THIS_FOLDER,
IMPORT_FOLDERS_FROM_DRIVE_TO_THIS_FOLDER,
ADD_NEW_ATTACHMENT_FROM_OSS,
OPEN_IN_DRIVE,
COPY_FOLDER_TREE,
CHECK_FOLDER,
MOVE_TO_DRIVE,
COPY_TO_DRIVE,
MOVE_TO_ANOTHER_LIBRARY,
MOVE_TO_ANOTHER_CLASS,
COPY_TO_ANOTHER_CLASS,
COPY_ATTACHMENT,
COPY_TO_ANOTHER_LIBRARY,
EDIT_ATTACHMENT
​
publishedLink
string

The link of the publication for mono-attachment documents

​
publishedMode
enum<string>

The publication mode (NONE, DOMAIN, EVERYONE) for mono-attachment documents

Available options:
NONE,
DOMAIN,
EVERYONE
​
referenceCatalogs
object[]

The list of reference catalog fields (only the values are editable)

​
relatedDocuments
object

The map of related documents per relation

​
restrictedDownload
boolean

Whether the flag controlling whether reader users can download, copy or print the document is enabled.

​
richText
string

The description of the document

​
sections
object[]

The sections in which fields are organized (read-only field)

​
sequenceId
integer<int64>

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

​
setModifiedDate
boolean

Whether to set the date of last modification

​
state
string

The name of the workflow state (read-only field)

​
stateChangeAuthors
object[]

The person(s) who were involved in the last workflow state change (read-only field)

​
stateChangeDate
string<date-time>

The date at which the document last changed of workflow state (read-only field)

​
stateId
string

The ID of the workflow state

​
state_i18n
string

The internationalized name of the workflow state (read-only field)

​
systemFields
object[]

The list of system fields (only the values are editable)

​
tableFields
object[]

The list of table fields (only the values are editable)

​
templateDocumentId
string
​
title
string

The title of the document

​
updateAuthor
string

The email of the user who last modified the document (read-only field)

​
userCanChangeAcl
boolean

Whether the current user can modify the permissions (read-only field)

​
userCanChangeProperties
boolean

Whether the current user can modify the properties (read-only field)

​
userCanDelete
boolean

Whether the current user can delete the document (read-only field)

​
userMapping
object

The mapping between user email and user profile (read-only field)

​
versionCreated
string<date-time>

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

​
versionCreator
string

The email of the user who created the version (read-only field)

​
versionDescription
string

The description of the current version of the document

​
versionId
string

The ID of the version (read-only field)

​
versionLabel
string

(Deprecated) The description of the version (replaced by versionDescription)

​
versionName
string

The name of the current version of the document

​
versionNumber
string

(Deprecated) The number of the version (replaced by versionName)

​
viewConfiguration
object
​
workflowId
string

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

Response

200 - application/json

A ApiDocument response

​
acl
object[]
​
attachmentFields
object[]
​
attachments
object[]

The list of attachments

​
attachmentsToCopy
object[]

The list of attachments to copy (for create/patch)

​
categories
object[]

The list of category fields (only the values are editable)

​
checkOutBy
string

The email of the user who checked-out the document (read-only field)

​
checkoutDate
string

The time at which the document was checked-out (read-only field)

​
classId
string

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

​
className
string

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

​
className_i18n
string

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

​
coordinate
string

The coordinate of the sequence for the document (..[.]) (read-only field)

​
creationDate
string

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

​
deleteAuthor
string

The email of the user who deleted the document (read-only field)

​
deleted
boolean

Whether the document is deleted (read-only field)

​
deletedReason
string

The reason for deleting the document (read-only field)

​
deletionDate
string

The time at which the document was deleted (read-only field)

​
domainName
string

The name of the domain (read-only field)

​
driveOnlyPermissions
object[]

The list of additional permissions configured in Secured Folder libraries

​
editable
boolean

Whether the current user can edit the document (read-only field)

​
evaluationError
boolean

Whether there is an evaluation error on at least one field of the document (read-only field)

​
fields
object[]

The list of native fields (values and metadata are editable)

​
folders
object[]

The location of the document (folder path as list of folders)

​
forbiddenOperations
object

The map of the forbidden operations to the current user and the reasons why they are forbidden (read-only field)

​
fullSizeOfAttachments
integer<int64>

The summed size (in octet) of the attachments (read-only field)

​
iconLink
string

The link to the icon relative to the attachment (read-only field)

​
id
string

The ID of the document (read-only field)

​
incomplete
boolean

Whether there are missing mandatory fields on the document (read-only field)

​
initialAuthor
string

The email of the user who created the document (read-only field)

​
invalidValues
boolean

Whether there are invalid values for fields of the document (read-only field)

​
kind
string
​
libraryId
string

The ID of the library (read-only field)

​
libraryName
string

The name of the library (read-only field)

​
modificationDate
string

The time at which the document was last modified (read-only field after document creation)

​
newPermissions
object[]

The new permissions to apply

​
nextVersionName
string

The next version name (read-only field)

​
numberOfAttachments
integer<int32>

The number of attachments in the document (read-only field)

​
onlyAdminCanChangeAcl
boolean

Whether only administrators can modify the permissions of the document

​
onlyAdminCanDelete
boolean

Whether only administrators can be delete the document

​
originalVersionId
string

Id of the original version if this version was created by restoring a previous version, otherwise null

​
permissions
object[]

The list of permissions relative to the document

​
permittedOperations
enum<string>[]

The list of permitted operations to the current user (read-only field)

Available options:
DELETE,
RENAME,
MODIFY_ACL,
VIEW_ACL,
MOVE_TO_ANOTHER_FOLDER,
EXPORT,
EDIT_PROPERTIES,
COPY,
CREATE_COPY_FROM,
EXPORT_COPY,
CREATE_NEW_VERSION,
ATTACHMENT_VERSION_REPLACE,
ATTACHMENT_VERSION_CREATE,
ADD_NEW_ATTACHMENT_FROM_DRIVE,
ATTACH_ENCRYPTED_FILE,
OPEN_IN_OFFICE,
PUBLISH,
UNPUBLISH,
RESTORE_REVISION,
REVERT_TO_THIS_REVISION,
CREATE_RELATED_DOCUMENT,
DOWNLOAD,
DOWNLOAD_ATTACHMENT,
NOTIFY_USERS,
CHECK_IN,
CHECK_OUT,
DISCARD_CHECKOUT,
FORCE_DISCARD_CHECKOUT,
EDIT_TAGS,
PERFORM_HUMAN_WORKFLOW_ACTIONS,
VIEW_DRAFT,
SHARE_PUBLICLY,
VIEW_HISTORY,
VIEW_VERSIONS,
ADD_COMMENT,
SET_TEMPLATE_AS_DEFAULT,
SET_TEMPLATE_VISIBILITY_SCOPE,
DELETE_COMMENT,
KNOW_DRAFT,
FORCE_PARALLEL_TRANSITION,
CHANGE_WORKFLOW_STATE_DIRECTLY,
SEE_HIDDEN_FIELDS,
VIEW_TRASHED_ITEM,
UNTRASH,
PERMANENTLY_DELETE,
VIEW_DRIVEONLY_ACL,
MODIFY_DRIVEONLY_ACL,
NON_GOOGLE_USERS_SUPPORT,
SUPPORTS_LIVE_EVALUATION,
ALLOWLIST_NOT_ENFORCED,
CREATE_SUBFOLDER,
CREATE_DOCUMENT_IN_THIS_FOLDER,
IMPORT_FOLDERS_FROM_DRIVE_TO_THIS_FOLDER,
ADD_NEW_ATTACHMENT_FROM_OSS,
OPEN_IN_DRIVE,
COPY_FOLDER_TREE,
CHECK_FOLDER,
MOVE_TO_DRIVE,
COPY_TO_DRIVE,
MOVE_TO_ANOTHER_LIBRARY,
MOVE_TO_ANOTHER_CLASS,
COPY_TO_ANOTHER_CLASS,
COPY_ATTACHMENT,
COPY_TO_ANOTHER_LIBRARY,
EDIT_ATTACHMENT
​
publishedLink
string

The link of the publication for mono-attachment documents

​
publishedMode
enum<string>

The publication mode (NONE, DOMAIN, EVERYONE) for mono-attachment documents

Available options:
NONE,
DOMAIN,
EVERYONE
​
referenceCatalogs
object[]

The list of reference catalog fields (only the values are editable)

​
relatedDocuments
object

The map of related documents per relation

​
restrictedDownload
boolean

Whether the flag controlling whether reader users can download, copy or print the document is enabled.

​
richText
string

The description of the document

​
sections
object[]

The sections in which fields are organized (read-only field)

​
sequenceId
integer<int64>

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

​
setModifiedDate
boolean

Whether to set the date of last modification

​
state
string

The name of the workflow state (read-only field)

​
stateChangeAuthors
object[]

The person(s) who were involved in the last workflow state change (read-only field)

​
stateChangeDate
string<date-time>

The date at which the document last changed of workflow state (read-only field)

​
stateId
string

The ID of the workflow state

​
state_i18n
string

The internationalized name of the workflow state (read-only field)

​
systemFields
object[]

The list of system fields (only the values are editable)

​
tableFields
object[]

The list of table fields (only the values are editable)

​
templateDocumentId
string
​
title
string

The title of the document

​
updateAuthor
string

The email of the user who last modified the document (read-only field)

​
userCanChangeAcl
boolean

Whether the current user can modify the permissions (read-only field)

​
userCanChangeProperties
boolean

Whether the current user can modify the properties (read-only field)

​
userCanDelete
boolean

Whether the current user can delete the document (read-only field)

​
userMapping
object

The mapping between user email and user profile (read-only field)

​
versionCreated
string<date-time>

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

​
versionCreator
string

The email of the user who created the version (read-only field)

​
versionDescription
string

The description of the current version of the document

​
versionId
string

The ID of the version (read-only field)

​
versionLabel
string

(Deprecated) The description of the version (replaced by versionDescription)

​
versionName
string

The name of the current version of the document

​
versionNumber
string

(Deprecated) The number of the version (replaced by versionName)

​
viewConfiguration
object
​
workflowId
string

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