Skip to main content
GET
/
documentViewConfig
/
v1
/
library
/
{libraryId}
/
documentType
/
{documentTypeId}
cURL
curl --request GET \
  --url https://aodocs.altirnao.com/api/documentViewConfig/v1/library/{libraryId}/documentType/{documentTypeId} \
  --header 'Authorization: Bearer <token>'
{
  "availableRelations": [
    {
      "createdTime": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "id": "<string>",
      "kind": "<string>",
      "lastModifiedTime": "2023-11-07T05:31:56Z",
      "left": {
        "availableFields": [
          {
            "capabilities": [],
            "filterOperators": [],
            "hidden": true,
            "id": "<string>",
            "kind": "<string>",
            "multiple": true,
            "name": "<string>",
            "name_i18n": "<string>",
            "system": true
          }
        ],
        "classId": "<string>",
        "className": "<string>",
        "className_i18n": "<string>",
        "displayFields": [
          {
            "id": "<string>",
            "kind": "<string>",
            "name": "<string>",
            "name_i18n": "<string>",
            "system": true
          }
        ],
        "filterAction": {
          "id": "<string>",
          "kind": "<string>",
          "name": "<string>",
          "params": {},
          "scriptId": "<string>",
          "scriptName": "<string>"
        },
        "libraryId": "<string>",
        "name": "<string>",
        "name_i18n": "<string>",
        "orderBy": {
          "descending": true,
          "id": "<string>",
          "kind": "<string>",
          "name": "<string>",
          "name_i18n": "<string>",
          "system": true
        }
      },
      "name": "<string>",
      "renderAction": {
        "id": "<string>",
        "kind": "<string>",
        "name": "<string>",
        "params": {},
        "scriptId": "<string>",
        "scriptName": "<string>"
      },
      "right": {
        "availableFields": [
          {
            "capabilities": [],
            "filterOperators": [],
            "hidden": true,
            "id": "<string>",
            "kind": "<string>",
            "multiple": true,
            "name": "<string>",
            "name_i18n": "<string>",
            "system": true
          }
        ],
        "classId": "<string>",
        "className": "<string>",
        "className_i18n": "<string>",
        "displayFields": [
          {
            "id": "<string>",
            "kind": "<string>",
            "name": "<string>",
            "name_i18n": "<string>",
            "system": true
          }
        ],
        "filterAction": {
          "id": "<string>",
          "kind": "<string>",
          "name": "<string>",
          "params": {},
          "scriptId": "<string>",
          "scriptName": "<string>"
        },
        "libraryId": "<string>",
        "name": "<string>",
        "name_i18n": "<string>",
        "orderBy": {
          "descending": true,
          "id": "<string>",
          "kind": "<string>",
          "name": "<string>",
          "name_i18n": "<string>",
          "system": true
        }
      },
      "selfRelated": true
    }
  ],
  "kind": "<string>",
  "previousVersionVisibleSections": [],
  "visibleRelations": [
    "<string>"
  ],
  "visibleSections": []
}

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

​
documentTypeId
string
required

The ID of the document class

Query Parameters

​
securityCode
string

The security code

​
domain
string

The G Suite domain

Response

200 - application/json

A ApiTypeLevelViewConfiguration response

​
availableRelations
object[]
​
defaultTabToDisplay
enum<string>
Available options:
PROPERTIES,
FIRST_ATTACHMENT
​
kind
string
​
orientation
enum<string>
Available options:
PORTRAIT,
LANDSCAPE
​
previousVersionVisibleSections
enum<string>[]
Available options:
INFO,
WORKFLOW,
PROPERTIES,
ATTACHMENTS,
RELATIONS,
DESCRIPTION
​
visibleRelations
string[]
​
visibleSections
enum<string>[]
Available options:
INFO,
WORKFLOW,
PROPERTIES,
ATTACHMENTS,
RELATIONS,
DESCRIPTION