Skip to main content
PUT
/
api
/
library
/
v1
PUT https://aodocs.altirnao.com/api/library/v1?include=NONE

{
  "kind": "aodocs#libraryList",
  "libraries": [
    {
      "kind": "aodocs#library",
      "libraryId": "RnTG8PD8u8ZqTuDVHcv",
      "name": "my-DMS-lib-001",
      "defaultDocumentType": "RnTbOft844KfZYkfBpV",
      "rootFolderId": "1S7ayht8i78VtuNl-SebgGTu_wliznnR47",
      "favorited": false,
      ...
    },
    {
      "kind": "aodocs#library",
      "libraryId": "Rngc1ug8K6WmL3IjZ8",
      "name": "my-sf-lib-005",
      "defaultDocumentType": "Rngc4rL89JCj5xwTtrF",
      "rootFolderId": "1yAMvoT8BFEvI_8GXghiyTEJqevJeW7q9C",
      "favorited": true
    }
}

​
Method and API

Play with the API Explorer:

​
PUT /library/v1

​
Request

Warning/Alert:This method requests all metadata for all libraries on the domain. Not recommended without filtering!
This method has no mandatory parameters, but without setting any filtering it tries to return all metadata for all libraries, which is often overwhelming to the server and might not produce any response. We strongly recommend you set the include query parameter to NONE.

​
Sample request

PUT https://aodocs.altirnao.com/api/library/v1?include=NONE
Alternatively use the List plain libraries method (see below) to get just the key-value pairs of name and id.

​
Responses

The response returns an ApiLibraryList resource, listing all libraries accessible to you on the domain. With the recommended parameter include=NONE the response is smaller and far more manageable. Take note of the libraryId of your target library. The library ID is one of the most commonly used identifiers in the AODocs APIs. Additional fields to note:
  • name (of the library)
  • defaultDocumentType (the library’s default class ID)
  • rootFolderId (the ID of the topmost level of the library’s hierarchy)
  • favorited (whether or not the library is starred as a favorite)
  • any other fields of interest
{
  "kind": "aodocs#libraryList",
  "libraries": [
    {
      "kind": "aodocs#library",
      "libraryId": "RnTG8PD8u8ZqTuDVHcv",
      "name": "my-DMS-lib-001",
      "defaultDocumentType": "RnTbOft844KfZYkfBpV",
      "rootFolderId": "1S7ayht8i78VtuNl-SebgGTu_wliznnR47",
      "favorited": false,
      ...
    },
    {
      "kind": "aodocs#library",
      "libraryId": "Rngc1ug8K6WmL3IjZ8",
      "name": "my-sf-lib-005",
      "defaultDocumentType": "Rngc4rL89JCj5xwTtrF",
      "rootFolderId": "1yAMvoT8BFEvI_8GXghiyTEJqevJeW7q9C",
      "favorited": true
    }
}