Document Library

All Catenda projects have a document library, use the document library to store files and folders. All items in the document library are library items. A library item can be a file or a folder. A folder can contain other folders and files. The parentId of a file is the library item id of the folder it is stored in. File library items can have multiple revisions. Each revision is a separate file.
List documents
Use the list library items endpoint with the following supported parameters to limit the result:
parentId
associations
labels
search
createdAtFrom
createdAtTo
publishedAtFrom
publishedAtTo
include
subFolders
Upload a file
Use the create library item endpoint to upload a file.
Prepare request header
Set the necessary fields of the JSON object and set the value to the request header Bimsync-Params.
JSON
{
  "name": "Document name",
  "parentId": "Parent folder ID",
  "document": {
    "type": "file",
    "filename": "document.pdf"
  },
  "failOnDocumentExists": false // optional, defaults to false
}
{
  "name": "Document name",
  "parentId": "Parent folder ID",
  "document": {
    "type": "file",
    "filename": "document.pdf"
  },
  "failOnDocumentExists": false // optional, defaults to false
}
﻿
Make request
Attach the file to the request and set the Content-Type header to application/octet-stream.
Curl
curl -X POST \
  'https://api.catenda.com/v2/projects/{project-id}/libraries/{library-id}/items' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/octet-stream' \
  --header 'Bimsync-Params: {"name":"Document name","parentId":"Parent folder ID","document":{"type":"file","filename":"document.pdf"},"failOnDocumentExists":false}' \
  --data-binary '@/path/to/document.pdf'
curl -X POST \
  'https://api.catenda.com/v2/projects/{project-id}/libraries/{library-id}/items' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/octet-stream' \
  --header 'Bimsync-Params: {"name":"Document name","parentId":"Parent folder ID","document":{"type":"file","filename":"document.pdf"},"failOnDocumentExists":false}' \
  --data-binary '@/path/to/document.pdf'
﻿
Upload a file revision
Use the create library item revision endpoint to upload a new revision of a file.
Download a file
Use the get library item endpoint to download a file.
Make request
Set the Accept header to application/octet-stream.
Curl
curl -X GET \
  'https://api.catenda.com/v2/projects/{project-id}/libraries/{library-id}/items/{item-id}' \
  --header 'Accept: application/octet-stream' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
curl -X GET \
  'https://api.catenda.com/v2/projects/{project-id}/libraries/{library-id}/items/{item-id}' \
  --header 'Accept: application/octet-stream' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
﻿
Update a file
Use the update library item endpoint with the following supported parameters:
name
parentId
labelsToAdd
labelsToRemove
Create a folder
Use the create library item endpoint to create a folder.
Prepare request body
Set the necessary fields of the JSON request body.
JSON
{
  "name": "Folder name",
  "type": "folder",
  "parentId": "Parent folder ID",
  "document": {
    "type": "folder"
  }
}
{
  "name": "Folder name",
  "type": "folder",
  "parentId": "Parent folder ID",
  "document": {
    "type": "folder"
  }
}
﻿
Make request
Send a POST request to the endpoint.
Curl
curl -X POST \
  'https://api.catenda.com/v2/projects/{project-id}/libraries/{library-id}/items' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data-raw '{
      "name": "Folder name",
      "type": "folder",
      "parentId": "Parent folder ID",
      "document": {
          "type": "folder"
      }
  }'
curl -X POST \
  'https://api.catenda.com/v2/projects/{project-id}/libraries/{library-id}/items' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data-raw '{
      "name": "Folder name",
      "type": "folder",
      "parentId": "Parent folder ID",
      "document": {
          "type": "folder"
      }
  }'
﻿
Update a folder
Use the update library item endpoint with the following supported parameters:
name
﻿
Updated 17 Jun 2024
Did this page help you?
Document API
Link Library