Skip to main content
PATCH
/
library
/
v1beta1
/
{libraryId}
/
standardActions
/
{standardActionId}
cURL
curl --request PATCH \
  --url https://aodocs.altirnao.com/api/library/v1beta1/{libraryId}/standardActions/{standardActionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "active": true,
  "async": true,
  "documentationUrl": "<string>",
  "executionContext": "RUN_AS_USER",
  "fullDescription": "<string>",
  "id": "<string>",
  "kind": "<string>",
  "name": "<string>",
  "pictureUrl": "<string>",
  "shortDescription": "<string>",
  "type": "RELATION_FILTER"
}
'
{
  "active": true,
  "async": true,
  "documentationUrl": "<string>",
  "executionContext": "RUN_AS_USER",
  "fullDescription": "<string>",
  "id": "<string>",
  "kind": "<string>",
  "name": "<string>",
  "pictureUrl": "<string>",
  "shortDescription": "<string>",
  "type": "RELATION_FILTER"
}

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

​
standardActionId
string
required

Query Parameters

​
domain
string

The G Suite domain

​
securityCode
string

The security code

Body

application/json
​
active
boolean

Whether the standard action has been activated in the library

​
async
boolean

Whether the action will be executed as an asynchronous task (read-only field)

​
documentationUrl
string

The URL to an external technical documentation

​
executionContext
enum<string>

The permission context in which the action will be executed (Possible values: RUN_AS_SYSTEM, RUN_AS_USER) (read-only field)

Available options:
RUN_AS_USER,
RUN_AS_SYSTEM
​
fullDescription
string

A more comprehensive (rich-text) description of the purpose and behaviour of the standard action

​
id
string
​
kind
string
​
name
string

The name of the standard action (read-only field)

​
pictureUrl
string

The URL of the logo for the standard action (expected size is 240x103, with transparent background)

​
shortDescription
string

A terse description of the purpose of the standard action

​
type
enum<string>

The type of the provided action (Possible values: RELATION_FILTER, RELATION_RENDER, UPDATE, VIEWER, WORKFLOW_TRANSITION) (read-only field)

Available options:
RELATION_FILTER,
RELATION_RENDER,
UPDATE,
VIEWER,
WORKFLOW_TRANSITION,
REMINDER_CONDITION

Response

200 - application/json

A ApiStandardAction response

​
active
boolean

Whether the standard action has been activated in the library

​
async
boolean

Whether the action will be executed as an asynchronous task (read-only field)

​
documentationUrl
string

The URL to an external technical documentation

​
executionContext
enum<string>

The permission context in which the action will be executed (Possible values: RUN_AS_SYSTEM, RUN_AS_USER) (read-only field)

Available options:
RUN_AS_USER,
RUN_AS_SYSTEM
​
fullDescription
string

A more comprehensive (rich-text) description of the purpose and behaviour of the standard action

​
id
string
​
kind
string
​
name
string

The name of the standard action (read-only field)

​
pictureUrl
string

The URL of the logo for the standard action (expected size is 240x103, with transparent background)

​
shortDescription
string

A terse description of the purpose of the standard action

​
type
enum<string>

The type of the provided action (Possible values: RELATION_FILTER, RELATION_RENDER, UPDATE, VIEWER, WORKFLOW_TRANSITION) (read-only field)

Available options:
RELATION_FILTER,
RELATION_RENDER,
UPDATE,
VIEWER,
WORKFLOW_TRANSITION,
REMINDER_CONDITION