Update collection

PATCH

https://api.catenda.com/v2/projects/{project-id}/libraries/collections/{collection-id}

Update a document library item collection.

Path Parameters

project-idstringrequired
Example
af2d8af0fa54465b89bf26dd3d92cfd0
Description
Catenda project id
collection-idstringrequired
Description
Id of the document library item collection

Body Parameters

bodyobjectrequired
- namestring
  Example
  Collection 1
  Description
  The name of the library item collection.
- descriptionstring
  Example
  Collection description
  Description
  The description of the library item collection.
- finalizedboolean
  Description
  Whether the collection is finalized and no longer editable.
- visibilitystring<private | project-members>
  Example
  private
  Description
  Determines whether the collection is shared at the project level. Valid values are "private" and "project-members".
  Allowed
  privateproject-members
- followLatestRevisionboolean
  Example
  true
  Description
  Set whether the collection uses the latest revision of all items or the revision when added to the collection.

Responses

200OK

collection
- idstring
  Example
  924809076a694255b589d236517a55da
  Description
  Id of the collection, represented as compacted UUID using 32 hexadecimal characters.
- namestring
  Example
  Collection name
  Description
  The name of the collection.
- descriptionstring
  Example
  Collection description
  Description
  The description of the collection.
- finalizedboolean
  Description
  Indicates whether the collection is finalized. Finalized collections can no longer be edited.
- followLatestRevisionboolean
  Example
  true
  Description
  Determines whether collection items follow the latest revision of a library item or the revision when added to the collection.
- visibilitystring<private | project-members>
  Example
  private
  Description
  Determines whether the collection is available to all project members.
  
  By default a collection becomes available to project members when it is finalized.
  
  Valid values are:
  
  private
  
  project-members
  Allowed
  privateproject-members
- createdAtstring
  Example
  2023-12-09T10:07:56.000Z
  Description
  The date and time the collection was created in ISO 8601 format.
- createdBystring
  Example
  524809076a694255b989d236517a55da
  Description
  The user id of the user who created the collection.

curl

curl --request PATCH \
     --url https://api.catenda.com/v2/projects/{project-id}/libraries/collections/{collection-id} \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'PATCH',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.catenda.com/v2/projects/{project-id}/libraries/collections/{collection-id}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.catenda.com/v2/projects/{project-id}/libraries/collections/{collection-id}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.catenda.com/v2/projects/{project-id}/libraries/collections/{collection-id}"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("PATCH", url, headers=headers, data=payload)

print(response.text)

200

// OK
{
  "id": "924809076a694255b589d236517a55da",
  "name": "Collection name",
  "description": "Collection description",
  "finalized": false,
  "followLatestRevision": true,
  "visibility": "private",
  "createdAt": "2023-12-09T10:07:56.000Z",
  "createdBy": "524809076a694255b989d236517a55da"
}