Skip to main content
POST
/
search
/
v1
/
libraries
/
{libraryId}
/
search
cURL
curl --request POST \
  --url https://aodocs.altirnao.com/api/search/v1/libraries/{libraryId}/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "disableSorting": true,
  "filter": {
    "allOf": "<array>",
    "anyOf": "<array>",
    "operator": "EQUAL",
    "property": "<string>",
    "values": [
      "<string>"
    ]
  },
  "sort": [
    {
      "descending": true,
      "property": "<string>"
    }
  ]
}
'
{
  "count": 123,
  "documents": [
    {
      "acl": [
        {
          "allow": [
            "<string>"
          ],
          "for": [
            "<string>"
          ],
          "kind": "<string>"
        }
      ],
      "attachmentFields": [
        {
          "calculatedSettingsInfo": {},
          "calculatedValueInfo": {
            "error": true
          },
          "description": "<string>",
          "description_i18n": "<string>",
          "editable": true,
          "fieldId": "<string>",
          "fieldName": "<string>",
          "fieldName_i18n": "<string>",
          "hidden": true,
          "kind": "<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,
                "storageType": "OSS"
              }
            ],
            "kind": "<string>"
          },
          "multiple": true,
          "placeholderText": "<string>",
          "rank": 123,
          "readOnly": true,
          "type": "STRING",
          "validation": {
            "audience": {
              "classId": "<string>",
              "className": "<string>",
              "description": "<string>",
              "displayName": "<string>",
              "displayName_i18n": "<string>",
              "thumbnailPictureUrl": "<string>",
              "type": "USER",
              "value": "<string>"
            },
            "errorMessage": "<string>",
            "kind": "<string>",
            "lowerLimit": 123,
            "lowerLimitInclusive": true,
            "mandatoryLeaf": true,
            "regex": "<string>",
            "upperLimit": 123,
            "upperLimitInclusive": true
          },
          "values": [
            "<string>"
          ]
        }
      ],
      "attachments": [
        {
          "autodeskUrn": {
            "status": "READY",
            "urn": "<string>"
          },
          "fileId": "<string>",
          "iconLink": "<string>",
          "kind": "<string>",
          "link": "<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,
          "storageLocation": "DRIVE"
        }
      ],
      "attachmentsToCopy": [
        {
          "autodeskUrn": {
            "status": "READY",
            "urn": "<string>"
          },
          "fileId": "<string>",
          "iconLink": "<string>",
          "kind": "<string>",
          "link": "<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,
          "storageLocation": "DRIVE"
        }
      ],
      "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>"
          },
          "definitionId": "<string>",
          "definitionName": "<string>",
          "description": "<string>",
          "description_i18n": "<string>",
          "dynamicValues": true,
          "editable": true,
          "fieldId": "<string>",
          "fieldName": "<string>",
          "fieldName_i18n": "<string>",
          "folder": true,
          "hidden": true,
          "kind": "<string>",
          "levelNames": [
            "<string>"
          ],
          "mandatory": true,
          "multiple": true,
          "placeholderText": "<string>",
          "rank": 123,
          "readOnly": true,
          "type": "STRING",
          "validation": {
            "audience": {
              "classId": "<string>",
              "className": "<string>",
              "description": "<string>",
              "displayName": "<string>",
              "displayName_i18n": "<string>",
              "thumbnailPictureUrl": "<string>",
              "type": "USER",
              "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,
      "fields": [
        {
          "calculatedSettingsInfo": {},
          "calculatedValueInfo": {
            "error": true
          },
          "description": "<string>",
          "description_i18n": "<string>",
          "editable": true,
          "fieldId": "<string>",
          "fieldName": "<string>",
          "fieldName_i18n": "<string>",
          "hidden": true,
          "kind": "<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,
                "storageType": "OSS"
              }
            ],
            "kind": "<string>"
          },
          "multiple": true,
          "placeholderText": "<string>",
          "rank": 123,
          "readOnly": true,
          "type": "STRING",
          "validation": {
            "audience": {
              "classId": "<string>",
              "className": "<string>",
              "description": "<string>",
              "displayName": "<string>",
              "displayName_i18n": "<string>",
              "thumbnailPictureUrl": "<string>",
              "type": "USER",
              "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": [
            "DELETE"
          ],
          "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>",
          "right": "NONE",
          "roleNames": [
            "<string>"
          ],
          "thumbnailPhotoUrl": "<string>",
          "type": "USER",
          "value": "<string>"
        }
      ],
      "permittedOperations": [
        "DELETE"
      ],
      "publishedLink": "<string>",
      "publishedMode": "NONE",
      "referenceCatalogs": [
        {
          "calculatedSettingsInfo": {},
          "calculatedValueInfo": {
            "error": true
          },
          "description": "<string>",
          "description_i18n": "<string>",
          "editable": true,
          "fieldId": "<string>",
          "fieldName": "<string>",
          "fieldName_i18n": "<string>",
          "hidden": true,
          "kind": "<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>",
          "type": "STRING",
          "validation": {
            "audience": {
              "classId": "<string>",
              "className": "<string>",
              "description": "<string>",
              "displayName": "<string>",
              "displayName_i18n": "<string>",
              "thumbnailPictureUrl": "<string>",
              "type": "USER",
              "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,
      "state": "<string>",
      "stateChangeAuthors": [
        {
          "classId": "<string>",
          "className": "<string>",
          "description": "<string>",
          "displayName": "<string>",
          "displayName_i18n": "<string>",
          "thumbnailPictureUrl": "<string>",
          "type": "USER",
          "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>",
              "fieldName": "<string>",
              "fieldName_i18n": "<string>",
              "hidden": true,
              "kind": "<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
              },
              "type": "STRING",
              "validation": {
                "audience": {
                  "classId": "<string>",
                  "className": "<string>",
                  "description": "<string>",
                  "displayName": "<string>",
                  "displayName_i18n": "<string>",
                  "thumbnailPictureUrl": "<string>",
                  "type": "USER",
                  "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>",
          "fieldName": "<string>",
          "fieldName_i18n": "<string>",
          "hidden": true,
          "kind": "<string>",
          "mandatory": true,
          "multiple": true,
          "placeholderText": "<string>",
          "rank": 123,
          "readOnly": true,
          "type": "STRING",
          "validation": {
            "audience": {
              "classId": "<string>",
              "className": "<string>",
              "description": "<string>",
              "displayName": "<string>",
              "displayName_i18n": "<string>",
              "thumbnailPictureUrl": "<string>",
              "type": "USER",
              "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": {
        "defaultTabToDisplay": "PROPERTIES",
        "kind": "<string>",
        "orientation": "PORTRAIT",
        "visibleRelations": [
          "<string>"
        ],
        "visibleSections": [
          "INFO"
        ]
      },
      "workflowId": "<string>"
    }
  ],
  "kind": "<string>",
  "nextPageToken": "<string>",
  "precision": "ACCURATE"
}

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

Query Parameters

​
classId
string

The ID of the document class

​
searchQuery
string

The text searched to filter documents

​
publishState
enum<string>

The type of documents to find: 'DRAFT_ONLY' to get draft versions only (if access to it), 'PUBLISHED' to get main versions only (if access to it), 'ALL' for both (the draft version if access to it else the main version). The last mode is the default one.

Available options:
PUBLISHED,
DRAFT_ONLY,
ALL
​
offset
string

The offset from which we should get the documents. (Default: 0, i.e. from the first one)

​
limit
integer<int32>
default:20

The maximum number of documents per page. (Default: 20)

​
searchInAttachments
boolean
default:true

Whether to search the text in the attachments too (true by default)

​
securityCode
string

The security code

​
domain
string

The G Suite domain

​
timezone
string

The timezone to use for datetime field searches (default: UTC). Format: 'Europe/Paris' or '+01:00'

Body

application/json
​
disableSorting
boolean

Enforce the fact that results won't be sorted because by default results are sorted by last modification date

​
filter
object
​
sort
object[]

Order the results of the search

Response

200 - application/json

A ApiSearchResult response

​
count
integer<int32>
​
documents
object[]
​
kind
string
​
nextPageToken
string
​
precision
enum<string>
Available options:
ACCURATE,
ESTIMATED_RESULT_NUMBER,
INCOMPLETE_RESULT