Remove associations

DELETE

https://api.catenda.com/v2/projects/{project-id}/libraries/{library-id}/items/{library-item-id}/associations

Remove associations between a library item and IFC products.

Supported library types are document, link and classification.

Path Parameters

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

Query Parameters

revisionstring
Description
Specify which revisions are used to resolve global id from objectId by providing a comma separated list. If not present, the latest revisions in all models in the project are used.

Body Parameters

bodyobject[]required
- globalIdstring
  Example
  2_TmT90tD0x9tJSTsyTb1J
  Description
  A 22 character IfcGloballyUniqueId.
- objectIdstring
  Example
  192042324556
  Description
  The object id of a product.

Responses

200OK

library-item-association[]
- globalIdstring
  Example
  2_TmT90tD0x9tJSTsyTb1J
  Description
  A 22 character IfcGloballyUniqueId.
- createdAtstring
  Example
  2023-12-09T10:07:56Z
  Description
  The date and time the association was created.
- useruser
  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 DELETE \
     --url https://api.catenda.com/v2/projects/{project-id}/libraries/{library-id}/items/{library-item-id}/associations \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '[
     {}
     ]'

javascript

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

var raw = JSON.stringify([
   {}
]);

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

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

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

request = Net::HTTP::Delete.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump([
   {}
])

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

python

import requests
import json

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

payload = json.dumps([
   {}
])
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

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

print(response.text)

200

// OK
[
  {
    "globalId": "2_TmT90tD0x9tJSTsyTb1J",
    "createdAt": "2023-12-09T10:07:56Z",
    "user": {
      "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"
    }
  }
]