Create library

POST

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

Add a new library.

Supported library types are classification.

Path Parameters

project-idstringrequired
Example
af2d8af0fa54465b89bf26dd3d92cfd0
Description
Catenda project id

Body Parameters

bodyobjectrequired
- namestringrequired
  Example
  Library 1
  Description
  The name of the library
- typestring<classification>required
  Example
  classification
  Description
  The library type, valid values are:
  
  classification.
  Allowed
  classification
- classificationobject
  Description
  Fields specific to classification libraries
  - sourcestring
    Description
    Source (or publisher) for this classification
  - editionstring
    Description
    The edition or version of the classification system from which the classification notation is derived
  - editionDatestring
    Example
    2016-09-23
    Description
    The date on which the edition of the classification used became valid, the format should be yyyy-mm-dd

Responses

200OK

library
Description
A library represents an object collection.

Types of libraries that are supported contain either documents, links, embedded values or classifications.
- idstring
  Example
  954803076a694255b959d236517b55da
  Description
  A unique identifier for a library, represented as compacted UUID using 32 hexadecimal characters
- namestring
  Example
  Library Name
  Description
  The name of the library, limited to 256 characters
- typestring<document | link | embedded_value | classification>
  Example
  document
  Description
  The type of the library, valid values are "document", "link", "embedded_value" or "classification"
  Allowed
  documentlinkembedded_valueclassification
- createdByuser
  Description
  Represents a User, Organization or Team.
  
  A User is someone with a Catenda account, commonly representing a person.
  
  An Organization represents a company, project organization or an application. Organizations do not have a username and cannot sign in to Catenda.
  
  A Team represents a group of users within a project. Teams do not have a username and cannot sign in to Catenda.
  - idstring
    Example
    524809076a694255b989d236517a55da
    Description
    Represented as compacted UUID using 32 hexadecimal characters
  - namestring
    Example
    John Doe
    Description
    The name of the user, limited to 128 characters
  - usernamestring
    Example
    [email protected]
    Description
    The handle the user identifies with.
    
    Commonly the username will be in email address format. Usernames are unique but subject to change, we recommend using the id field to reference users instead.
    
    If the user represents an organization or a team the value is always null.
    
    Limited to 50 characters.
  - emailstring
    Example
    [email protected]
    Description
    Email address of the User
  - createdAtstring
    Example
    2016-09-20T14:55:22.000Z
    Description
    The date and time the user was created in ISO 8601 format
  - avatarUrlstring
    Example
    https://api.catenda.com/v2/avatar/397t0ccd8f74516096c738de15dc6512
    Description
    The URL for the user avatar
  - typestring<user | organization | team>
    Example
    user
    Description
    The type of user, valid values are:
    
    user
    
    organization
    
    team
    Allowed
    userorganizationteam

curl

curl --request POST \
     --url https://api.catenda.com/v2/projects/{project-id}/libraries \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "name": "Library 1",
     "type": "classification"
     }'

javascript

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

var raw = JSON.stringify({
   "name": "Library 1",
   "type": "classification"
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.catenda.com/v2/projects/{project-id}/libraries", 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")

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

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "name": "Library 1",
   "type": "classification"
})

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

python

import requests
import json

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

payload = json.dumps({
   "name": "Library 1",
   "type": "classification"
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

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

print(response.text)

200

// OK
{
  "id": "954803076a694255b959d236517b55da",
  "name": "Library Name",
  "type": "document",
  "createdBy": {
    "id": "524809076a694255b989d236517a55da",
    "name": "John Doe",
    "username": "[email protected]",
    "email": "[email protected]",
    "createdAt": "2016-09-20T14:55:22.000Z",
    "avatarUrl": "https://api.catenda.com/v2/avatar/397t0ccd8f74516096c738de15dc6512",
    "type": "user"
  }
}