Esc

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

Drawings

47 endpoints28 implementedAll modules →
  1. GET /rest/v1.0/drawing_areas/{drawing_area_id}/drawingsList drawings
  2. PATCH /rest/v1.0/drawing_areas/{drawing_area_id}/drawings/{id}Update Drawing
  3. GET /rest/v1.0/projects/{project_id}/drawing_areasList drawing areas
  4. POST /rest/v1.0/projects/{project_id}/drawing_areasCreate drawing area
  5. PATCH /rest/v1.0/projects/{project_id}/drawing_areas/{id}Update a drawing area
  6. DELETE /rest/v1.0/projects/{project_id}/drawing_areas/{id}Delete a drawing area
  7. GET /rest/v1.0/projects/{project_id}/drawing_disciplinesList Drawing Disciplines
  8. GET /rest/v1.0/projects/{project_id}/drawing_disciplines/{id}Show Drawing Discipline
  9. PATCH /rest/v1.0/projects/{project_id}/drawing_disciplines/{id}Update Drawing Discipline
  10. POST /rest/v1.0/projects/{project_id}/drawing_revision_emails/{id}/send_emailSend email
  11. GET /rest/v1.0/projects/{project_id}/drawing_revision_termsList drawing revision terms
  12. GET /rest/v1.0/projects/{project_id}/drawing_revisionsList drawing revisions
  13. GET /rest/v1.0/projects/{project_id}/drawing_revisions/{drawing_revision_id}/drawing_tilesList drawing tiles
  14. GET /rest/v1.0/projects/{project_id}/drawing_revisions/{id}Show Drawing Revision
  15. PATCH /rest/v1.0/projects/{project_id}/drawing_revisions/{id}Update Drawing Revision
  16. GET /rest/v1.0/projects/{project_id}/drawing_revisions/{id}/markupsList markups for a drawing revision
  17. POST /rest/v1.0/projects/{project_id}/drawing_revisions/{id}/markupsCreate a markup layer on a drawing revision
  18. GET /rest/v1.0/projects/{project_id}/drawing_revisions/{id}/markups/{markup_id}Show a markup
  19. PATCH /rest/v1.0/projects/{project_id}/drawing_revisions/{id}/markups/{markup_id}Update a markup layer
  20. DELETE /rest/v1.0/projects/{project_id}/drawing_revisions/{id}/markups/{markup_id}Delete a markup layer
  21. POST /rest/v1.0/projects/{project_id}/drawing_revisions/publishPublish Drawing Revisions
  22. GET /rest/v1.0/projects/{project_id}/drawing_setsList drawing sets
  23. POST /rest/v1.0/projects/{project_id}/drawing_setsCreate drawing set
  24. PATCH /rest/v1.0/projects/{project_id}/drawing_sets/{id}Update drawing set
  25. DELETE /rest/v1.0/projects/{project_id}/drawing_sets/{id}Delete drawing set
  26. GET /rest/v1.0/projects/{project_id}/drawing_sheet_indexSheet Index
  27. GET /rest/v1.0/projects/{project_id}/drawing_uploadsList drawing uploads
  28. POST /rest/v1.0/projects/{project_id}/drawing_uploadsCreate drawing upload
  29. DELETE /rest/v1.0/projects/{project_id}/drawing_uploads/{id}Delete drawing upload
  30. DELETE /rest/v1.0/projects/{project_id}/drawings/{id}Delete (recycle) a drawing (os.construction extension)
  31. GET /rest/v1.0/projects/{project_id}/drawings/{id}/compareCompare two revisions of a drawing (os.construction extension)
  32. PATCH /rest/v1.0/projects/{project_id}/drawings/{id}/restoreRestore a recycled drawing (os.construction extension)
  33. GET /rest/v1.0/projects/{project_id}/drawings/recycle_binList recycled drawings (os.construction extension)
  34. GET /rest/v1.1/drawing_areas/{drawing_area_id}/drawingsList drawings
  35. POST /rest/v1.1/drawing_areas/{drawing_area_id}/drawingsCreate Drawing
  36. PATCH /rest/v1.1/drawing_areas/{drawing_area_id}/drawings/{id}Update Drawing
  37. GET /rest/v1.1/projects/{project_id}/drawing_areasList drawing areas
  38. POST /rest/v1.1/projects/{project_id}/drawing_areasCreate drawing area
  39. PATCH /rest/v1.1/projects/{project_id}/drawing_areas/{id}Update a drawing area
  40. DELETE /rest/v1.1/projects/{project_id}/drawing_areas/{id}Delete a drawing area
  41. GET /rest/v1.1/projects/{project_id}/drawing_disciplinesList Drawing Disciplines
  42. PATCH /rest/v1.1/projects/{project_id}/drawing_disciplines/{id}Update drawing discipline
  43. GET /rest/v1.1/projects/{project_id}/drawing_revision_termsList drawing revision terms
  44. GET /rest/v1.1/projects/{project_id}/drawing_uploadsList drawing uploads
  45. POST /rest/v1.1/projects/{project_id}/drawing_uploadsCreate drawing upload
  46. GET /rest/v1.1/projects/{project_id}/drawing_uploads/{id}Show Drawing Upload
  47. DELETE /rest/v1.1/projects/{project_id}/drawing_uploads/{id}Delete drawing upload
