Skip to main content
PATCH
/
view
/
v1
cURL
curl --request PATCH \
  --url https://aodocs.altirnao.com/api/view/v1 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "availableFields": [
    {
      "capabilities": [
        "DISPLAY"
      ],
      "filterOperators": [
        "EQUAL"
      ],
      "hidden": true,
      "id": "<string>",
      "kind": "<string>",
      "multiple": true,
      "name": "<string>",
      "name_i18n": "<string>",
      "system": true,
      "type": "STRING"
    }
  ],
  "browseBy": {
    "kind": "<string>",
    "name": "<string>",
    "name_i18n": "<string>",
    "type": "STATE",
    "value": "<string>"
  },
  "classId": "<string>",
  "className": "<string>",
  "customUIActions": [
    {
      "displayedOn": {
        "classIds": [
          {
            "documents": true,
            "id": "<string>",
            "kind": "<string>",
            "views": true
          }
        ],
        "viewIds": [
          {
            "id": "<string>",
            "kind": "<string>"
          }
        ]
      },
      "icon": "<string>",
      "id": "<string>",
      "kind": "<string>",
      "libraryId": "<string>",
      "role": "NONE",
      "selection": "ANY",
      "title": "<string>",
      "url": "<string>",
      "windowName": "<string>"
    }
  ],
  "defaultView": true,
  "displayColumns": [
    {
      "kind": "<string>",
      "name": "<string>",
      "name_i18n": "<string>",
      "value": "<string>"
    }
  ],
  "expandFilters": true,
  "filterColumns": [
    {
      "kind": "<string>",
      "name": "<string>",
      "name_i18n": "<string>",
      "value": "<string>"
    }
  ],
  "filters": [
    {
      "column": {
        "kind": "<string>",
        "name": "<string>",
        "name_i18n": "<string>",
        "value": "<string>"
      },
      "joinType": "AND",
      "kind": "<string>",
      "operator": "EQUAL",
      "value": "<string>",
      "values": [
        [
          {
            "id": "<string>",
            "name": "<string>",
            "name_i18n": "<string>",
            "value": "<string>"
          }
        ]
      ]
    }
  ],
  "hideOutdatedCategoryValues": true,
  "id": "<string>",
  "includeOtherClasses": true,
  "includeSubfolders": true,
  "kind": "<string>",
  "libraryId": "<string>",
  "name": "<string>",
  "name_i18n": "<string>",
  "numberOfDocumentsPerPage": 123,
  "openDocumentTargetPage": "DOCUMENT",
  "openDocumentTargetTab": "CURRENT",
  "order": {
    "descending": true,
    "kind": "<string>",
    "sortByField": {
      "kind": "<string>",
      "name": "<string>",
      "name_i18n": "<string>",
      "value": "<string>"
    }
  },
  "publishState": "ALL",
  "searchInAttachmentsByDefault": true,
  "showInLibrary": true,
  "url": "<string>",
  "visibility": {
    "classId": "<string>",
    "className": "<string>",
    "description": "<string>",
    "displayName": "<string>",
    "displayName_i18n": "<string>",
    "thumbnailPictureUrl": "<string>",
    "type": "USER",
    "value": "<string>"
  }
}
'
{
  "availableFields": [
    {
      "capabilities": [
        "DISPLAY"
      ],
      "filterOperators": [
        "EQUAL"
      ],
      "hidden": true,
      "id": "<string>",
      "kind": "<string>",
      "multiple": true,
      "name": "<string>",
      "name_i18n": "<string>",
      "system": true,
      "type": "STRING"
    }
  ],
  "browseBy": {
    "kind": "<string>",
    "name": "<string>",
    "name_i18n": "<string>",
    "type": "STATE",
    "value": "<string>"
  },
  "classId": "<string>",
  "className": "<string>",
  "customUIActions": [
    {
      "displayedOn": {
        "classIds": [
          {
            "documents": true,
            "id": "<string>",
            "kind": "<string>",
            "views": true
          }
        ],
        "viewIds": [
          {
            "id": "<string>",
            "kind": "<string>"
          }
        ]
      },
      "icon": "<string>",
      "id": "<string>",
      "kind": "<string>",
      "libraryId": "<string>",
      "role": "NONE",
      "selection": "ANY",
      "title": "<string>",
      "url": "<string>",
      "windowName": "<string>"
    }
  ],
  "defaultView": true,
  "displayColumns": [
    {
      "kind": "<string>",
      "name": "<string>",
      "name_i18n": "<string>",
      "value": "<string>"
    }
  ],
  "expandFilters": true,
  "filterColumns": [
    {
      "kind": "<string>",
      "name": "<string>",
      "name_i18n": "<string>",
      "value": "<string>"
    }
  ],
  "filters": [
    {
      "column": {
        "kind": "<string>",
        "name": "<string>",
        "name_i18n": "<string>",
        "value": "<string>"
      },
      "joinType": "AND",
      "kind": "<string>",
      "operator": "EQUAL",
      "value": "<string>",
      "values": [
        [
          {
            "id": "<string>",
            "name": "<string>",
            "name_i18n": "<string>",
            "value": "<string>"
          }
        ]
      ]
    }
  ],
  "hideOutdatedCategoryValues": true,
  "id": "<string>",
  "includeOtherClasses": true,
  "includeSubfolders": true,
  "kind": "<string>",
  "libraryId": "<string>",
  "name": "<string>",
  "name_i18n": "<string>",
  "numberOfDocumentsPerPage": 123,
  "openDocumentTargetPage": "DOCUMENT",
  "openDocumentTargetTab": "CURRENT",
  "order": {
    "descending": true,
    "kind": "<string>",
    "sortByField": {
      "kind": "<string>",
      "name": "<string>",
      "name_i18n": "<string>",
      "value": "<string>"
    }
  },
  "publishState": "ALL",
  "searchInAttachmentsByDefault": true,
  "showInLibrary": true,
  "url": "<string>",
  "visibility": {
    "classId": "<string>",
    "className": "<string>",
    "description": "<string>",
    "displayName": "<string>",
    "displayName_i18n": "<string>",
    "thumbnailPictureUrl": "<string>",
    "type": "USER",
    "value": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
securityCode
string

The security code

​
domain
string

The G Suite domain

Body

application/json
​
availableFields
object[]

The list of fields, their type, in which configuration settings they can be used and the operators available for filters (read-only field)

​
browseBy
object
​
classId
string

The ID of the (main) class of the view (read-only after creation)

​
className
string

The name of the (main) class of the view (read-only after creation)

​
customUIActions
object[]

The list of custom ui actions to display in the view for the current user (read-only)

​
defaultView
boolean

Whether this is the default view in the library (read-only field - use library.patchLibrary to change the default view)

​
displayColumns
object[]

The list of columns to display in the view

​
expandFilters
boolean

Whether the filters panel should be expanded by default

​
filterColumns
object[]

The list of fields to use as filters in the view

​
filters
object[]

The list of filters applied before the view is rendered

​
hideOutdatedCategoryValues
boolean

Whether to hide outdated category values in 'browse by' and 'filters' panels

​
id
string

The ID of the view (read-only field)

​
includeOtherClasses
boolean

Whether to list documents from all the classes in the library

​
includeSubfolders
boolean

Whether to include documents from subfolders recursively when rendering

​
kind
string
​
libraryId
string

The ID of the library (read-only after creation)

​
name
string

The name of the view

​
name_i18n
string

The internationalized name of the view (read-only field)

​
numberOfDocumentsPerPage
integer<int32>

The number of documents per page to render by default (20, 50 or 100)

​
openDocumentTargetPage
enum<string>

The target page to open when clicking on the document title link: open AODocs document page (DOCUMENT, by default) or open the attachment (first, if any) in Drive (ATTACHMENT_IN_DRIVE)

Available options:
DOCUMENT,
ATTACHMENT_IN_DRIVE
​
openDocumentTargetTab
enum<string>

The target tab to open when clicking on the document title link: open the content in the same tab (CURRENT, by default), open it in a new tab (PER_DOCUMENT) or in a common tab per view (PER_VIEW)

Available options:
CURRENT,
PER_DOCUMENT,
PER_VIEW
​
order
object
​
publishState
enum<string>

The filter on the check-out state of the documents: ALL (default value), PUBLISHED (only main versions if checked-out or simple head version if not) or DRAFT_ONLY (draft version if checked-out)

Available options:
ALL,
PUBLISHED,
DRAFT_ONLY
​
searchInAttachmentsByDefault
boolean

Whether to enable the search in attachments by default (relevant for Document Management libraries only)

​
showInLibrary
boolean

Whether this view should be listed to end-users (default: true, i.e. for everyone)

​
url
string

The customized URL of the view

​
visibility
object

Response

200 - application/json

A ApiView response

​
availableFields
object[]

The list of fields, their type, in which configuration settings they can be used and the operators available for filters (read-only field)

​
browseBy
object
​
classId
string

The ID of the (main) class of the view (read-only after creation)

​
className
string

The name of the (main) class of the view (read-only after creation)

​
customUIActions
object[]

The list of custom ui actions to display in the view for the current user (read-only)

​
defaultView
boolean

Whether this is the default view in the library (read-only field - use library.patchLibrary to change the default view)

​
displayColumns
object[]

The list of columns to display in the view

​
expandFilters
boolean

Whether the filters panel should be expanded by default

​
filterColumns
object[]

The list of fields to use as filters in the view

​
filters
object[]

The list of filters applied before the view is rendered

​
hideOutdatedCategoryValues
boolean

Whether to hide outdated category values in 'browse by' and 'filters' panels

​
id
string

The ID of the view (read-only field)

​
includeOtherClasses
boolean

Whether to list documents from all the classes in the library

​
includeSubfolders
boolean

Whether to include documents from subfolders recursively when rendering

​
kind
string
​
libraryId
string

The ID of the library (read-only after creation)

​
name
string

The name of the view

​
name_i18n
string

The internationalized name of the view (read-only field)

​
numberOfDocumentsPerPage
integer<int32>

The number of documents per page to render by default (20, 50 or 100)

​
openDocumentTargetPage
enum<string>

The target page to open when clicking on the document title link: open AODocs document page (DOCUMENT, by default) or open the attachment (first, if any) in Drive (ATTACHMENT_IN_DRIVE)

Available options:
DOCUMENT,
ATTACHMENT_IN_DRIVE
​
openDocumentTargetTab
enum<string>

The target tab to open when clicking on the document title link: open the content in the same tab (CURRENT, by default), open it in a new tab (PER_DOCUMENT) or in a common tab per view (PER_VIEW)

Available options:
CURRENT,
PER_DOCUMENT,
PER_VIEW
​
order
object
​
publishState
enum<string>

The filter on the check-out state of the documents: ALL (default value), PUBLISHED (only main versions if checked-out or simple head version if not) or DRAFT_ONLY (draft version if checked-out)

Available options:
ALL,
PUBLISHED,
DRAFT_ONLY
​
searchInAttachmentsByDefault
boolean

Whether to enable the search in attachments by default (relevant for Document Management libraries only)

​
showInLibrary
boolean

Whether this view should be listed to end-users (default: true, i.e. for everyone)

​
url
string

The customized URL of the view

​
visibility
object