Skip to main content
POST
/
documentType
/
v1
/
libraries
/
{library}
/
documentTypes
cURL
curl --request POST \
  --url https://aodocs.altirnao.com/api/documentType/v1/libraries/{library}/documentTypes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "appMetadata": {},
  "attachmentCreationModes": {},
  "checkoutMode": "DISABLED",
  "coordinate": "<string>",
  "creators": [
    {
      "displayName": "<string>",
      "kind": "<string>",
      "role": "READER",
      "thumbnailPictureUrl": "<string>",
      "type": "ANYONE",
      "value": "<string>",
      "withLink": true
    }
  ],
  "customActions": [
    {
      "event": "ON_STATE_ENTER_BEFORE_TRANSITION",
      "id": "<string>",
      "kind": "<string>",
      "name": "<string>",
      "params": {},
      "scriptId": "<string>",
      "scriptName": "<string>"
    }
  ],
  "defaultClass": true,
  "defaultTemplateId": "<string>",
  "deleteFields": [
    "<string>"
  ],
  "description": "<string>",
  "displayName": "<string>",
  "displayName_i18n": "<string>",
  "documentCopyDisabled": true,
  "elementsToCopy": {},
  "explicitPermissionMode": "EXPLICIT_PERMISSIONS_ALLOWED",
  "fields": [
    {
      "appMetadata": {},
      "calculatedSettings": {},
      "calculatedValue": {
        "code": "<string>"
      },
      "categoryDefinition": {
        "description": "<string>",
        "dynamicValues": true,
        "folder": true,
        "id": "<string>",
        "kind": "<string>",
        "levelNames": [
          "<string>"
        ],
        "levelNames_i18n": [
          "<string>"
        ],
        "libraryId": "<string>",
        "name": "<string>",
        "tags": true,
        "value": "<string>"
      },
      "categoryId": "<string>",
      "columns": [
        {
          "appMetadata": {},
          "calculatedSettings": {},
          "calculatedValue": {
            "code": "<string>"
          },
          "categoryDefinition": {
            "description": "<string>",
            "dynamicValues": true,
            "folder": true,
            "id": "<string>",
            "kind": "<string>",
            "levelNames": [
              "<string>"
            ],
            "levelNames_i18n": [
              "<string>"
            ],
            "libraryId": "<string>",
            "name": "<string>",
            "tags": true,
            "value": "<string>"
          },
          "categoryId": "<string>",
          "columns": "<unknown>",
          "creationSettings": {
            "hidden": true,
            "mandatory": true,
            "readOnly": true
          },
          "customPlaceholder": true,
          "description": "<string>",
          "displayName": "<string>",
          "dynamicValues": true,
          "folder": true,
          "hidden": true,
          "id": "<string>",
          "kind": "<string>",
          "levelNames": [
            "<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
          }
        }
      ],
      "creationSettings": {
        "hidden": true,
        "mandatory": true,
        "readOnly": true
      },
      "customPlaceholder": true,
      "description": "<string>",
      "displayName": "<string>",
      "dynamicValues": true,
      "folder": true,
      "hidden": true,
      "id": "<string>",
      "kind": "<string>",
      "levelNames": [
        "<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
      }
    }
  ],
  "firstVersionName": "<string>",
  "firstVersionNumberingMode": "AUTOMATIC",
  "forceNumberVersions": true,
  "id": "<string>",
  "kind": "<string>",
  "libraryId": "<string>",
  "managedPermissionSource": "CLASS",
  "manualVersioningDisabled": true,
  "name": "<string>",
  "name_i18n": "<string>",
  "onlyAdminsCanDelete": true,
  "onlyAdminsCanShare": true,
  "permissions": [
    {
      "displayName": "<string>",
      "kind": "<string>",
      "role": "READER",
      "thumbnailPictureUrl": "<string>",
      "type": "ANYONE",
      "value": "<string>",
      "withLink": true
    }
  ],
  "previousVersionsVisibility": {
    "classId": "<string>",
    "className": "<string>",
    "description": "<string>",
    "displayName": "<string>",
    "displayName_i18n": "<string>",
    "thumbnailPictureUrl": "<string>",
    "type": "USER",
    "value": "<string>"
  },
  "readOnlyTitle": true,
  "restrictedDownload": true,
  "sections": [
    {
      "columnCount": 123,
      "description": "<string>",
      "fields": [
        {
          "id": "<string>",
          "type": "<string>"
        }
      ],
      "id": "<string>",
      "name": "<string>",
      "name_i18n": "<string>"
    }
  ],
  "sectionsDefaultColumnCount": 123,
  "sequenceId": 123,
  "systemFields": {},
  "templates": [
    {
      "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"
        }
      ],
      "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>"
              }
            ]
          ]
        }
      ],
      "classId": "<string>",
      "className": "<string>",
      "className_i18n": "<string>",
      "creationDate": "<string>",
      "defaultTemplate": true,
      "domainName": "<string>",
      "editable": 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,
      "hiddenTemplate": true,
      "iconLink": "<string>",
      "id": "<string>",
      "initialAuthor": "<string>",
      "kind": "<string>",
      "libraryId": "<string>",
      "libraryName": "<string>",
      "modificationDate": "<string>",
      "numberOfAttachments": 123,
      "onlyAdminCanChangeAcl": true,
      "onlyAdminCanDelete": true,
      "permittedOperations": [
        "DELETE"
      ],
      "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>"
            }
          ]
        }
      ],
      "requiresUserInput": true,
      "restrictedDownload": true,
      "richText": "<string>",
      "sections": [
        {
          "columnCount": 123,
          "description": "<string>",
          "fields": [
            {
              "id": "<string>",
              "type": "<string>"
            }
          ],
          "id": "<string>",
          "name": "<string>",
          "name_i18n": "<string>"
        }
      ],
      "setModifiedDate": true,
      "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>"
            }
          ]
        }
      ],
      "templateName": "<string>",
      "templateName_i18n": "<string>",
      "title": "<string>",
      "updateAuthor": "<string>",
      "userCanChangeAcl": true,
      "userCanChangeProperties": true,
      "userCanDelete": true,
      "userMapping": {},
      "viewConfiguration": {
        "defaultTabToDisplay": "PROPERTIES",
        "kind": "<string>",
        "orientation": "PORTRAIT",
        "visibleRelations": [
          "<string>"
        ],
        "visibleSections": [
          "INFO"
        ]
      },
      "visibilityToken": {
        "classId": "<string>",
        "className": "<string>",
        "description": "<string>",
        "displayName": "<string>",
        "displayName_i18n": "<string>",
        "thumbnailPictureUrl": "<string>",
        "type": "USER",
        "value": "<string>"
      }
    }
  ],
  "usersCanAccessPreviousVersions": true,
  "value": "<string>",
  "workflowId": "<string>"
}
'
{
  "appMetadata": {},
  "attachmentCreationModes": {},
  "checkoutMode": "DISABLED",
  "coordinate": "<string>",
  "creators": [
    {
      "displayName": "<string>",
      "kind": "<string>",
      "role": "READER",
      "thumbnailPictureUrl": "<string>",
      "type": "ANYONE",
      "value": "<string>",
      "withLink": true
    }
  ],
  "customActions": [
    {
      "event": "ON_STATE_ENTER_BEFORE_TRANSITION",
      "id": "<string>",
      "kind": "<string>",
      "name": "<string>",
      "params": {},
      "scriptId": "<string>",
      "scriptName": "<string>"
    }
  ],
  "defaultClass": true,
  "defaultTemplateId": "<string>",
  "deleteFields": [
    "<string>"
  ],
  "description": "<string>",
  "displayName": "<string>",
  "displayName_i18n": "<string>",
  "documentCopyDisabled": true,
  "elementsToCopy": {},
  "explicitPermissionMode": "EXPLICIT_PERMISSIONS_ALLOWED",
  "fields": [
    {
      "appMetadata": {},
      "calculatedSettings": {},
      "calculatedValue": {
        "code": "<string>"
      },
      "categoryDefinition": {
        "description": "<string>",
        "dynamicValues": true,
        "folder": true,
        "id": "<string>",
        "kind": "<string>",
        "levelNames": [
          "<string>"
        ],
        "levelNames_i18n": [
          "<string>"
        ],
        "libraryId": "<string>",
        "name": "<string>",
        "tags": true,
        "value": "<string>"
      },
      "categoryId": "<string>",
      "columns": [
        {
          "appMetadata": {},
          "calculatedSettings": {},
          "calculatedValue": {
            "code": "<string>"
          },
          "categoryDefinition": {
            "description": "<string>",
            "dynamicValues": true,
            "folder": true,
            "id": "<string>",
            "kind": "<string>",
            "levelNames": [
              "<string>"
            ],
            "levelNames_i18n": [
              "<string>"
            ],
            "libraryId": "<string>",
            "name": "<string>",
            "tags": true,
            "value": "<string>"
          },
          "categoryId": "<string>",
          "columns": "<unknown>",
          "creationSettings": {
            "hidden": true,
            "mandatory": true,
            "readOnly": true
          },
          "customPlaceholder": true,
          "description": "<string>",
          "displayName": "<string>",
          "dynamicValues": true,
          "folder": true,
          "hidden": true,
          "id": "<string>",
          "kind": "<string>",
          "levelNames": [
            "<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
          }
        }
      ],
      "creationSettings": {
        "hidden": true,
        "mandatory": true,
        "readOnly": true
      },
      "customPlaceholder": true,
      "description": "<string>",
      "displayName": "<string>",
      "dynamicValues": true,
      "folder": true,
      "hidden": true,
      "id": "<string>",
      "kind": "<string>",
      "levelNames": [
        "<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
      }
    }
  ],
  "firstVersionName": "<string>",
  "firstVersionNumberingMode": "AUTOMATIC",
  "forceNumberVersions": true,
  "id": "<string>",
  "kind": "<string>",
  "libraryId": "<string>",
  "managedPermissionSource": "CLASS",
  "manualVersioningDisabled": true,
  "name": "<string>",
  "name_i18n": "<string>",
  "onlyAdminsCanDelete": true,
  "onlyAdminsCanShare": true,
  "permissions": [
    {
      "displayName": "<string>",
      "kind": "<string>",
      "role": "READER",
      "thumbnailPictureUrl": "<string>",
      "type": "ANYONE",
      "value": "<string>",
      "withLink": true
    }
  ],
  "previousVersionsVisibility": {
    "classId": "<string>",
    "className": "<string>",
    "description": "<string>",
    "displayName": "<string>",
    "displayName_i18n": "<string>",
    "thumbnailPictureUrl": "<string>",
    "type": "USER",
    "value": "<string>"
  },
  "readOnlyTitle": true,
  "restrictedDownload": true,
  "sections": [
    {
      "columnCount": 123,
      "description": "<string>",
      "fields": [
        {
          "id": "<string>",
          "type": "<string>"
        }
      ],
      "id": "<string>",
      "name": "<string>",
      "name_i18n": "<string>"
    }
  ],
  "sectionsDefaultColumnCount": 123,
  "sequenceId": 123,
  "systemFields": {},
  "templates": [
    {
      "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"
        }
      ],
      "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>"
              }
            ]
          ]
        }
      ],
      "classId": "<string>",
      "className": "<string>",
      "className_i18n": "<string>",
      "creationDate": "<string>",
      "defaultTemplate": true,
      "domainName": "<string>",
      "editable": 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,
      "hiddenTemplate": true,
      "iconLink": "<string>",
      "id": "<string>",
      "initialAuthor": "<string>",
      "kind": "<string>",
      "libraryId": "<string>",
      "libraryName": "<string>",
      "modificationDate": "<string>",
      "numberOfAttachments": 123,
      "onlyAdminCanChangeAcl": true,
      "onlyAdminCanDelete": true,
      "permittedOperations": [
        "DELETE"
      ],
      "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>"
            }
          ]
        }
      ],
      "requiresUserInput": true,
      "restrictedDownload": true,
      "richText": "<string>",
      "sections": [
        {
          "columnCount": 123,
          "description": "<string>",
          "fields": [
            {
              "id": "<string>",
              "type": "<string>"
            }
          ],
          "id": "<string>",
          "name": "<string>",
          "name_i18n": "<string>"
        }
      ],
      "setModifiedDate": true,
      "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>"
            }
          ]
        }
      ],
      "templateName": "<string>",
      "templateName_i18n": "<string>",
      "title": "<string>",
      "updateAuthor": "<string>",
      "userCanChangeAcl": true,
      "userCanChangeProperties": true,
      "userCanDelete": true,
      "userMapping": {},
      "viewConfiguration": {
        "defaultTabToDisplay": "PROPERTIES",
        "kind": "<string>",
        "orientation": "PORTRAIT",
        "visibleRelations": [
          "<string>"
        ],
        "visibleSections": [
          "INFO"
        ]
      },
      "visibilityToken": {
        "classId": "<string>",
        "className": "<string>",
        "description": "<string>",
        "displayName": "<string>",
        "displayName_i18n": "<string>",
        "thumbnailPictureUrl": "<string>",
        "type": "USER",
        "value": "<string>"
      }
    }
  ],
  "usersCanAccessPreviousVersions": true,
  "value": "<string>",
  "workflowId": "<string>"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