GET /rest/v1.0/drawing_areas/{drawing_area_id}/drawings

List drawings

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • drawing_area_id
    integerpathrequired
  • project_id
    integerquery
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · object[]

  • id
    integer
  • discipline
    string
  • drawing_discipline_id
    integer
  • number
    string
  • drawing_number
    string
  • sheet_number
    integer
  • title
    string
  • obsolete
    boolean
  • current_revision
    object
PATCH /rest/v1.0/drawing_areas/{drawing_area_id}/drawings/{id}

Update Drawing

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • drawing_area_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • drawing
    objectrequired

Response · 200 · object

  • id
    integer
  • number
    string
  • drawing_number
    string
  • sheet_number
    integer
  • title
    string
  • obsolete
    boolean
  • discipline
    string
GET /rest/v1.0/projects/{project_id}/drawing_areas

List drawing areas

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • filters[exclude_empty_connected]
    booleanquery

Response · 200 · object[]

  • id
    integer
  • name
    string
  • drawings_count
    integer
  • drawing_sets
    object[]
  • drawing_disciplines
    object[]
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • deletable
    boolean
POST /rest/v1.0/projects/{project_id}/drawing_areas

Create drawing area

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired

Request body

  • name
    stringrequired

Response · 201 · object

  • id
    integer
  • name
    string
PATCH /rest/v1.0/projects/{project_id}/drawing_areas/{id}

Update a drawing area

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • name
    string

Response · 200 · object

  • id
    integer
  • name
    string
DELETE /rest/v1.0/projects/{project_id}/drawing_areas/{id}

Delete a drawing area

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · object

  • id
    integer
  • success
    boolean
GET /rest/v1.0/projects/{project_id}/drawing_disciplines

List Drawing Disciplines

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired

Response · 200 · object[]

  • id
    integer
  • name
    string
  • position
    integer
  • abbreviations
    string[]
GET /rest/v1.0/projects/{project_id}/drawing_disciplines/{id}

Show Drawing Discipline

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · object

  • id
    integerrequired
  • name
    stringrequired
  • position
    integer
  • abbreviations
    string[]
PATCH /rest/v1.0/projects/{project_id}/drawing_disciplines/{id}

Update Drawing Discipline

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · object

  • id
    integerrequired
  • name
    stringrequired
  • position
    integer
  • abbreviations
    string[]
POST /rest/v1.0/projects/{project_id}/drawing_revision_emails/{id}/send_email

Send email

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • subject
    string
  • body
    string
  • distribution_ids
    integer[]required
  • cc_distribution_ids
    integer[]
  • bcc_distribution_ids
    integer[]

Response · 204

No response body.

GET /rest/v1.0/projects/{project_id}/drawing_revision_terms

List drawing revision terms

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • drawing_revision_ids
    integer[]query

Response · 200 · object[]

  • drawing_revision_id
    integer
  • updated_at
    string (date-time)
  • terms
    object
GET /rest/v1.0/projects/{project_id}/drawing_revisions

List drawing revisions

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • drawing_area_id
    integerquery
  • drawing_id
    integerquery
  • drawing_discipline_id
    integerquery
  • drawing_set_id
    integerquery
  • id
    integer[]query
  • filters[ids]
    integer[]query
  • filters[updated_at]
    string (date)query
  • filters[deleted]
    stringquery
  • filters[viewer_experience]
    stringquery
  • is_reviewed
    booleanquery
  • query
    stringquery
  • with_obsolete
    booleanquery
  • sort
    stringquery
  • view
    stringquery

