Get revision status

GET

https://api.catenda.com/v2/projects/{project-id}/revision_status/{model-revision-status-id}

Get the processing status for a revision.

Path Parameters

project-idstringrequired
Example
af2d8af0fa54465b89bf26dd3d92cfd0
Description
Catenda project id
model-revision-status-idstringrequired
Description
Id of the model revision status

Responses

200OK

model-revision-status[]
- callbackUristring
  Example
  https://example.com
  Description
  The callback URI specified when uploading the revision
- filenamestring
  Example
  ARC.ifc
  Description
  The filename specified when uploading the revision
- idstring
  Example
  fcbb72736862483f89d44890d47ec112
  Description
  A unique identifier for the status, represented as compacted UUID using 32 hexadecimal characters
- modelmodel
  Description
  Represents an IFC model as a set of Revisions.
  
  A large building project can contain multiple IFC models.
  
  They are often divided by domain (architecture, electrical, etc.)
  - idstring
    Example
    47024671cbd642a9c7c84808d4d509f5
    Description
    A unique identifier for a model, represented as compacted UUID using 32 hexadecimal characters
  - namestring
    Example
    Model name
    Description
    The name of the model, limited to 512 characters
- processingobject
  Description
  Represents the processing status of a pending revision
  - progressnumber
    Description
    Processing progress as a number between 0.0 and 1.0
  - statusstring<waiting | processing | success | failure>
    Example
    waiting
    Description
    Valid values are "waiting", "processing", "success" or "failure"
    Allowed
    waitingprocessingsuccessfailure
  - errorerror
    - codeinteger
      Description
      The error code
    - messagestring
      Description
      The error message
- revisionmodel-revision
  Description
  Represents a revision of a Model. A new revision is created by uploading an IFC model.
  - commentstring
    Example
    Revision description
    Description
    Text describing the revision, limited to 64K characters
  - createdAtstring
    Example
    2016-09-26T14:45:20.000Z
    Description
    The date and time the revision was created in ISO 8601 format
  - extendedVersionobject
    Description
    Extended version of the revision
    - majornumber
      Example
      1
      Description
      Major version of the revision
    - minorstring
      Example
      1
      Description
      Minor version of the revision
  - idstring
    Example
    924809076a694255c489d236517a55da
    Description
    A unique identifier for the revision, represented as compacted UUID using 32 hexadecimal characters.
  - modelmodel
    Description
    Represents an IFC model as a set of Revisions.
    
    A large building project can contain multiple IFC models.
    
    They are often divided by domain (architecture, electrical, etc.)
    - idstring
      Example
      47024671cbd642a9c7c84808d4d509f5
      Description
      A unique identifier for a model, represented as compacted UUID using 32 hexadecimal characters
    - namestring
      Example
      Model name
      Description
      The name of the model, limited to 512 characters
  - 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
  - versioninteger
    Example
    1
    Description
    A number that is incremented for each new revision of a model
- 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 GET \
     --url https://api.catenda.com/v2/projects/{project-id}/revision_status/{model-revision-status-id} \
     --header 'accept: application/json'

javascript

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

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

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

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

request = Net::HTTP::Get.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}/revision_status/{model-revision-status-id}"

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

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

print(response.text)

200

// OK
[
  {
    "callbackUri": "https://example.com",
    "filename": "ARC.ifc",
    "id": "fcbb72736862483f89d44890d47ec112",
    "model": {
      "id": "47024671cbd642a9c7c84808d4d509f5",
      "name": "Model name"
    },
    "processing": {
      "progress": 0,
      "status": "waiting",
      "error": {
        "code": 0,
        "message": ""
      }
    },
    "revision": {
      "comment": "Revision description",
      "createdAt": "2016-09-26T14:45:20.000Z",
      "extendedVersion": {
        "major": 1,
        "minor": 1
      },
      "id": "924809076a694255c489d236517a55da",
      "model": {
        "id": "47024671cbd642a9c7c84808d4d509f5",
        "name": "Model name"
      },
      "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"
      },
      "version": 1
    },
    "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"
    }
  }
]