Skip to main content
GET
/
relation
/
v1beta1
/
relationDefinitions
cURL
curl --request GET \
  --url https://aodocs.altirnao.com/api/relation/v1beta1/relationDefinitions \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "kind": "<string>",
  "nextPageToken": "<string>",
  "relationDefinitions": [
    {
      "createdTime": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "id": "<string>",
      "kind": "<string>",
      "lastModifiedTime": "2023-11-07T05:31:56Z",
      "left": {
        "availableFields": [
          {
            "capabilities": [
              "DISPLAY"
            ],
            "filterOperators": [
              "EQUAL"
            ],
            "hidden": true,
            "id": "<string>",
            "kind": "<string>",
            "multiple": true,
            "name": "<string>",
            "name_i18n": "<string>",
            "system": true,
            "type": "STRING"
          }
        ],
        "classId": "<string>",
        "className": "<string>",
        "className_i18n": "<string>",
        "displayBefore": "INFO",
        "displayFields": [
          {
            "id": "<string>",
            "kind": "<string>",
            "name": "<string>",
            "name_i18n": "<string>",
            "system": true
          }
        ],
        "filterAction": {
          "event": "ON_STATE_ENTER_BEFORE_TRANSITION",
          "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": {
        "event": "ON_STATE_ENTER_BEFORE_TRANSITION",
        "id": "<string>",
        "kind": "<string>",
        "name": "<string>",
        "params": {},
        "scriptId": "<string>",
        "scriptName": "<string>"
      },
      "right": {
        "availableFields": [
          {
            "capabilities": [
              "DISPLAY"
            ],
            "filterOperators": [
              "EQUAL"
            ],
            "hidden": true,
            "id": "<string>",
            "kind": "<string>",
            "multiple": true,
            "name": "<string>",
            "name_i18n": "<string>",
            "system": true,
            "type": "STRING"
          }
        ],
        "classId": "<string>",
        "className": "<string>",
        "className_i18n": "<string>",
        "displayBefore": "INFO",
        "displayFields": [
          {
            "id": "<string>",
            "kind": "<string>",
            "name": "<string>",
            "name_i18n": "<string>",
            "system": true
          }
        ],
        "filterAction": {
          "event": "ON_STATE_ENTER_BEFORE_TRANSITION",
          "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
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
libraryId
string
required

The ID of the library

​
classId
string

The ID of the document class

​
side
enum<string>

The side of the relation definition

Available options:
LEFT,
RIGHT
​
limit
integer<int32>
default:50

The maximum number of relation definitions per page. (Default: 50)

​
nextPageToken
string

DEPRECATED. Use pageToken instead.

​
pageToken
string

The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.

​
domain
string

The G Suite domain

​
securityCode
string

The security code

Response

200 - application/json

A ApiRelationDefinitionList response

​
count
integer<int32>
​
kind
string
​
nextPageToken
string
​
relationDefinitions
object[]