Response · 200 · object[]

  • drawing_date
    string (date)
  • drawing_id
    integer
  • drawing_number
    string
  • sheet_number
    integer
  • drawing_sketches_count
    integer
  • height
    integer
  • id
    integer
  • number
    string
  • pdf_size
    integer
  • pdf_url
    string
  • png_size
    integer
  • png_url
    string
  • received_date
    string (date)
  • title
    string
  • updated_at
    string (date-time)
  • width
    integer
  • has_public_markup_layer_elements
    boolean
  • has_drawing_sketches
    boolean
  • current
    boolean
  • floorplan
    boolean
  • revision_number
    string
  • thumbnail_url
    string
  • large_thumbnail_url
    string
  • activity_stream_last_viewed_at
    string
  • position
    integer
  • zip_url
    string
  • obsolete
    boolean
  • viewer_experience
    string
  • connectability_outdated
    boolean
  • drawing_set
    object
  • drawing_area
    object
  • discipline
    object
  • status
    string
  • order_in_drawing
    integer
  • custom_fields
    object
GET /rest/v1.0/projects/{project_id}/drawing_revisions/{drawing_revision_id}/drawing_tiles

List drawing tiles

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • drawing_revision_id
    integerpathrequired

Response · 200 · object

  • max_zoom_level
    integer
  • tile_size
    integer[]
  • zip_url
    string
  • tiles
    object[]
GET /rest/v1.0/projects/{project_id}/drawing_revisions/{id}

Show Drawing Revision

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · object

  • drawing_date
    string (date)
  • drawing_id
    integer
  • drawing_number
    string
  • sheet_number
    integer
  • drawing_sketches_count
    integer
  • height
    integer
  • id
    integer
  • number
    string
  • pdf_size
    integer
  • pdf_url
    string
  • png_size
    integer
  • png_url
    string
  • received_date
    string (date)
  • title
    string
  • updated_at
    string (date-time)
  • width
    integer
  • has_public_markup_layer_elements
    boolean
  • has_drawing_sketches
    boolean
  • current
    boolean
  • floorplan
    boolean
  • revision_number
    string
  • thumbnail_url
    string
  • large_thumbnail_url
    string
  • activity_stream_last_viewed_at
    string
  • position
    integer
  • zip_url
    string
  • obsolete
    boolean
  • viewer_experience
    string
  • connectability_outdated
    boolean
  • drawing_set
    object
  • drawing_area
    object
  • discipline
    object
  • status
    string
  • order_in_drawing
    integer
  • custom_fields
    object
PATCH /rest/v1.0/projects/{project_id}/drawing_revisions/{id}

Update Drawing Revision

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • drawing_revision
    objectrequired

Response · 200 · object

  • id
    integer
  • drawing_date
    string (date)
  • received_date
    string (date)
  • revision_number
    string
  • floorplan
    boolean
  • current
    boolean
  • drawing_id
    integer
  • sheet_number
    integer
  • drawing_set
    object
  • ordered_revision_ids
    integer[]
  • custom_fields
    object
GET /rest/v1.0/projects/{project_id}/drawing_revisions/{id}/markups

List markups for a drawing revision

v1.0Implemented

Parameters

  • project_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · object[]

  • id
    integerrequired
  • project_id
    integer
  • company_id
    integer
  • drawing_revision_id
    integerrequired
  • layer
    stringrequired
  • data
    object[]required
  • elements_count
    integer
  • created_by_id
    integerrequired
  • created_by
    object
  • created_at
    stringrequired
  • updated_at
    string
POST /rest/v1.0/projects/{project_id}/drawing_revisions/{id}/markups

Create a markup layer on a drawing revision

v1.0Implemented

Parameters

  • project_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • markup
    objectrequired

Response · 201 · object

  • id
    integerrequired
  • project_id
    integer
  • company_id
    integer
  • drawing_revision_id
    integerrequired
  • layer
    stringrequired
  • data
    object[]required
  • elements_count
    integer
  • created_by_id
    integerrequired
  • created_by
    object
  • created_at
    stringrequired
  • updated_at
    string
