Esc

↑↓ move↵ openIndex · Pagefind
REST reference · Project Management

Models

12 endpoints12 implementedAll modules →
  1. GET /rest/v1.0/projects/{project_id}/bim_modelsList BIM models
  2. POST /rest/v1.0/projects/{project_id}/bim_modelsCreate BIM model
  3. GET /rest/v1.0/projects/{project_id}/bim_models/{bim_model_id}Show BIM model
  4. GET /rest/v1.0/projects/{project_id}/bim_models/{bim_model_id}/coordination_issuesList coordination issues
  5. POST /rest/v1.0/projects/{project_id}/bim_models/{bim_model_id}/coordination_issuesCreate coordination issue
  6. GET /rest/v1.0/projects/{project_id}/bim_models/{bim_model_id}/coordination_issues/{id}Show coordination issue
  7. PATCH /rest/v1.0/projects/{project_id}/bim_models/{bim_model_id}/coordination_issues/{id}Update coordination issue
  8. GET /rest/v1.0/projects/{project_id}/bim_models/{bim_model_id}/revisionsList revisions
  9. POST /rest/v1.0/projects/{project_id}/bim_models/{bim_model_id}/revisionsCreate revision
  10. GET /rest/v1.0/projects/{project_id}/bim_models/{bim_model_id}/viewpointsList viewpoints
  11. POST /rest/v1.0/projects/{project_id}/bim_models/{bim_model_id}/viewpointsCreate viewpoint
  12. GET /rest/v1.0/projects/{project_id}/bim_models/federated_modelsFederated model composition (file-bound revisions)
GET /rest/v1.0/projects/{project_id}/bim_models

List BIM models

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Response · 200 · object[]

  • id
    integerrequired
  • title
    stringrequired
  • name
    stringrequired
  • discipline
    string | null
  • project_id
    integerrequired
  • auto_publish
    booleanrequired
  • published
    boolean
  • web_url
    stringrequired
  • current_revision_id
    integer | null
  • revisions_count
    integerrequired
  • viewpoints_count
    integer
  • coordination_issues_count
    integer
  • open_coordination_issues_count
    integerrequired
POST /rest/v1.0/projects/{project_id}/bim_models

Create BIM model

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Response · 201 · object

  • id
    integerrequired
  • title
    string
  • name
    stringrequired
  • discipline
    string | null
  • project_id
    integerrequired
  • auto_publish
    booleanrequired
  • published
    boolean
  • web_url
    stringrequired
  • current_revision_id
    integer | null
  • revisions_count
    integerrequired
  • revisions
    object[]required
GET /rest/v1.0/projects/{project_id}/bim_models/{bim_model_id}

Show BIM model

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • bim_model_id
    stringpathrequired

Response · 200 · object

  • id
    integerrequired
  • title
    string
  • name
    stringrequired
  • discipline
    string | null
  • project_id
    integerrequired
  • auto_publish
    booleanrequired
  • published
    boolean
  • web_url
    stringrequired
  • current_revision_id
    integer | null
  • revisions_count
    integerrequired
  • viewpoints_count
    integer
  • coordination_issues_count
    integer
  • open_coordination_issues_count
    integerrequired
  • revisions
    object[]required
GET /rest/v1.0/projects/{project_id}/bim_models/{bim_model_id}/coordination_issues

List coordination issues

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • bim_model_id
    stringpathrequired

Response · 200 · object[]

  • id
    integerrequired
  • project_id
    integer
  • bim_model_id
    integerrequired
  • title
    stringrequired
  • status
    stringrequired
  • translated_status
    string
  • position
    objectrequired
  • assignee_id
    integer | null
  • created_by_id
    integer
POST /rest/v1.0/projects/{project_id}/bim_models/{bim_model_id}/coordination_issues

Create coordination issue

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • bim_model_id
    stringpathrequired

Response · 201 · object

  • id
    integerrequired
  • project_id
    integer
  • bim_model_id
    integerrequired
  • title
    stringrequired
  • status
    stringrequired
  • translated_status
    string
  • position
    objectrequired
  • assignee_id
    integer | null
  • created_by_id
    integer
GET /rest/v1.0/projects/{project_id}/bim_models/{bim_model_id}/coordination_issues/{id}

Show coordination issue

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • bim_model_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · object

  • id
    integerrequired
  • bim_model_id
    integerrequired
  • title
    stringrequired
  • status
    stringrequired
  • position
    objectrequired
PATCH /rest/v1.0/projects/{project_id}/bim_models/{bim_model_id}/coordination_issues/{id}

Update coordination issue

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • bim_model_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · object

  • id
    integerrequired
  • bim_model_id
    integerrequired
  • title
    stringrequired
  • status
    stringrequired
  • position
    objectrequired
GET /rest/v1.0/projects/{project_id}/bim_models/{bim_model_id}/revisions

List revisions

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • bim_model_id
    stringpathrequired

Response · 200 · object[]

  • id
    integerrequired
  • bim_model_id
    integerrequired
  • revision_number
    integerrequired
  • revision
    integerrequired
  • source
    string | null
  • suitability
    string | null
  • publish_status
    stringrequired
  • published
    booleanrequired
  • bim_file
    object | null
  • created_by_id
    integer | null
  • uploaded_by_id
    integer | null
POST /rest/v1.0/projects/{project_id}/bim_models/{bim_model_id}/revisions

Create revision

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • bim_model_id
    stringpathrequired

Response · 201 · object

  • id
    integerrequired
  • bim_model_id
    integerrequired
  • revision_number
    integerrequired
  • source
    string | null
  • uploaded_by_id
    integer | null
GET /rest/v1.0/projects/{project_id}/bim_models/{bim_model_id}/viewpoints

List viewpoints

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • bim_model_id
    stringpathrequired

Response · 200 · object[]

  • id
    integerrequired
  • bim_model_id
    integerrequired
  • name
    stringrequired
  • camera
    objectrequired
POST /rest/v1.0/projects/{project_id}/bim_models/{bim_model_id}/viewpoints

Create viewpoint

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • bim_model_id
    stringpathrequired

Response · 201 · object

  • id
    integerrequired
  • bim_model_id
    integerrequired
  • name
    stringrequired
  • camera
    objectrequired
GET /rest/v1.0/projects/{project_id}/bim_models/federated_models

Federated model composition (file-bound revisions)

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Response · 200 · object

  • models_count
    integerrequired
  • options
    object[]required
  • selected
    object[]required

Ask the OS

Reading this page

Ask anything about this page. Answers use what you're reading as context.

Suggested

    AI · may be imperfect · sample data where shown

    Open file