cURL
curl --request GET \
--url https://aodocs.altirnao.com/api/relation/v1/relations/{relationId}/side/{side}/templates/{templateId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://aodocs.altirnao.com/api/relation/v1/relations/{relationId}/side/{side}/templates/{templateId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://aodocs.altirnao.com/api/relation/v1/relations/{relationId}/side/{side}/templates/{templateId}', 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/relation/v1/relations/{relationId}/side/{side}/templates/{templateId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://aodocs.altirnao.com/api/relation/v1/relations/{relationId}/side/{side}/templates/{templateId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://aodocs.altirnao.com/api/relation/v1/relations/{relationId}/side/{side}/templates/{templateId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://aodocs.altirnao.com/api/relation/v1/relations/{relationId}/side/{side}/templates/{templateId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"documents": [
{
"acl": [
{
"allow": [
"<string>"
],
"for": [
"<string>"
],
"kind": "<string>"
}
],
"attachmentFields": [
{
"calculatedSettingsInfo": {},
"calculatedValueInfo": {
"error": true
},
"description": "<string>",
"description_i18n": "<string>",
"editable": true,
"fieldId": "<string>",
"fieldMetadata": {},
"fieldName": "<string>",
"fieldName_i18n": "<string>",
"hidden": true,
"kind": "<string>",
"lookupConfiguration": {
"sourceConfiguration": {
"displaySearchProperties": [
"<string>"
],
"scope": {
"id": "<string>",
"type": "CLASS"
},
"type": "DOCUMENT"
},
"targetConfiguration": {
"lookupKey": "<string>",
"sourceFieldId": "<string>",
"sourceFieldName": "<string>"
}
},
"lookupValueInfo": {
"displayName": "<string>",
"error": true,
"errorMessage": "<string>"
},
"mandatory": true,
"metadata": {
"attachments": [
{
"drive": {
"iconLink": "<string>",
"kind": "<string>",
"link": "<string>",
"permissionsOnDrive": [
{
"additionalRoles": [
"<string>"
],
"allowlisted": true,
"belongsToDomain": true,
"email": "<string>",
"googleEmailAddress": true,
"kind": "<string>",
"name": "<string>",
"permissionId": "<string>",
"role": "<string>",
"thumbnailPhotoUrl": "<string>",
"type": "<string>",
"withLink": true
}
],
"publishedLink": "<string>",
"resourceKey": "<string>",
"revisionId": "<string>"
},
"id": "<string>",
"kind": "<string>",
"mimeType": "<string>",
"name": "<string>",
"oss": {
"downloadLink": "<string>",
"kind": "<string>"
},
"size": 123
}
],
"kind": "<string>"
},
"multiple": true,
"placeholderText": "<string>",
"rank": 123,
"readOnly": true,
"validation": {
"audience": {
"classId": "<string>",
"className": "<string>",
"description": "<string>",
"displayName": "<string>",
"displayName_i18n": "<string>",
"thumbnailPictureUrl": "<string>",
"value": "<string>"
},
"errorMessage": "<string>",
"kind": "<string>",
"lowerLimit": 123,
"lowerLimitInclusive": true,
"mandatoryLeaf": true,
"regex": "<string>",
"upperLimit": 123,
"upperLimitInclusive": true
},
"values": [
"<string>"
]
}
],
"attachments": [
{
"autodeskUrn": {
"urn": "<string>"
},
"fileId": "<string>",
"iconLink": "<string>",
"kind": "<string>",
"link": "<string>",
"md5Checksum": "<string>",
"mimeType": "<string>",
"name": "<string>",
"permissionsOnDrive": [
{
"additionalRoles": [
"<string>"
],
"allowlisted": true,
"belongsToDomain": true,
"email": "<string>",
"googleEmailAddress": true,
"kind": "<string>",
"name": "<string>",
"permissionId": "<string>",
"role": "<string>",
"thumbnailPhotoUrl": "<string>",
"type": "<string>",
"withLink": true
}
],
"publishedLink": "<string>",
"resourceKey": "<string>",
"revisionId": "<string>",
"size": 123
}
],
"attachmentsToCopy": [
{
"autodeskUrn": {
"urn": "<string>"
},
"fileId": "<string>",
"iconLink": "<string>",
"kind": "<string>",
"link": "<string>",
"md5Checksum": "<string>",
"mimeType": "<string>",
"name": "<string>",
"permissionsOnDrive": [
{
"additionalRoles": [
"<string>"
],
"allowlisted": true,
"belongsToDomain": true,
"email": "<string>",
"googleEmailAddress": true,
"kind": "<string>",
"name": "<string>",
"permissionId": "<string>",
"role": "<string>",
"thumbnailPhotoUrl": "<string>",
"type": "<string>",
"withLink": true
}
],
"publishedLink": "<string>",
"resourceKey": "<string>",
"revisionId": "<string>",
"size": 123
}
],
"categories": [
{
"calculatedSettingsInfo": {},
"calculatedValueInfo": {
"error": true
},
"categoryDefinition": {
"description": "<string>",
"dynamicValues": true,
"folder": true,
"id": "<string>",
"kind": "<string>",
"levelNames": [
"<string>"
],
"levelNames_i18n": [
"<string>"
],
"libraryId": "<string>",
"name": "<string>",
"tags": true,
"value": "<string>"
},
"categoryValueMapping": {
"displayName": "<string>",
"id": "<string>"
},
"definitionId": "<string>",
"definitionName": "<string>",
"description": "<string>",
"description_i18n": "<string>",
"dynamicValues": true,
"editable": true,
"fieldId": "<string>",
"fieldMetadata": {},
"fieldName": "<string>",
"fieldName_i18n": "<string>",
"folder": true,
"hidden": true,
"kind": "<string>",
"levelNames": [
"<string>"
],
"lookupConfiguration": {
"sourceConfiguration": {
"displaySearchProperties": [
"<string>"
],
"scope": {
"id": "<string>",
"type": "CLASS"
},
"type": "DOCUMENT"
},
"targetConfiguration": {
"lookupKey": "<string>",
"sourceFieldId": "<string>",
"sourceFieldName": "<string>"
}
},
"lookupValueInfo": {
"displayName": "<string>",
"error": true,
"errorMessage": "<string>"
},
"mandatory": true,
"mappingSourceField": {
"displayName": "<string>",
"id": "<string>"
},
"multiple": true,
"placeholderText": "<string>",
"rank": 123,
"readOnly": true,
"validation": {
"audience": {
"classId": "<string>",
"className": "<string>",
"description": "<string>",
"displayName": "<string>",
"displayName_i18n": "<string>",
"thumbnailPictureUrl": "<string>",
"value": "<string>"
},
"errorMessage": "<string>",
"kind": "<string>",
"lowerLimit": 123,
"lowerLimitInclusive": true,
"mandatoryLeaf": true,
"regex": "<string>",
"upperLimit": 123,
"upperLimitInclusive": true
},
"values": [
[
{
"ancestors": "<array>",
"id": "<string>",
"kind": "<string>",
"leaf": true,
"leafInNotOutdatedTree": true,
"name": "<string>",
"name_i18n": "<string>",
"outdated": true,
"parentId": "<string>",
"shortName": "<string>",
"value": "<string>"
}
]
]
}
],
"checkOutBy": "<string>",
"checkoutDate": "<string>",
"classId": "<string>",
"className": "<string>",
"className_i18n": "<string>",
"coordinate": "<string>",
"creationDate": "<string>",
"deleteAuthor": "<string>",
"deleted": true,
"deletedReason": "<string>",
"deletionDate": "<string>",
"domainName": "<string>",
"driveOnlyPermissions": [
{
"additionalRoles": [
"<string>"
],
"allowlisted": true,
"belongsToDomain": true,
"email": "<string>",
"googleEmailAddress": true,
"kind": "<string>",
"name": "<string>",
"permissionId": "<string>",
"role": "<string>",
"thumbnailPhotoUrl": "<string>",
"type": "<string>",
"withLink": true
}
],
"editable": true,
"evaluationError": true,
"externalSource": {
"displayName": "<string>",
"url": "<string>"
},
"fields": [
{
"calculatedSettingsInfo": {},
"calculatedValueInfo": {
"error": true
},
"description": "<string>",
"description_i18n": "<string>",
"editable": true,
"fieldId": "<string>",
"fieldMetadata": {},
"fieldName": "<string>",
"fieldName_i18n": "<string>",
"hidden": true,
"kind": "<string>",
"lookupConfiguration": {
"sourceConfiguration": {
"displaySearchProperties": [
"<string>"
],
"scope": {
"id": "<string>",
"type": "CLASS"
},
"type": "DOCUMENT"
},
"targetConfiguration": {
"lookupKey": "<string>",
"sourceFieldId": "<string>",
"sourceFieldName": "<string>"
}
},
"lookupValueInfo": {
"displayName": "<string>",
"error": true,
"errorMessage": "<string>"
},
"mandatory": true,
"metadata": {
"attachments": [
{
"drive": {
"iconLink": "<string>",
"kind": "<string>",
"link": "<string>",
"permissionsOnDrive": [
{
"additionalRoles": [
"<string>"
],
"allowlisted": true,
"belongsToDomain": true,
"email": "<string>",
"googleEmailAddress": true,
"kind": "<string>",
"name": "<string>",
"permissionId": "<string>",
"role": "<string>",
"thumbnailPhotoUrl": "<string>",
"type": "<string>",
"withLink": true
}
],
"publishedLink": "<string>",
"resourceKey": "<string>",
"revisionId": "<string>"
},
"id": "<string>",
"kind": "<string>",
"mimeType": "<string>",
"name": "<string>",
"oss": {
"downloadLink": "<string>",
"kind": "<string>"
},
"size": 123
}
],
"kind": "<string>"
},
"multiple": true,
"placeholderText": "<string>",
"rank": 123,
"readOnly": true,
"validation": {
"audience": {
"classId": "<string>",
"className": "<string>",
"description": "<string>",
"displayName": "<string>",
"displayName_i18n": "<string>",
"thumbnailPictureUrl": "<string>",
"value": "<string>"
},
"errorMessage": "<string>",
"kind": "<string>",
"lowerLimit": 123,
"lowerLimitInclusive": true,
"mandatoryLeaf": true,
"regex": "<string>",
"upperLimit": 123,
"upperLimitInclusive": true
},
"values": [
"<string>"
]
}
],
"folders": [
{
"editable": true,
"editableDocuments": true,
"fileId": "<string>",
"folderAodocsId": "<string>",
"folderDefinitionId": "<string>",
"folderIsRoot": true,
"kind": "<string>",
"libraryId": "<string>",
"libraryName": "<string>",
"name": "<string>",
"parentFolderAodocsId": "<string>",
"parentFolderDriveId": "<string>",
"parentFolderIsRoot": true,
"permittedOperations": [],
"resourceKey": "<string>",
"restrictedDownload": true,
"subfolders": "<array>"
}
],
"forbiddenOperations": {},
"fullSizeOfAttachments": 123,
"iconLink": "<string>",
"id": "<string>",
"incomplete": true,
"initialAuthor": "<string>",
"invalidValues": true,
"kind": "<string>",
"libraryId": "<string>",
"libraryName": "<string>",
"modificationDate": "<string>",
"newPermissions": [
{
"additionalRoles": [
"<string>"
],
"allowlisted": true,
"belongsToDomain": true,
"email": "<string>",
"googleEmailAddress": true,
"kind": "<string>",
"name": "<string>",
"permissionId": "<string>",
"role": "<string>",
"thumbnailPhotoUrl": "<string>",
"type": "<string>",
"withLink": true
}
],
"nextVersionName": "<string>",
"numberOfAttachments": 123,
"onlyAdminCanChangeAcl": true,
"onlyAdminCanDelete": true,
"originalVersionId": "<string>",
"permissions": [
{
"fieldNames": [
"<string>"
],
"inherited": true,
"kind": "<string>",
"name": "<string>",
"roleNames": [
"<string>"
],
"thumbnailPhotoUrl": "<string>",
"value": "<string>"
}
],
"permittedOperations": [],
"publishedLink": "<string>",
"referenceCatalogs": [
{
"calculatedSettingsInfo": {},
"calculatedValueInfo": {
"error": true
},
"description": "<string>",
"description_i18n": "<string>",
"editable": true,
"fieldId": "<string>",
"fieldMetadata": {},
"fieldName": "<string>",
"fieldName_i18n": "<string>",
"hidden": true,
"kind": "<string>",
"lookupConfiguration": {
"sourceConfiguration": {
"displaySearchProperties": [
"<string>"
],
"scope": {
"id": "<string>",
"type": "CLASS"
},
"type": "DOCUMENT"
},
"targetConfiguration": {
"lookupKey": "<string>",
"sourceFieldId": "<string>",
"sourceFieldName": "<string>"
}
},
"lookupValueInfo": {
"displayName": "<string>",
"error": true,
"errorMessage": "<string>"
},
"mandatory": true,
"multiple": true,
"placeholderText": "<string>",
"rank": 123,
"readOnly": true,
"referenceCatalog": {
"createdAt": 123,
"id": "<string>",
"kind": "<string>",
"levelNames": [
"<string>"
],
"modifiedAt": 123,
"name": "<string>",
"numberOfValues": 123
},
"referenceCatalogId": "<string>",
"validation": {
"audience": {
"classId": "<string>",
"className": "<string>",
"description": "<string>",
"displayName": "<string>",
"displayName_i18n": "<string>",
"thumbnailPictureUrl": "<string>",
"value": "<string>"
},
"errorMessage": "<string>",
"kind": "<string>",
"lowerLimit": 123,
"lowerLimitInclusive": true,
"mandatoryLeaf": true,
"regex": "<string>",
"upperLimit": 123,
"upperLimitInclusive": true
},
"values": [
{
"deleted": true,
"kind": "<string>",
"leaf": true,
"name": "<string>",
"name_i18n": "<string>",
"parents": "<array>",
"value": "<string>"
}
]
}
],
"relatedDocuments": {},
"restrictedDownload": true,
"richText": "<string>",
"sections": [
{
"columnCount": 123,
"description": "<string>",
"fields": [
{
"id": "<string>",
"type": "<string>"
}
],
"id": "<string>",
"name": "<string>",
"name_i18n": "<string>"
}
],
"sequenceId": 123,
"setModifiedDate": true,
"similarDocuments": [
{
"absoluteDuplicatesOnly": true,
"attachmentId": "<string>",
"attachmentLink": "<string>",
"attachmentMimeType": "<string>",
"attachmentName": "<string>",
"documentId": "<string>",
"documentLink": "<string>",
"documentTitle": "<string>",
"libraryId": "<string>",
"locationInfo": "<string>",
"locationType": "<string>",
"quotedText": "<string>",
"similarityScore": 123
}
],
"state": "<string>",
"stateChangeAuthors": [
{
"classId": "<string>",
"className": "<string>",
"description": "<string>",
"displayName": "<string>",
"displayName_i18n": "<string>",
"thumbnailPictureUrl": "<string>",
"value": "<string>"
}
],
"stateChangeDate": "2023-11-07T05:31:56Z",
"stateId": "<string>",
"state_i18n": "<string>",
"systemFields": [
{
"calculatedValueInfo": {
"error": true
},
"displayName": "<string>",
"editable": true,
"hidden": true,
"id": "<string>",
"kind": "<string>",
"mandatory": true,
"readOnly": true,
"value": "<string>"
}
],
"tableFields": [
{
"calculatedSettingsInfo": {},
"calculatedValueInfo": {
"error": true
},
"columns": [
{
"calculatedSettingsInfo": {},
"calculatedValueInfo": {
"error": true
},
"categoryDefinition": {
"description": "<string>",
"dynamicValues": true,
"folder": true,
"id": "<string>",
"kind": "<string>",
"levelNames": [
"<string>"
],
"levelNames_i18n": [
"<string>"
],
"libraryId": "<string>",
"name": "<string>",
"tags": true,
"value": "<string>"
},
"description": "<string>",
"description_i18n": "<string>",
"editable": true,
"fieldId": "<string>",
"fieldMetadata": {},
"fieldName": "<string>",
"fieldName_i18n": "<string>",
"hidden": true,
"kind": "<string>",
"lookupConfiguration": {
"sourceConfiguration": {
"displaySearchProperties": [
"<string>"
],
"scope": {
"id": "<string>",
"type": "CLASS"
},
"type": "DOCUMENT"
},
"targetConfiguration": {
"lookupKey": "<string>",
"sourceFieldId": "<string>",
"sourceFieldName": "<string>"
}
},
"lookupValueInfo": {
"displayName": "<string>",
"error": true,
"errorMessage": "<string>"
},
"mandatory": true,
"multiple": true,
"placeholderText": "<string>",
"rank": 123,
"readOnly": true,
"referenceCatalogDefinition": {
"createdAt": 123,
"id": "<string>",
"kind": "<string>",
"levelNames": [
"<string>"
],
"modifiedAt": 123,
"name": "<string>",
"numberOfValues": 123
},
"validation": {
"audience": {
"classId": "<string>",
"className": "<string>",
"description": "<string>",
"displayName": "<string>",
"displayName_i18n": "<string>",
"thumbnailPictureUrl": "<string>",
"value": "<string>"
},
"errorMessage": "<string>",
"kind": "<string>",
"lowerLimit": 123,
"lowerLimitInclusive": true,
"mandatoryLeaf": true,
"regex": "<string>",
"upperLimit": 123,
"upperLimitInclusive": true
}
}
],
"description": "<string>",
"description_i18n": "<string>",
"editable": true,
"fieldId": "<string>",
"fieldMetadata": {},
"fieldName": "<string>",
"fieldName_i18n": "<string>",
"hidden": true,
"kind": "<string>",
"lookupConfiguration": {
"sourceConfiguration": {
"displaySearchProperties": [
"<string>"
],
"scope": {
"id": "<string>",
"type": "CLASS"
},
"type": "DOCUMENT"
},
"targetConfiguration": {
"lookupKey": "<string>",
"sourceFieldId": "<string>",
"sourceFieldName": "<string>"
}
},
"lookupValueInfo": {
"displayName": "<string>",
"error": true,
"errorMessage": "<string>"
},
"mandatory": true,
"multiple": true,
"placeholderText": "<string>",
"rank": 123,
"readOnly": true,
"validation": {
"audience": {
"classId": "<string>",
"className": "<string>",
"description": "<string>",
"displayName": "<string>",
"displayName_i18n": "<string>",
"thumbnailPictureUrl": "<string>",
"value": "<string>"
},
"errorMessage": "<string>",
"kind": "<string>",
"lowerLimit": 123,
"lowerLimitInclusive": true,
"mandatoryLeaf": true,
"regex": "<string>",
"upperLimit": 123,
"upperLimitInclusive": true
},
"values": [
{
"categories": {},
"fields": {},
"referenceCatalogs": {},
"rowId": "<string>"
}
]
}
],
"templateDocumentId": "<string>",
"title": "<string>",
"updateAuthor": "<string>",
"userCanChangeAcl": true,
"userCanChangeProperties": true,
"userCanDelete": true,
"userMapping": {},
"versionCreated": "2023-11-07T05:31:56Z",
"versionCreator": "<string>",
"versionDescription": "<string>",
"versionId": "<string>",
"versionLabel": "<string>",
"versionName": "<string>",
"versionNumber": "<string>",
"viewConfiguration": {
"kind": "<string>",
"visibleRelations": [
"<string>"
],
"visibleSections": []
},
"workflowId": "<string>"
}
],
"kind": "<string>"
}relation
Get relationv1relations side templates
Lists all documents that can be added to a template’s relation configuration for a given relation/side.
GET
/
relation
/
v1
/
relations
/
{relationId}
/
side
/
{side}
/
templates
/
{templateId}
cURL
curl --request GET \
--url https://aodocs.altirnao.com/api/relation/v1/relations/{relationId}/side/{side}/templates/{templateId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://aodocs.altirnao.com/api/relation/v1/relations/{relationId}/side/{side}/templates/{templateId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://aodocs.altirnao.com/api/relation/v1/relations/{relationId}/side/{side}/templates/{templateId}', 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/relation/v1/relations/{relationId}/side/{side}/templates/{templateId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://aodocs.altirnao.com/api/relation/v1/relations/{relationId}/side/{side}/templates/{templateId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://aodocs.altirnao.com/api/relation/v1/relations/{relationId}/side/{side}/templates/{templateId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://aodocs.altirnao.com/api/relation/v1/relations/{relationId}/side/{side}/templates/{templateId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"documents": [
{
"acl": [
{
"allow": [
"<string>"
],
"for": [
"<string>"
],
"kind": "<string>"
}
],
"attachmentFields": [
{
"calculatedSettingsInfo": {},
"calculatedValueInfo": {
"error": true
},
"description": "<string>",
"description_i18n": "<string>",
"editable": true,
"fieldId": "<string>",
"fieldMetadata": {},
"fieldName": "<string>",
"fieldName_i18n": "<string>",
"hidden": true,
"kind": "<string>",
"lookupConfiguration": {
"sourceConfiguration": {
"displaySearchProperties": [
"<string>"
],
"scope": {
"id": "<string>",
"type": "CLASS"
},
"type": "DOCUMENT"
},
"targetConfiguration": {
"lookupKey": "<string>",
"sourceFieldId": "<string>",
"sourceFieldName": "<string>"
}
},
"lookupValueInfo": {
"displayName": "<string>",
"error": true,
"errorMessage": "<string>"
},
"mandatory": true,
"metadata": {
"attachments": [
{
"drive": {
"iconLink": "<string>",
"kind": "<string>",
"link": "<string>",
"permissionsOnDrive": [
{
"additionalRoles": [
"<string>"
],
"allowlisted": true,
"belongsToDomain": true,
"email": "<string>",
"googleEmailAddress": true,
"kind": "<string>",
"name": "<string>",
"permissionId": "<string>",
"role": "<string>",
"thumbnailPhotoUrl": "<string>",
"type": "<string>",
"withLink": true
}
],
"publishedLink": "<string>",
"resourceKey": "<string>",
"revisionId": "<string>"
},
"id": "<string>",
"kind": "<string>",
"mimeType": "<string>",
"name": "<string>",
"oss": {
"downloadLink": "<string>",
"kind": "<string>"
},
"size": 123
}
],
"kind": "<string>"
},
"multiple": true,
"placeholderText": "<string>",
"rank": 123,
"readOnly": true,
"validation": {
"audience": {
"classId": "<string>",
"className": "<string>",
"description": "<string>",
"displayName": "<string>",
"displayName_i18n": "<string>",
"thumbnailPictureUrl": "<string>",
"value": "<string>"
},
"errorMessage": "<string>",
"kind": "<string>",
"lowerLimit": 123,
"lowerLimitInclusive": true,
"mandatoryLeaf": true,
"regex": "<string>",
"upperLimit": 123,
"upperLimitInclusive": true
},
"values": [
"<string>"
]
}
],
"attachments": [
{
"autodeskUrn": {
"urn": "<string>"
},
"fileId": "<string>",
"iconLink": "<string>",
"kind": "<string>",
"link": "<string>",
"md5Checksum": "<string>",
"mimeType": "<string>",
"name": "<string>",
"permissionsOnDrive": [
{
"additionalRoles": [
"<string>"
],
"allowlisted": true,
"belongsToDomain": true,
"email": "<string>",
"googleEmailAddress": true,
"kind": "<string>",
"name": "<string>",
"permissionId": "<string>",
"role": "<string>",
"thumbnailPhotoUrl": "<string>",
"type": "<string>",
"withLink": true
}
],
"publishedLink": "<string>",
"resourceKey": "<string>",
"revisionId": "<string>",
"size": 123
}
],
"attachmentsToCopy": [
{
"autodeskUrn": {
"urn": "<string>"
},
"fileId": "<string>",
"iconLink": "<string>",
"kind": "<string>",
"link": "<string>",
"md5Checksum": "<string>",
"mimeType": "<string>",
"name": "<string>",
"permissionsOnDrive": [
{
"additionalRoles": [
"<string>"
],
"allowlisted": true,
"belongsToDomain": true,
"email": "<string>",
"googleEmailAddress": true,
"kind": "<string>",
"name": "<string>",
"permissionId": "<string>",
"role": "<string>",
"thumbnailPhotoUrl": "<string>",
"type": "<string>",
"withLink": true
}
],
"publishedLink": "<string>",
"resourceKey": "<string>",
"revisionId": "<string>",
"size": 123
}
],
"categories": [
{
"calculatedSettingsInfo": {},
"calculatedValueInfo": {
"error": true
},
"categoryDefinition": {
"description": "<string>",
"dynamicValues": true,
"folder": true,
"id": "<string>",
"kind": "<string>",
"levelNames": [
"<string>"
],
"levelNames_i18n": [
"<string>"
],
"libraryId": "<string>",
"name": "<string>",
"tags": true,
"value": "<string>"
},
"categoryValueMapping": {
"displayName": "<string>",
"id": "<string>"
},
"definitionId": "<string>",
"definitionName": "<string>",
"description": "<string>",
"description_i18n": "<string>",
"dynamicValues": true,
"editable": true,
"fieldId": "<string>",
"fieldMetadata": {},
"fieldName": "<string>",
"fieldName_i18n": "<string>",
"folder": true,
"hidden": true,
"kind": "<string>",
"levelNames": [
"<string>"
],
"lookupConfiguration": {
"sourceConfiguration": {
"displaySearchProperties": [
"<string>"
],
"scope": {
"id": "<string>",
"type": "CLASS"
},
"type": "DOCUMENT"
},
"targetConfiguration": {
"lookupKey": "<string>",
"sourceFieldId": "<string>",
"sourceFieldName": "<string>"
}
},
"lookupValueInfo": {
"displayName": "<string>",
"error": true,
"errorMessage": "<string>"
},
"mandatory": true,
"mappingSourceField": {
"displayName": "<string>",
"id": "<string>"
},
"multiple": true,
"placeholderText": "<string>",
"rank": 123,
"readOnly": true,
"validation": {
"audience": {
"classId": "<string>",
"className": "<string>",
"description": "<string>",
"displayName": "<string>",
"displayName_i18n": "<string>",
"thumbnailPictureUrl": "<string>",
"value": "<string>"
},
"errorMessage": "<string>",
"kind": "<string>",
"lowerLimit": 123,
"lowerLimitInclusive": true,
"mandatoryLeaf": true,
"regex": "<string>",
"upperLimit": 123,
"upperLimitInclusive": true
},
"values": [
[
{
"ancestors": "<array>",
"id": "<string>",
"kind": "<string>",
"leaf": true,
"leafInNotOutdatedTree": true,
"name": "<string>",
"name_i18n": "<string>",
"outdated": true,
"parentId": "<string>",
"shortName": "<string>",
"value": "<string>"
}
]
]
}
],
"checkOutBy": "<string>",
"checkoutDate": "<string>",
"classId": "<string>",
"className": "<string>",
"className_i18n": "<string>",
"coordinate": "<string>",
"creationDate": "<string>",
"deleteAuthor": "<string>",
"deleted": true,
"deletedReason": "<string>",
"deletionDate": "<string>",
"domainName": "<string>",
"driveOnlyPermissions": [
{
"additionalRoles": [
"<string>"
],
"allowlisted": true,
"belongsToDomain": true,
"email": "<string>",
"googleEmailAddress": true,
"kind": "<string>",
"name": "<string>",
"permissionId": "<string>",
"role": "<string>",
"thumbnailPhotoUrl": "<string>",
"type": "<string>",
"withLink": true
}
],
"editable": true,
"evaluationError": true,
"externalSource": {
"displayName": "<string>",
"url": "<string>"
},
"fields": [
{
"calculatedSettingsInfo": {},
"calculatedValueInfo": {
"error": true
},
"description": "<string>",
"description_i18n": "<string>",
"editable": true,
"fieldId": "<string>",
"fieldMetadata": {},
"fieldName": "<string>",
"fieldName_i18n": "<string>",
"hidden": true,
"kind": "<string>",
"lookupConfiguration": {
"sourceConfiguration": {
"displaySearchProperties": [
"<string>"
],
"scope": {
"id": "<string>",
"type": "CLASS"
},
"type": "DOCUMENT"
},
"targetConfiguration": {
"lookupKey": "<string>",
"sourceFieldId": "<string>",
"sourceFieldName": "<string>"
}
},
"lookupValueInfo": {
"displayName": "<string>",
"error": true,
"errorMessage": "<string>"
},
"mandatory": true,
"metadata": {
"attachments": [
{
"drive": {
"iconLink": "<string>",
"kind": "<string>",
"link": "<string>",
"permissionsOnDrive": [
{
"additionalRoles": [
"<string>"
],
"allowlisted": true,
"belongsToDomain": true,
"email": "<string>",
"googleEmailAddress": true,
"kind": "<string>",
"name": "<string>",
"permissionId": "<string>",
"role": "<string>",
"thumbnailPhotoUrl": "<string>",
"type": "<string>",
"withLink": true
}
],
"publishedLink": "<string>",
"resourceKey": "<string>",
"revisionId": "<string>"
},
"id": "<string>",
"kind": "<string>",
"mimeType": "<string>",
"name": "<string>",
"oss": {
"downloadLink": "<string>",
"kind": "<string>"
},
"size": 123
}
],
"kind": "<string>"
},
"multiple": true,
"placeholderText": "<string>",
"rank": 123,
"readOnly": true,
"validation": {
"audience": {
"classId": "<string>",
"className": "<string>",
"description": "<string>",
"displayName": "<string>",
"displayName_i18n": "<string>",
"thumbnailPictureUrl": "<string>",
"value": "<string>"
},
"errorMessage": "<string>",
"kind": "<string>",
"lowerLimit": 123,
"lowerLimitInclusive": true,
"mandatoryLeaf": true,
"regex": "<string>",
"upperLimit": 123,
"upperLimitInclusive": true
},
"values": [
"<string>"
]
}
],
"folders": [
{
"editable": true,
"editableDocuments": true,
"fileId": "<string>",
"folderAodocsId": "<string>",
"folderDefinitionId": "<string>",
"folderIsRoot": true,
"kind": "<string>",
"libraryId": "<string>",
"libraryName": "<string>",
"name": "<string>",
"parentFolderAodocsId": "<string>",
"parentFolderDriveId": "<string>",
"parentFolderIsRoot": true,
"permittedOperations": [],
"resourceKey": "<string>",
"restrictedDownload": true,
"subfolders": "<array>"
}
],
"forbiddenOperations": {},
"fullSizeOfAttachments": 123,
"iconLink": "<string>",
"id": "<string>",
"incomplete": true,
"initialAuthor": "<string>",
"invalidValues": true,
"kind": "<string>",
"libraryId": "<string>",
"libraryName": "<string>",
"modificationDate": "<string>",
"newPermissions": [
{
"additionalRoles": [
"<string>"
],
"allowlisted": true,
"belongsToDomain": true,
"email": "<string>",
"googleEmailAddress": true,
"kind": "<string>",
"name": "<string>",
"permissionId": "<string>",
"role": "<string>",
"thumbnailPhotoUrl": "<string>",
"type": "<string>",
"withLink": true
}
],
"nextVersionName": "<string>",
"numberOfAttachments": 123,
"onlyAdminCanChangeAcl": true,
"onlyAdminCanDelete": true,
"originalVersionId": "<string>",
"permissions": [
{
"fieldNames": [
"<string>"
],
"inherited": true,
"kind": "<string>",
"name": "<string>",
"roleNames": [
"<string>"
],
"thumbnailPhotoUrl": "<string>",
"value": "<string>"
}
],
"permittedOperations": [],
"publishedLink": "<string>",
"referenceCatalogs": [
{
"calculatedSettingsInfo": {},
"calculatedValueInfo": {
"error": true
},
"description": "<string>",
"description_i18n": "<string>",
"editable": true,
"fieldId": "<string>",
"fieldMetadata": {},
"fieldName": "<string>",
"fieldName_i18n": "<string>",
"hidden": true,
"kind": "<string>",
"lookupConfiguration": {
"sourceConfiguration": {
"displaySearchProperties": [
"<string>"
],
"scope": {
"id": "<string>",
"type": "CLASS"
},
"type": "DOCUMENT"
},
"targetConfiguration": {
"lookupKey": "<string>",
"sourceFieldId": "<string>",
"sourceFieldName": "<string>"
}
},
"lookupValueInfo": {
"displayName": "<string>",
"error": true,
"errorMessage": "<string>"
},
"mandatory": true,
"multiple": true,
"placeholderText": "<string>",
"rank": 123,
"readOnly": true,
"referenceCatalog": {
"createdAt": 123,
"id": "<string>",
"kind": "<string>",
"levelNames": [
"<string>"
],
"modifiedAt": 123,
"name": "<string>",
"numberOfValues": 123
},
"referenceCatalogId": "<string>",
"validation": {
"audience": {
"classId": "<string>",
"className": "<string>",
"description": "<string>",
"displayName": "<string>",
"displayName_i18n": "<string>",
"thumbnailPictureUrl": "<string>",
"value": "<string>"
},
"errorMessage": "<string>",
"kind": "<string>",
"lowerLimit": 123,
"lowerLimitInclusive": true,
"mandatoryLeaf": true,
"regex": "<string>",
"upperLimit": 123,
"upperLimitInclusive": true
},
"values": [
{
"deleted": true,
"kind": "<string>",
"leaf": true,
"name": "<string>",
"name_i18n": "<string>",
"parents": "<array>",
"value": "<string>"
}
]
}
],
"relatedDocuments": {},
"restrictedDownload": true,
"richText": "<string>",
"sections": [
{
"columnCount": 123,
"description": "<string>",
"fields": [
{
"id": "<string>",
"type": "<string>"
}
],
"id": "<string>",
"name": "<string>",
"name_i18n": "<string>"
}
],
"sequenceId": 123,
"setModifiedDate": true,
"similarDocuments": [
{
"absoluteDuplicatesOnly": true,
"attachmentId": "<string>",
"attachmentLink": "<string>",
"attachmentMimeType": "<string>",
"attachmentName": "<string>",
"documentId": "<string>",
"documentLink": "<string>",
"documentTitle": "<string>",
"libraryId": "<string>",
"locationInfo": "<string>",
"locationType": "<string>",
"quotedText": "<string>",
"similarityScore": 123
}
],
"state": "<string>",
"stateChangeAuthors": [
{
"classId": "<string>",
"className": "<string>",
"description": "<string>",
"displayName": "<string>",
"displayName_i18n": "<string>",
"thumbnailPictureUrl": "<string>",
"value": "<string>"
}
],
"stateChangeDate": "2023-11-07T05:31:56Z",
"stateId": "<string>",
"state_i18n": "<string>",
"systemFields": [
{
"calculatedValueInfo": {
"error": true
},
"displayName": "<string>",
"editable": true,
"hidden": true,
"id": "<string>",
"kind": "<string>",
"mandatory": true,
"readOnly": true,
"value": "<string>"
}
],
"tableFields": [
{
"calculatedSettingsInfo": {},
"calculatedValueInfo": {
"error": true
},
"columns": [
{
"calculatedSettingsInfo": {},
"calculatedValueInfo": {
"error": true
},
"categoryDefinition": {
"description": "<string>",
"dynamicValues": true,
"folder": true,
"id": "<string>",
"kind": "<string>",
"levelNames": [
"<string>"
],
"levelNames_i18n": [
"<string>"
],
"libraryId": "<string>",
"name": "<string>",
"tags": true,
"value": "<string>"
},
"description": "<string>",
"description_i18n": "<string>",
"editable": true,
"fieldId": "<string>",
"fieldMetadata": {},
"fieldName": "<string>",
"fieldName_i18n": "<string>",
"hidden": true,
"kind": "<string>",
"lookupConfiguration": {
"sourceConfiguration": {
"displaySearchProperties": [
"<string>"
],
"scope": {
"id": "<string>",
"type": "CLASS"
},
"type": "DOCUMENT"
},
"targetConfiguration": {
"lookupKey": "<string>",
"sourceFieldId": "<string>",
"sourceFieldName": "<string>"
}
},
"lookupValueInfo": {
"displayName": "<string>",
"error": true,
"errorMessage": "<string>"
},
"mandatory": true,
"multiple": true,
"placeholderText": "<string>",
"rank": 123,
"readOnly": true,
"referenceCatalogDefinition": {
"createdAt": 123,
"id": "<string>",
"kind": "<string>",
"levelNames": [
"<string>"
],
"modifiedAt": 123,
"name": "<string>",
"numberOfValues": 123
},
"validation": {
"audience": {
"classId": "<string>",
"className": "<string>",
"description": "<string>",
"displayName": "<string>",
"displayName_i18n": "<string>",
"thumbnailPictureUrl": "<string>",
"value": "<string>"
},
"errorMessage": "<string>",
"kind": "<string>",
"lowerLimit": 123,
"lowerLimitInclusive": true,
"mandatoryLeaf": true,
"regex": "<string>",
"upperLimit": 123,
"upperLimitInclusive": true
}
}
],
"description": "<string>",
"description_i18n": "<string>",
"editable": true,
"fieldId": "<string>",
"fieldMetadata": {},
"fieldName": "<string>",
"fieldName_i18n": "<string>",
"hidden": true,
"kind": "<string>",
"lookupConfiguration": {
"sourceConfiguration": {
"displaySearchProperties": [
"<string>"
],
"scope": {
"id": "<string>",
"type": "CLASS"
},
"type": "DOCUMENT"
},
"targetConfiguration": {
"lookupKey": "<string>",
"sourceFieldId": "<string>",
"sourceFieldName": "<string>"
}
},
"lookupValueInfo": {
"displayName": "<string>",
"error": true,
"errorMessage": "<string>"
},
"mandatory": true,
"multiple": true,
"placeholderText": "<string>",
"rank": 123,
"readOnly": true,
"validation": {
"audience": {
"classId": "<string>",
"className": "<string>",
"description": "<string>",
"displayName": "<string>",
"displayName_i18n": "<string>",
"thumbnailPictureUrl": "<string>",
"value": "<string>"
},
"errorMessage": "<string>",
"kind": "<string>",
"lowerLimit": 123,
"lowerLimitInclusive": true,
"mandatoryLeaf": true,
"regex": "<string>",
"upperLimit": 123,
"upperLimitInclusive": true
},
"values": [
{
"categories": {},
"fields": {},
"referenceCatalogs": {},
"rowId": "<string>"
}
]
}
],
"templateDocumentId": "<string>",
"title": "<string>",
"updateAuthor": "<string>",
"userCanChangeAcl": true,
"userCanChangeProperties": true,
"userCanDelete": true,
"userMapping": {},
"versionCreated": "2023-11-07T05:31:56Z",
"versionCreator": "<string>",
"versionDescription": "<string>",
"versionId": "<string>",
"versionLabel": "<string>",
"versionName": "<string>",
"versionNumber": "<string>",
"viewConfiguration": {
"kind": "<string>",
"visibleRelations": [
"<string>"
],
"visibleSections": []
},
"workflowId": "<string>"
}
],
"kind": "<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 relation
The side of the relation
Available options:
FROM, TO The ID of the template document
Query Parameters
The search query with free text or a combination of properties name and value separated by an operator. Example: "Preferred Reseller":amazon
The security code
The G Suite domain
⌘I