GET /rest/v1.0/projects/{project_id}/drawing_revisions/{id}/markups/{markup_id}

Show a markup

v1.0Implemented

Parameters

  • project_id
    integerpathrequired
  • id
    integerpathrequired
  • markup_id
    integerpathrequired

Response · 200 · object

  • id
    integerrequired
  • project_id
    integer
  • company_id
    integer
  • drawing_revision_id
    integerrequired
  • layer
    stringrequired
  • data
    object[]required
  • elements_count
    integer
  • created_by_id
    integerrequired
  • created_by
    object
  • created_at
    stringrequired
  • updated_at
    string
PATCH /rest/v1.0/projects/{project_id}/drawing_revisions/{id}/markups/{markup_id}

Update a markup layer

v1.0Implemented

Parameters

  • project_id
    integerpathrequired
  • id
    integerpathrequired
  • markup_id
    integerpathrequired

Request body

  • markup
    objectrequired

Response · 200 · object

  • id
    integerrequired
  • project_id
    integer
  • company_id
    integer
  • drawing_revision_id
    integerrequired
  • layer
    stringrequired
  • data
    object[]required
  • elements_count
    integer
  • created_by_id
    integerrequired
  • created_by
    object
  • created_at
    stringrequired
  • updated_at
    string
DELETE /rest/v1.0/projects/{project_id}/drawing_revisions/{id}/markups/{markup_id}

Delete a markup layer

v1.0Implemented

Parameters

  • project_id
    integerpathrequired
  • id
    integerpathrequired
  • markup_id
    integerpathrequired

Response · 204

No response body.

POST /rest/v1.0/projects/{project_id}/drawing_revisions/publish

Publish Drawing Revisions

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired

Request body

  • drawing_set_id
    integerrequired
  • drawing_area_id
    integer
  • distribute
    boolean

Response · 200 · object

  • drawing_revisions
    object[]
  • errors
    string[]
GET /rest/v1.0/projects/{project_id}/drawing_sets

List drawing sets

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • filters[exclude_empty_sets]
    booleanquery
  • filters[only_attachable_sets]
    booleanquery
  • filters[with_sketches]
    booleanquery
  • filters[with_measurements]
    booleanquery
  • drawing_area_id
    integerquery

Response · 200 · object[]

  • id
    integer
  • project_id
    integer
  • company_id
    integer
  • name
    string
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • date
    string (date)
  • position
    integer
  • connected
    boolean
  • deletable
    boolean
  • published_drawings_count
    integer
  • unpublished_drawings_count
    integer
POST /rest/v1.0/projects/{project_id}/drawing_sets

Create drawing set

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired

Request body

  • name
    stringrequired
  • date
    string (date)

Response · 201 · object

  • id
    integer
  • project_id
    integer
  • company_id
    integer
  • name
    string
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • date
    string (date)
  • position
    integer
  • connected
    boolean
  • deletable
    boolean
  • published_drawings_count
    integer
  • unpublished_drawings_count
    integer
PATCH /rest/v1.0/projects/{project_id}/drawing_sets/{id}

Update drawing set

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • drawing_set
    objectrequired

Response · 200 · object

  • id
    integer
  • project_id
    integer
  • company_id
    integer
  • name
    string
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • date
    string (date)
  • position
    integer
  • connected
    boolean
  • deletable
    boolean
  • published_drawings_count
    integer
  • unpublished_drawings_count
    integer
DELETE /rest/v1.0/projects/{project_id}/drawing_sets/{id}

Delete drawing set

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200

No response body.

GET /rest/v1.0/projects/{project_id}/drawing_sheet_index

Sheet Index

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Response · 200 · object[]

  • id
    integerrequired
  • number
    stringrequired
  • drawing_number
    string
  • sheet_number
    integer
  • title
    stringrequired
  • obsolete
    boolean
  • drawing_area_id
    integer
  • drawing_area
    object
  • drawing_discipline_id
    integerrequired
  • discipline
    stringrequired
  • current_revision_number
    string
  • current_revision_id
    integer
GET /rest/v1.0/projects/{project_id}/drawing_uploads

