Skip to main content
POST
/
document
/
v1beta1
/
{documentId}
/
comments
cURL
curl --request POST \
  --url https://aodocs.altirnao.com/api/document/v1beta1/{documentId}/comments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "actionAppliedName": "<string>",
  "actionAppliedName_i18n": "<string>",
  "author": {
    "email": "<string>",
    "kind": "<string>",
    "name": "<string>",
    "nonGoogle": true,
    "thumbnailPictureUrl": "<string>"
  },
  "createdTime": "2023-11-07T05:31:56Z",
  "fromStateName": "<string>",
  "fromStateName_i18n": "<string>",
  "id": "<string>",
  "kind": "<string>",
  "message": "<string>",
  "modifiedTime": "2023-11-07T05:31:56Z",
  "replies": [
    {
      "author": {
        "email": "<string>",
        "kind": "<string>",
        "name": "<string>",
        "nonGoogle": true,
        "thumbnailPictureUrl": "<string>"
      },
      "createdTime": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "kind": "<string>",
      "message": "<string>",
      "modifiedTime": "2023-11-07T05:31:56Z"
    }
  ],
  "toStateName": "<string>",
  "toStateName_i18n": "<string>"
}
'
{
  "actionAppliedName": "<string>",
  "actionAppliedName_i18n": "<string>",
  "author": {
    "email": "<string>",
    "kind": "<string>",
    "name": "<string>",
    "nonGoogle": true,
    "thumbnailPictureUrl": "<string>"
  },
  "createdTime": "2023-11-07T05:31:56Z",
  "fromStateName": "<string>",
  "fromStateName_i18n": "<string>",
  "id": "<string>",
  "kind": "<string>",
  "message": "<string>",
  "modifiedTime": "2023-11-07T05:31:56Z",
  "replies": [
    {
      "author": {
        "email": "<string>",
        "kind": "<string>",
        "name": "<string>",
        "nonGoogle": true,
        "thumbnailPictureUrl": "<string>"
      },
      "createdTime": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "kind": "<string>",
      "message": "<string>",
      "modifiedTime": "2023-11-07T05:31:56Z"
    }
  ],
  "toStateName": "<string>",
  "toStateName_i18n": "<string>"
}

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

Query Parameters

​
domain
string

The G Suite domain

​
securityCode
string

The security code

Body

application/json
​
actionAppliedName
string

The transition action name for comments added on transition (read-only field)

​
actionAppliedName_i18n
string

The transition action internationalized name for comments added on transition (read-only field)

​
author
object
​
createdTime
string<date-time>

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

​
fromStateName
string

The name of the origin state for comments added on transition (read-only field)

​
fromStateName_i18n
string

The internationalized name of the origin state for comments added on transition (read-only field)

​
id
string

The ID of the comment (read-only field)

​
kind
string
​
message
string

The content of the comment (read-only field after creation for now)

​
modifiedTime
string<date-time>

The time at which the comment was last modified (read-only field, for now equals to createdTime)

​
parallelValidationStatus
enum<string>

The status of the parallel transition (PENDING, COMPLETED, CANCELLED) for comments added on transition (read-only field)

Available options:
PENDING,
COMPLETED,
CANCELLED
​
replies
object[]

Not supported for now

​
toStateName
string

The name of the reached state for comments added on transition (read-only field)

​
toStateName_i18n
string

The internationalized name of the reached state for comments added on transition (read-only field)

Response

200 - application/json

A ApiComment response

​
actionAppliedName
string

The transition action name for comments added on transition (read-only field)

​
actionAppliedName_i18n
string

The transition action internationalized name for comments added on transition (read-only field)

​
author
object
​
createdTime
string<date-time>

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

​
fromStateName
string

The name of the origin state for comments added on transition (read-only field)

​
fromStateName_i18n
string

The internationalized name of the origin state for comments added on transition (read-only field)

​
id
string

The ID of the comment (read-only field)

​
kind
string
​
message
string

The content of the comment (read-only field after creation for now)

​
modifiedTime
string<date-time>

The time at which the comment was last modified (read-only field, for now equals to createdTime)

​
parallelValidationStatus
enum<string>

The status of the parallel transition (PENDING, COMPLETED, CANCELLED) for comments added on transition (read-only field)

Available options:
PENDING,
COMPLETED,
CANCELLED
​
replies
object[]

Not supported for now

​
toStateName
string

The name of the reached state for comments added on transition (read-only field)

​
toStateName_i18n
string

The internationalized name of the reached state for comments added on transition (read-only field)