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>"
}
'import requests
url = "https://aodocs.altirnao.com/api/document/v1beta1/{documentId}/comments"
payload = {
"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>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>'
})
};
fetch('https://aodocs.altirnao.com/api/document/v1beta1/{documentId}/comments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://aodocs.altirnao.com/api/document/v1beta1/{documentId}/comments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://aodocs.altirnao.com/api/document/v1beta1/{documentId}/comments"
payload := strings.NewReader("{\n \"actionAppliedName\": \"<string>\",\n \"actionAppliedName_i18n\": \"<string>\",\n \"author\": {\n \"email\": \"<string>\",\n \"kind\": \"<string>\",\n \"name\": \"<string>\",\n \"nonGoogle\": true,\n \"thumbnailPictureUrl\": \"<string>\"\n },\n \"createdTime\": \"2023-11-07T05:31:56Z\",\n \"fromStateName\": \"<string>\",\n \"fromStateName_i18n\": \"<string>\",\n \"id\": \"<string>\",\n \"kind\": \"<string>\",\n \"message\": \"<string>\",\n \"modifiedTime\": \"2023-11-07T05:31:56Z\",\n \"replies\": [\n {\n \"author\": {\n \"email\": \"<string>\",\n \"kind\": \"<string>\",\n \"name\": \"<string>\",\n \"nonGoogle\": true,\n \"thumbnailPictureUrl\": \"<string>\"\n },\n \"createdTime\": \"2023-11-07T05:31:56Z\",\n \"id\": \"<string>\",\n \"kind\": \"<string>\",\n \"message\": \"<string>\",\n \"modifiedTime\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"toStateName\": \"<string>\",\n \"toStateName_i18n\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://aodocs.altirnao.com/api/document/v1beta1/{documentId}/comments")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"actionAppliedName\": \"<string>\",\n \"actionAppliedName_i18n\": \"<string>\",\n \"author\": {\n \"email\": \"<string>\",\n \"kind\": \"<string>\",\n \"name\": \"<string>\",\n \"nonGoogle\": true,\n \"thumbnailPictureUrl\": \"<string>\"\n },\n \"createdTime\": \"2023-11-07T05:31:56Z\",\n \"fromStateName\": \"<string>\",\n \"fromStateName_i18n\": \"<string>\",\n \"id\": \"<string>\",\n \"kind\": \"<string>\",\n \"message\": \"<string>\",\n \"modifiedTime\": \"2023-11-07T05:31:56Z\",\n \"replies\": [\n {\n \"author\": {\n \"email\": \"<string>\",\n \"kind\": \"<string>\",\n \"name\": \"<string>\",\n \"nonGoogle\": true,\n \"thumbnailPictureUrl\": \"<string>\"\n },\n \"createdTime\": \"2023-11-07T05:31:56Z\",\n \"id\": \"<string>\",\n \"kind\": \"<string>\",\n \"message\": \"<string>\",\n \"modifiedTime\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"toStateName\": \"<string>\",\n \"toStateName_i18n\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://aodocs.altirnao.com/api/document/v1beta1/{documentId}/comments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"actionAppliedName\": \"<string>\",\n \"actionAppliedName_i18n\": \"<string>\",\n \"author\": {\n \"email\": \"<string>\",\n \"kind\": \"<string>\",\n \"name\": \"<string>\",\n \"nonGoogle\": true,\n \"thumbnailPictureUrl\": \"<string>\"\n },\n \"createdTime\": \"2023-11-07T05:31:56Z\",\n \"fromStateName\": \"<string>\",\n \"fromStateName_i18n\": \"<string>\",\n \"id\": \"<string>\",\n \"kind\": \"<string>\",\n \"message\": \"<string>\",\n \"modifiedTime\": \"2023-11-07T05:31:56Z\",\n \"replies\": [\n {\n \"author\": {\n \"email\": \"<string>\",\n \"kind\": \"<string>\",\n \"name\": \"<string>\",\n \"nonGoogle\": true,\n \"thumbnailPictureUrl\": \"<string>\"\n },\n \"createdTime\": \"2023-11-07T05:31:56Z\",\n \"id\": \"<string>\",\n \"kind\": \"<string>\",\n \"message\": \"<string>\",\n \"modifiedTime\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"toStateName\": \"<string>\",\n \"toStateName_i18n\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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>"
}documentId
Post documentv1beta1 comments
Creates a new comment on a document (outside workflow context)
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>"
}
'import requests
url = "https://aodocs.altirnao.com/api/document/v1beta1/{documentId}/comments"
payload = {
"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>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>'
})
};
fetch('https://aodocs.altirnao.com/api/document/v1beta1/{documentId}/comments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://aodocs.altirnao.com/api/document/v1beta1/{documentId}/comments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://aodocs.altirnao.com/api/document/v1beta1/{documentId}/comments"
payload := strings.NewReader("{\n \"actionAppliedName\": \"<string>\",\n \"actionAppliedName_i18n\": \"<string>\",\n \"author\": {\n \"email\": \"<string>\",\n \"kind\": \"<string>\",\n \"name\": \"<string>\",\n \"nonGoogle\": true,\n \"thumbnailPictureUrl\": \"<string>\"\n },\n \"createdTime\": \"2023-11-07T05:31:56Z\",\n \"fromStateName\": \"<string>\",\n \"fromStateName_i18n\": \"<string>\",\n \"id\": \"<string>\",\n \"kind\": \"<string>\",\n \"message\": \"<string>\",\n \"modifiedTime\": \"2023-11-07T05:31:56Z\",\n \"replies\": [\n {\n \"author\": {\n \"email\": \"<string>\",\n \"kind\": \"<string>\",\n \"name\": \"<string>\",\n \"nonGoogle\": true,\n \"thumbnailPictureUrl\": \"<string>\"\n },\n \"createdTime\": \"2023-11-07T05:31:56Z\",\n \"id\": \"<string>\",\n \"kind\": \"<string>\",\n \"message\": \"<string>\",\n \"modifiedTime\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"toStateName\": \"<string>\",\n \"toStateName_i18n\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://aodocs.altirnao.com/api/document/v1beta1/{documentId}/comments")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"actionAppliedName\": \"<string>\",\n \"actionAppliedName_i18n\": \"<string>\",\n \"author\": {\n \"email\": \"<string>\",\n \"kind\": \"<string>\",\n \"name\": \"<string>\",\n \"nonGoogle\": true,\n \"thumbnailPictureUrl\": \"<string>\"\n },\n \"createdTime\": \"2023-11-07T05:31:56Z\",\n \"fromStateName\": \"<string>\",\n \"fromStateName_i18n\": \"<string>\",\n \"id\": \"<string>\",\n \"kind\": \"<string>\",\n \"message\": \"<string>\",\n \"modifiedTime\": \"2023-11-07T05:31:56Z\",\n \"replies\": [\n {\n \"author\": {\n \"email\": \"<string>\",\n \"kind\": \"<string>\",\n \"name\": \"<string>\",\n \"nonGoogle\": true,\n \"thumbnailPictureUrl\": \"<string>\"\n },\n \"createdTime\": \"2023-11-07T05:31:56Z\",\n \"id\": \"<string>\",\n \"kind\": \"<string>\",\n \"message\": \"<string>\",\n \"modifiedTime\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"toStateName\": \"<string>\",\n \"toStateName_i18n\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://aodocs.altirnao.com/api/document/v1beta1/{documentId}/comments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"actionAppliedName\": \"<string>\",\n \"actionAppliedName_i18n\": \"<string>\",\n \"author\": {\n \"email\": \"<string>\",\n \"kind\": \"<string>\",\n \"name\": \"<string>\",\n \"nonGoogle\": true,\n \"thumbnailPictureUrl\": \"<string>\"\n },\n \"createdTime\": \"2023-11-07T05:31:56Z\",\n \"fromStateName\": \"<string>\",\n \"fromStateName_i18n\": \"<string>\",\n \"id\": \"<string>\",\n \"kind\": \"<string>\",\n \"message\": \"<string>\",\n \"modifiedTime\": \"2023-11-07T05:31:56Z\",\n \"replies\": [\n {\n \"author\": {\n \"email\": \"<string>\",\n \"kind\": \"<string>\",\n \"name\": \"<string>\",\n \"nonGoogle\": true,\n \"thumbnailPictureUrl\": \"<string>\"\n },\n \"createdTime\": \"2023-11-07T05:31:56Z\",\n \"id\": \"<string>\",\n \"kind\": \"<string>\",\n \"message\": \"<string>\",\n \"modifiedTime\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"toStateName\": \"<string>\",\n \"toStateName_i18n\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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
google_id_token-a99f12e0google_id_token_legacy-a99f12e0
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The ID of the document
Body
application/json
The transition action name for comments added on transition (read-only field)
The transition action internationalized name for comments added on transition (read-only field)
Show child attributes
Show child attributes
The time at which the comment was created (read-only field)
The name of the origin state for comments added on transition (read-only field)
The internationalized name of the origin state for comments added on transition (read-only field)
The ID of the comment (read-only field)
The content of the comment (read-only field after creation for now)
The time at which the comment was last modified (read-only field, for now equals to createdTime)
The status of the parallel transition (PENDING, COMPLETED, CANCELLED) for comments added on transition (read-only field)
Available options:
PENDING, COMPLETED, CANCELLED Not supported for now
Show child attributes
Show child attributes
The name of the reached state for comments added on transition (read-only field)
The internationalized name of the reached state for comments added on transition (read-only field)
Response
200 - application/json
A ApiComment response
The transition action name for comments added on transition (read-only field)
The transition action internationalized name for comments added on transition (read-only field)
Show child attributes
Show child attributes
The time at which the comment was created (read-only field)
The name of the origin state for comments added on transition (read-only field)
The internationalized name of the origin state for comments added on transition (read-only field)
The ID of the comment (read-only field)
The content of the comment (read-only field after creation for now)
The time at which the comment was last modified (read-only field, for now equals to createdTime)
The status of the parallel transition (PENDING, COMPLETED, CANCELLED) for comments added on transition (read-only field)
Available options:
PENDING, COMPLETED, CANCELLED Not supported for now
Show child attributes
Show child attributes
The name of the reached state for comments added on transition (read-only field)
The internationalized name of the reached state for comments added on transition (read-only field)
⌘I