Skip to main content
PATCH
/
relation
/
v1beta1
/
relationDefinitions
/
{relationDefinitionId}
cURL
curl --request PATCH \
  --url https://aodocs.altirnao.com/api/relation/v1beta1/relationDefinitions/{relationDefinitionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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
}
'
{
  "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.

Path Parameters

​
relationDefinitionId
string
required

The ID of the relation definition

Query Parameters

​
domain
string

The G Suite domain

​
securityCode
string

The security code

Body

application/json
​
createdTime
string<date-time>

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

​
description
string

The description of the relation definition

​
id
string

The ID of the relation definition (read-only field)

​
kind
string
​
lastModifiedTime
string<date-time>

The time at which the relation definition was last modified (read-only field)

​
left
object
​
name
string

The name of the relation definition

​
renderAction
object
​
right
object
​
selfRelated
boolean

Whether this is a self relation (only one side)

Response

200 - application/json

A ApiRelationDefinition response

​
createdTime
string<date-time>

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

​
description
string

The description of the relation definition

​
id
string

The ID of the relation definition (read-only field)

​
kind
string
​
lastModifiedTime
string<date-time>

The time at which the relation definition was last modified (read-only field)

​
left
object
​
name
string

The name of the relation definition

​
renderAction
object
​
right
object
​
selfRelated
boolean

Whether this is a self relation (only one side)