List drawing uploads

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · object[]

  • id
    integer
  • project_id
    integer
  • company_id
    integer
  • created_by_id
    integer
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • error_email_sent
    boolean
  • notify_on_success
    boolean
  • deletion_in_progress
    boolean
  • success_email_sent
    boolean
  • drawing_area_id
    integer
  • status
    string
  • pre_adaptive_complete
    boolean
  • drawing_number_contains_revision
    boolean
  • get_info_from_filename
    boolean
  • language
    string
POST /rest/v1.0/projects/{project_id}/drawing_uploads

Create drawing upload

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • Idempotency-Token
    stringheader

Request body

  • files
    string[]
  • upload_uuids
    string[]
  • drawing_set_id
    integerrequired
  • drawing_area_id
    integer
  • drawing_number_contains_revision
    boolean
  • drawing_date
    string (date)
  • received_date
    string (date)
  • get_info_from_filename
    boolean

Response · 200 · object

  • id
    integer
  • project_id
    integer
  • company_id
    integer
  • created_by_id
    integer
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • error_email_sent
    boolean
  • notify_on_success
    boolean
  • deletion_in_progress
    boolean
  • success_email_sent
    boolean
  • drawing_area_id
    integer
  • status
    string
  • pre_adaptive_complete
    boolean
  • drawing_number_contains_revision
    boolean
  • get_info_from_filename
    boolean
  • language
    string
DELETE /rest/v1.0/projects/{project_id}/drawing_uploads/{id}

Delete drawing upload

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200

No response body.

DELETE /rest/v1.0/projects/{project_id}/drawings/{id}

Delete (recycle) a drawing (os.construction extension)

v1.0Implemented

Parameters

  • project_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200

No response body.

GET /rest/v1.0/projects/{project_id}/drawings/{id}/compare

Compare two revisions of a drawing (os.construction extension)

v1.0Implemented

Parameters

  • project_id
    integerpathrequired
  • id
    integerpathrequired
  • a
    integerqueryrequired
  • b
    integerqueryrequired

Response · 200 · object

  • drawing
    objectrequired
  • revision_a
    objectrequired
  • revision_b
    objectrequired
  • diff
    object[]required
  • changed_count
    integerrequired
  • identical
    booleanrequired
PATCH /rest/v1.0/projects/{project_id}/drawings/{id}/restore

Restore a recycled drawing (os.construction extension)

v1.0Implemented

Parameters

  • project_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · object

  • id
    integerrequired
  • number
    stringrequired
  • drawing_number
    string
  • sheet_number
    string
  • title
    stringrequired
  • obsolete
    booleanrequired
  • discipline
    stringrequired
GET /rest/v1.0/projects/{project_id}/drawings/recycle_bin

List recycled drawings (os.construction extension)

v1.0Implemented

Parameters

  • project_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · object[]

  • id
    integerrequired
  • number
    stringrequired
  • drawing_number
    string
  • sheet_number
    string
  • title
    stringrequired
  • obsolete
    boolean
  • discipline
    stringrequired
  • drawing_discipline_id
    integer
  • drawing_area_id
    integer
  • current_revision_number
    string
  • revisions_count
    integer
  • deleted
    booleanrequired
  • deleted_at
    stringrequired
GET /rest/v1.1/drawing_areas/{drawing_area_id}/drawings

List drawings

v1.1Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • drawing_area_id
    integerpathrequired
  • project_id
    integerquery
  • page
    integerquery
  • per_page
    integerquery
  • filters[drawing_discipline_id]
    integerquery
  • filters[drawing_set_id]
    integerquery
  • with_position
    booleanquery
  • view
    stringquery

Response · 200 · object[]

  • id
    integer
  • discipline
    string
  • drawing_discipline_id
    integer
  • number
    string
  • drawing_number
    string
  • sheet_number
    integer
  • title
    string
  • obsolete
    boolean
  • current_revision
    object
POST /rest/v1.1/drawing_areas/{drawing_area_id}/drawings

Create Drawing

v1.1Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • drawing_area_id
    integerpathrequired

Request body

  • drawing
    objectrequired

Response · 201 · object

  • id
    integer
  • number
    string
  • drawing_number
    string
  • sheet_number
    integer
  • title
    string
  • obsolete
    boolean
  • discipline
    string
PATCH /rest/v1.1/drawing_areas/{drawing_area_id}/drawings/{id}

Update Drawing

