Skip to main content
GET
/
documentType
/
v1
/
libraries
/
{libraryId}
cURL
curl --request GET \
  --url https://aodocs.altirnao.com/api/documentType/v1/libraries/{libraryId} \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "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>"
    }
  ],
  "kind": "<string>"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

libraryId
string
required

The ID of the library

Query Parameters

viewId
string

The ID of the view

securityCode
string

The security code

domain
string

The G Suite domain

include
enum<string>[]

Include additional information in the document class. Available value: TEMPLATES

Available options:
TEMPLATES

Response

200 - application/json

A ApiDocumentTypeList response

items
object[]
kind
string