library
string
required

The ID of the library

Query Parameters

securityCode
string

The security code

domain
string

The G Suite domain

Body

application/json
appMetadata
object

App Metadata let developers associate metadata with various configuration entities. The metadata is isolated within app namespaces in order to prevent one application from interfering with another's metadata.

attachmentCreationModes
object

The list of supported attachment create modes with there setting (at least one mode should be enabled)

checkoutMode
enum<string>

The mode for check-out use (DISABLED: no check-out possible, OPTIONAL: check-out can be used, MANDATORY: check-out must be used)

Available options:
DISABLED,
OPTIONAL,
MANDATORY
coordinate
string

The coordinate of the document class based on the sequence ID (read-only field)

creators
object[]

The list of users/groups/roles who can create documents of this class (administrators implicitly can and readers implicitly can't)

customActions
object[]

This list of custom actions to be triggered on documents of this class (both viewer and update actions)

defaultClass
boolean

Whether this class is the default document class of the library (read-only field)

defaultTemplateId
string

The ID of the default document template of the document class

deleteFields
string[]

The list of field IDs to delete from the document class (use only during patch)

description
string

The description of the document class

displayName
string

The name of the document class

displayName_i18n
string

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

documentCopyDisabled
boolean

Whether document copying is allowed or not

elementsToCopy
object

User settings determining which attributes to copy when using 'Create From' mode to create a new document.

explicitPermissionMode
enum<string>

The mode for permissions override: EXPLICIT_PERMISSIONS_ALLOWED or EXPLICIT_PERMISSIONS_DISABLED

Available options:
EXPLICIT_PERMISSIONS_ALLOWED,
EXPLICIT_PERMISSIONS_DISABLED
fields
object[]

The list of fields (metadata) configured in the document class

firstVersionName
string

The name of the first version if firstVersionNumberingMode = FIXED

firstVersionNumberingMode
enum<string>

Whether the first version's name should be overridden (FIXED) or implicit (AUTOMATIC)

Available options:
AUTOMATIC,
FIXED
forceNumberVersions
boolean

Whether the version names must be numerical values

id
string

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

kind
string
libraryId
string

The ID of the library in which the document class is (read-only field)

managedPermissionSource
enum<string>

The inheritance mode for permissions: CLASS, WORKFLOW, FOLDER

Available options:
CLASS,
WORKFLOW,
FOLDER
manualVersioningDisabled
boolean

Whether the manual versioning should be disabled for documents of this class

name
string

The display name of the document class (backward compatibility for documentType.documentType.listClasses)

name_i18n
string

The localized display name of the document class (backward compatibility for documentType.documentType.listClasses)

onlyAdminsCanDelete
boolean

Whether only library administrators can delete documents of the class

onlyAdminsCanShare
boolean

Whether only library administrators can share documents of the class

permissions
object[]

The list of users/groups/roles who can access the documents of this class (if managedPermissionSource = CLASS) and their access level

previousVersionsVisibility
object
readOnlyTitle
boolean

DEPRECATED. Use systemFields['_title'].readOnly instead. Whether the title field should be read-only for whole life-cycle of documents of this class (except creation)

restrictedDownload
boolean

Whether the documents of this class should be restricted for download by readers

sections
object[]

The sections of fields for organization

sectionsDefaultColumnCount
integer<int32>

Default column count to apply to sections without a specific columnCount. Defaults to 2

sequenceId
integer<int64>

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

systemFields
object

The list of system fields in the document class (contains only '_title' for now)

templates
object[]

The document templates of this class (read-only, returned only if TEMPLATES is specified within the include request param)

usersCanAccessPreviousVersions
boolean

Whether users can access the previous versions of the documents of this class

value
string

The ID of the document class (backward compatibility for documentType.documentType.listClasses)

workflowId
string

The ID of the workflow in which the document class is (read-only field)

Response

200 - application/json

A ApiDocumentType response

appMetadata
object

App Metadata let developers associate metadata with various configuration entities. The metadata is isolated within app namespaces in order to prevent one application from interfering with another's metadata.

attachmentCreationModes
object

The list of supported attachment create modes with there setting (at least one mode should be enabled)

checkoutMode
enum<string>

The mode for check-out use (DISABLED: no check-out possible, OPTIONAL: check-out can be used, MANDATORY: check-out must be used)

Available options:
DISABLED,
OPTIONAL,
MANDATORY
coordinate
string

The coordinate of the document class based on the sequence ID (read-only field)

creators
object[]

The list of users/groups/roles who can create documents of this class (administrators implicitly can and readers implicitly can't)

customActions
object[]

This list of custom actions to be triggered on documents of this class (both viewer and update actions)

defaultClass
boolean

Whether this class is the default document class of the library (read-only field)

defaultTemplateId
string

The ID of the default document template of the document class

deleteFields
string[]

The list of field IDs to delete from the document class (use only during patch)

description
string

The description of the document class

displayName
string

The name of the document class

displayName_i18n
string

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

documentCopyDisabled
boolean

Whether document copying is allowed or not

elementsToCopy
object

User settings determining which attributes to copy when using 'Create From' mode to create a new document.

explicitPermissionMode
enum<string>

The mode for permissions override: EXPLICIT_PERMISSIONS_ALLOWED or EXPLICIT_PERMISSIONS_DISABLED

Available options:
EXPLICIT_PERMISSIONS_ALLOWED,
EXPLICIT_PERMISSIONS_DISABLED
fields
object[]

The list of fields (metadata) configured in the document class

firstVersionName
string

The name of the first version if firstVersionNumberingMode = FIXED

firstVersionNumberingMode
enum<string>

Whether the first version's name should be overridden (FIXED) or implicit (AUTOMATIC)

Available options:
AUTOMATIC,
FIXED
forceNumberVersions
boolean

Whether the version names must be numerical values

id
string

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

kind
string
libraryId
string

The ID of the library in which the document class is (read-only field)

managedPermissionSource
enum<string>

The inheritance mode for permissions: CLASS, WORKFLOW, FOLDER

Available options:
CLASS,
WORKFLOW,
FOLDER
manualVersioningDisabled
boolean

Whether the manual versioning should be disabled for documents of this class

name
string

The display name of the document class (backward compatibility for documentType.documentType.listClasses)

name_i18n
string

The localized display name of the document class (backward compatibility for documentType.documentType.listClasses)

onlyAdminsCanDelete
boolean

Whether only library administrators can delete documents of the class

onlyAdminsCanShare
boolean

Whether only library administrators can share documents of the class

permissions
object[]

The list of users/groups/roles who can access the documents of this class (if managedPermissionSource = CLASS) and their access level

previousVersionsVisibility
object
readOnlyTitle
boolean

DEPRECATED. Use systemFields['_title'].readOnly instead. Whether the title field should be read-only for whole life-cycle of documents of this class (except creation)

restrictedDownload
boolean

Whether the documents of this class should be restricted for download by readers

sections
object[]

The sections of fields for organization

sectionsDefaultColumnCount
integer<int32>

Default column count to apply to sections without a specific columnCount. Defaults to 2

sequenceId
integer<int64>

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

systemFields
object

The list of system fields in the document class (contains only '_title' for now)

templates
object[]

The document templates of this class (read-only, returned only if TEMPLATES is specified within the include request param)

usersCanAccessPreviousVersions
boolean

Whether users can access the previous versions of the documents of this class

value
string

The ID of the document class (backward compatibility for documentType.documentType.listClasses)

workflowId
string

The ID of the workflow in which the document class is (read-only field)