v1.1Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • drawing_area_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • drawing
    objectrequired

Response · 200 · object

  • id
    integer
  • number
    string
  • drawing_number
    string
  • sheet_number
    integer
  • title
    string
  • obsolete
    boolean
  • discipline
    string
GET /rest/v1.1/projects/{project_id}/drawing_areas

List drawing areas

v1.1Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • filters[id]
    integer[]query
  • filters[exclude_empty_connected]
    booleanquery
  • view
    stringquery

Response · 200 · object[]

  • id
    integer
  • name
    string
  • drawings_count
    integer
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • deletable
    boolean
  • latest_revision_update
    string (date-time)
  • drawing_sets
    object[]
  • drawing_disciplines
    object[]
POST /rest/v1.1/projects/{project_id}/drawing_areas

Create drawing area

v1.1Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired

Request body

  • name
    stringrequired

Response · 201 · object

  • id
    integer
  • name
    string
PATCH /rest/v1.1/projects/{project_id}/drawing_areas/{id}

Update a drawing area

v1.1Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • name
    string

Response · 200 · object

  • id
    integer
  • name
    string
DELETE /rest/v1.1/projects/{project_id}/drawing_areas/{id}

Delete a drawing area

v1.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · object

  • id
    integer
  • success
    boolean
GET /rest/v1.1/projects/{project_id}/drawing_disciplines

List Drawing Disciplines

v1.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • filters[id]
    integer[]query
  • view
    stringquery
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · object[]

  • id
    integer
  • name
    string
  • position
    integer
  • abbreviations
    string[]
PATCH /rest/v1.1/projects/{project_id}/drawing_disciplines/{id}

Update drawing discipline

v1.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • name
    stringrequired

Response · 200 · object

  • id
    integer
  • name
    string
  • position
    integer
GET /rest/v1.1/projects/{project_id}/drawing_revision_terms

List drawing revision terms

v1.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • drawing_revision_ids
    integer[]query

Response · 200 · object[]

  • drawing_revision_id
    integer
  • updated_at
    string (date-time)
  • terms
    object
GET /rest/v1.1/projects/{project_id}/drawing_uploads

List drawing uploads

v1.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • view
    stringquery

Response · 200 · object[]

  • id
    integer
  • project_id
    integer
  • company_id
    integer
  • created_by_id
    integer
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • error_email_sent
    boolean
  • notify_on_success
    boolean
  • deletion_in_progress
    boolean
  • success_email_sent
    boolean
  • drawing_area_id
    integer
  • status
    string
  • pre_adaptive_complete
    boolean
  • drawing_number_contains_revision
    boolean
  • get_info_from_filename
    boolean
  • language
    string
  • drawing_log_imports
    object[]
POST /rest/v1.1/projects/{project_id}/drawing_uploads

Create drawing upload

v1.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • Idempotency-Token
    stringheader

Request body

  • drawing_upload
    object

Response · 200 · object

  • id
    integer
  • project_id
    integer
  • company_id
    integer
  • created_by_id
    integer
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • error_email_sent
    boolean
  • notify_on_success
    boolean
  • deletion_in_progress
    boolean
  • success_email_sent
    boolean
  • drawing_area_id
    integer
  • status
    string
  • pre_adaptive_complete
    boolean
  • drawing_number_contains_revision
    boolean
  • get_info_from_filename
    boolean
  • language
    string
GET /rest/v1.1/projects/{project_id}/drawing_uploads/{id}

Show Drawing Upload

v1.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • id
    integerpathrequired
  • project_id
    integerpathrequired
  • view
    stringquery

Response · 200 · object

  • id
    integer
  • project_id
    integer
  • company_id
    integer
  • created_by_id
    integer
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • error_email_sent
    boolean
  • notify_on_success
    boolean
  • deletion_in_progress
    boolean
  • success_email_sent
    boolean
  • drawing_area_id
    integer
  • status
    string
  • pre_adaptive_complete
    boolean
  • drawing_number_contains_revision
    boolean
  • get_info_from_filename
    boolean
  • language
    string
  • drawing_log_imports
    object[]
DELETE /rest/v1.1/projects/{project_id}/drawing_uploads/{id}

Delete drawing upload

v1.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • id
    integerpathrequired
  • project_id
    integerpathrequired
  • view
    stringquery

Response · 200

No response body.

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