Skip to main content
POST
/
document
/
v1beta1
/
{documentId}
/
viewerActions
/
viewerActions
/
{actionId}
/
execute
cURL
curl --request POST \
  --url https://aodocs.altirnao.com/api/document/v1beta1/{documentId}/viewerActions/viewerActions/{actionId}/execute \
  --header 'Authorization: Bearer <token>'
{
  "actionId": "<string>",
  "copyToClipboardMessage": "<string>",
  "documentId": "<string>",
  "kind": "<string>",
  "messages": [
    {
      "level": "INFO",
      "text": "<string>"
    }
  ],
  "navigate": {
    "documentId": "<string>",
    "libraryId": "<string>",
    "openWindow": {
      "features": "<string>",
      "target": "<string>"
    },
    "url": "<string>",
    "viewId": "<string>"
  },
  "refresh": true
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
documentId
string
required

The ID of the document

​
actionId
string
required

The ID of the viewer action

Query Parameters

​
versionId
string
default:HEAD

The ID of the version. Leave empty to use the default version (equivalent to value 'HEAD'), i.e. the draft if it exists and if the user has access to it (equivalent to value 'DRAFT'), else the main version (equivalent to value 'COMMITTED'). Custom ID of past versions are not supported.

​
securityCode
string

The security code

​
domain
string

The G Suite domain

Response

200 - application/json

A ApiCustomActionFeedback response

​
actionId
string

The executed action ID

​
copyToClipboardMessage
string

Message to be copied to end-user clipboard

​
documentId
string

The document ID against which the action was executed

​
kind
string
​
messages
object[]

Messages to be displayed to end-user

​
navigate
object
​
refresh
boolean

Whether the document page should be refreshed