Esc

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

Specifications

63 endpoints9 implementedAll modules →
  1. POST /rest/v1.0/projects/{project_id}/specification_section_revision_emails/{id}/send_emailSend email
  2. GET /rest/v1.0/projects/{project_id}/specification_section_termsList specification section terms
  3. GET /rest/v1.0/projects/{project_id}/specification_setsList Specification Sets
  4. POST /rest/v1.0/projects/{project_id}/specification_setsCreate Specification Set
  5. GET /rest/v1.0/projects/{project_id}/specification_sets/{id}Show Specification Set
  6. GET /rest/v1.0/projects/{project_id}/specification_uploadsList Specification Uploads
  7. POST /rest/v1.0/projects/{project_id}/specification_uploadsCreate specification upload
  8. GET /rest/v1.0/projects/{project_id}/submittals/filter_options/specification_area_idList Filter Options for Specification Area
  9. GET /rest/v1.0/projects/{project_id}/submittals/filter_options/specification_section_idList Filter Options for Specification Section
  10. GET /rest/v1.0/specification_section_divisionsList Specification Section Divisions for a Project
  11. POST /rest/v1.0/specification_section_divisionsCreate Specification Section Division for a Project
  12. GET /rest/v1.0/specification_section_revisionsList Specification Section Revisions for a Specification Section Division
  13. GET /rest/v1.0/specification_section_revisions/{id}Show Specification Section Revision
  14. GET /rest/v1.0/specification_sectionsList Specification Sections
  15. POST /rest/v1.0/specification_sectionsCreate Specification Section for a Project
  16. GET /rest/v1.1/projects/{project_id}/specification_section_termsList specification section terms
  17. GET /rest/v2.0/companies/{company_id}/projects/{project_id}/external_submittals/filter_options/specification_section_idList existing Specification Section filter options
  18. DELETE /rest/v2.0/companies/{company_id}/projects/{project_id}/specification_area_transfers/{specification_area_transfer_id}Delete Specification Area Transfer
  19. GET /rest/v2.0/companies/{company_id}/projects/{project_id}/specification_configurationConfiguration of Specifications tool
  20. GET /rest/v2.0/companies/{company_id}/projects/{project_id}/specification_configuration/user_permissionsGet the Specifications User Permissions
  21. PATCH /rest/v2.0/companies/{company_id}/projects/{project_id}/specification_configuration/user_permissions/{user_id}Update the Specifications User Permissions
  22. GET /rest/v2.0/companies/{company_id}/projects/{project_id}/specification_section_divisionsList Specification Sections Divisions
  23. GET /rest/v2.0/companies/{company_id}/projects/{project_id}/specification_section_revisionsList Specification Sections Revisions for a Project
  24. GET /rest/v2.0/companies/{company_id}/projects/{project_id}/specification_sectionsList Specification Sections for a Project
  25. GET /rest/v2.0/companies/{company_id}/projects/{project_id}/specification_setsList Specification Sets for a Project
  26. PATCH /rest/v2.0/companies/{company_id}/projects/{project_id}/specification_setsBulk update for Specification Sets for a Project
  27. DELETE /rest/v2.0/companies/{company_id}/projects/{project_id}/specification_uploads/{specification_upload_id}Delete Specification Upload
  28. GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_areasList Specification Areas for a Project
  29. POST /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_areasCreate Specification Area
  30. PUT /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_areas/{specification_area_id}Update Specification Area
  31. DELETE /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_areas/{specification_area_id}Delete Specification Area
  32. GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_areas/{specification_area_id}/specification_section_revisionsList Specification Sections Revisions for a Project
  33. GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_areas/{specification_area_id}/specification_sectionsList Specification Sections for a Project
  34. GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_areas/{specification_area_id}/specification_sections/deletion_logGet list of deleted specification sections for a Project
  35. GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_areas/{specification_area_id}/specification_sections/unreviewed_uploadsGet unreviewed uploads for specification sections for a Project
  36. GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_configurationList Specification Configurations
  37. PATCH /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_configurationUpdate Specification Configurations
  38. GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_configuration/distribution_groupsList distribution groups for Specifications
  39. GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_configuration/potential_distribution_membersList potential distribution members for Specifications
  40. GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_section_divisionsList Specification Section Divisions
  41. POST /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_section_divisionsCreate a Specification Section Division
  42. PATCH /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_section_divisionsUpdate Specification Section Divisions
  43. GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_section_revisionsList Specification Sections Revisions for a Project
  44. GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_section_revisions/{id}Show Specification Section Revision
  45. PUT /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_section_revisions/{id}Update Specification Section Revision
  46. DELETE /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_section_revisions/{id}Destroy Specification Section Revision
  47. GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_section_revisions/{id}/change_historyChange History of Specification Section Revision
  48. GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_section_revisions/{id}/downloadDownload Specification Section Revision
  49. GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_section_revisions/{id}/download_logDownload Log of Specification Section Revision
  50. GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_section_revisions/{id}/header_infoHeader info for Specification Section Revision
  51. POST /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_section_revisions/bulk_updateBulk Update Specification Section Revisions
  52. POST /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_section_revisions/create_zip_downloadDownload zip of Specification Section Revisions
  53. POST /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_section_revisions/single_pdf_downloadDownload single pdf of Specification Section Revisions
  54. GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_sectionsList Specification Sections for a Project
  55. POST /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_sectionsCreate a Specification Section
  56. POST /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_sections/bulk_edit_collectionBulk edit specification sections
  57. GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_sections/client_configsGet Client Configuration for Specification Sections
  58. POST /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_sections/create_submittals_from_specsCreate submittals from specs
  59. GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_sections/deletion_logGet list of deleted specification sections for a Project
  60. DELETE /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_sections/destroy_collectionBulk delete specification sections
  61. GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_sections/divisions_and_setsGet divisions and sets options for specification sections for a Project
  62. GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_sections/flags_and_permissionsGet Permissions and Feature Flags for Specification Sections
  63. GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_sections/unreviewed_uploadsGet unreviewed uploads for specification sections for a Project
POST /rest/v1.0/projects/{project_id}/specification_section_revision_emails/{id}/send_email

Send email

v1.0Documented

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}/specification_section_terms

List specification section terms

v1.0Documented

Parameters

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

Response · 200 · object[]

  • specification_section_id
    integer
  • updated_at
    string (date-time)
  • terms
    object[]
GET /rest/v1.0/projects/{project_id}/specification_sets

List Specification Sets

v1.0Implemented

Parameters

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

Response · 200 · object[]

  • id
    integer
  • project_id
    integer
  • company_id
    integer
  • name
    string
  • created_at
    string (date)
  • deleted_at
    string (date)
  • updated_at
    string (date)
  • date
    string (date)
  • position
    integer
POST /rest/v1.0/projects/{project_id}/specification_sets

Create Specification Set

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired

Request body

  • name
    stringrequired
  • date
    string

Response · 201 · object

  • id
    integer
  • project_id
    integer
  • company_id
    integer
  • name
    string
  • created_at
    string (date)
  • deleted_at
    string (date)
  • updated_at
    string (date)
  • date
    string (date)
  • position
    integer
GET /rest/v1.0/projects/{project_id}/specification_sets/{id}

Show Specification Set

v1.0Implemented

Parameters

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

Response · 200 · object

  • id
    integer
  • project_id
    integer
  • company_id
    integer
  • name
    string
  • created_at
    string (date)
  • deleted_at
    string (date)
  • updated_at
    string (date)
  • date
    string (date)
  • position
    integer
GET /rest/v1.0/projects/{project_id}/specification_uploads

List Specification Uploads

v1.0Documented

Parameters

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

Response · 200 · object[]

  • id
    integer
  • issued_date
    string
  • received_date
    string
  • status
    string
  • spec_format
    string
  • specification_set_id
    integer
  • locale
    string
POST /rest/v1.0/projects/{project_id}/specification_uploads

Create specification upload

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired

Request body

  • specification_set_id
    integerrequired
  • specification_section_id
    integer
  • default_revision
    string
  • files
    string[]
  • upload_uuids
    string[]
  • issued_date
    string
  • received_date
    string
  • ignore_number
    string
  • spec_format
    stringrequired

Response · 201 · object[]

  • id
    integer
  • issued_date
    string
  • received_date
    string
  • status
    string
  • spec_format
    string
  • specification_set_id
    integer
  • locale
    string
GET /rest/v1.0/projects/{project_id}/submittals/filter_options/specification_area_id

List Filter Options for Specification Area

v1.0Documented

Parameters

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

Response · 200 · object[]

  • key
    integer
  • value
    string
GET /rest/v1.0/projects/{project_id}/submittals/filter_options/specification_section_id

List Filter Options for Specification Section

v1.0Documented

Parameters

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

Response · 200 · object[]

  • key
    integer
  • value
    string
GET /rest/v1.0/specification_section_divisions

List Specification Section Divisions for a Project

v1.0Implemented

Parameters

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

Response · 200 · object[]

  • id
    integer
  • number
    string
  • url
    string
POST /rest/v1.0/specification_section_divisions

Create Specification Section Division for a Project

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerquery

Request body

  • specification_section_division
    objectrequired

Response · 201 · object

  • id
    integer
  • number
    string
  • url
    string
GET /rest/v1.0/specification_section_revisions

List Specification Section Revisions for a Specification Section Division

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerqueryrequired
  • specification_section_division_id
    integerqueryrequired
  • all_revisions
    stringquery
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · object[]

  • id
    integer
  • specification_section_id
    integer
  • specification_section_division_id
    integer
  • specification_set_id
    integer
  • number
    string
  • url
    string
  • revision
    string
  • issued_date
    string (date)
  • received_date
    string (date)
  • updated_at
    string
  • custom_fields
    object
GET /rest/v1.0/specification_section_revisions/{id}

Show Specification Section Revision

v1.0Implemented

Parameters

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

Response · 200 · object

  • id
    integer
  • source_id
    integer
  • name
    string
  • section_id
    integer
  • section_name
    string
  • source_create_time
    string (date-time)
  • source_update_time
    string (date-time)
  • url
    string
  • custom_fields
    object
GET /rest/v1.0/specification_sections

List Specification Sections

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerqueryrequired
  • filters[id]
    integer[]query
  • sort
    stringquery

Response · 200 · object[]

  • id
    integer
  • number
    string
  • label
    string
  • current_revision_id
    integer
POST /rest/v1.0/specification_sections

Create Specification Section for a Project

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerqueryrequired

Request body

  • specification_section
    objectrequired

Response · 201 · object

  • id
    integer
  • number
    string
  • label
    string
  • current_revision_id
    integer
GET /rest/v1.1/projects/{project_id}/specification_section_terms

List specification section terms

v1.1Documented

Parameters

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

Response · 200 · object[]

  • specification_section_id
    integer
  • updated_at
    string (date-time)
  • terms
    object[]
GET /rest/v2.0/companies/{company_id}/projects/{project_id}/external_submittals/filter_options/specification_section_id

List existing Specification Section filter options

v2.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · object

  • data
    object[]
DELETE /rest/v2.0/companies/{company_id}/projects/{project_id}/specification_area_transfers/{specification_area_transfer_id}

Delete Specification Area Transfer

v2.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired
  • specification_area_transfer_id
    stringpathrequired
  • specification_area_id
    stringqueryrequired

Response · 200

No response body.

GET /rest/v2.0/companies/{company_id}/projects/{project_id}/specification_configuration

Configuration of Specifications tool

v2.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired

Response · 200 · object

  • data
    object
GET /rest/v2.0/companies/{company_id}/projects/{project_id}/specification_configuration/user_permissions

Get the Specifications User Permissions

v2.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • filters[query]
    stringquery
  • sort
    stringquery

Response · 200 · object

  • data
    object[]
PATCH /rest/v2.0/companies/{company_id}/projects/{project_id}/specification_configuration/user_permissions/{user_id}

Update the Specifications User Permissions

v2.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired
  • user_id
    stringpathrequired
  • user_access_level_id
    stringqueryrequired

Response · 200 · object

  • data
    object
GET /rest/v2.0/companies/{company_id}/projects/{project_id}/specification_section_divisions

List Specification Sections Divisions

v2.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • specification_area_id
    stringquery

Response · 200 · object

  • data
    object[]
GET /rest/v2.0/companies/{company_id}/projects/{project_id}/specification_section_revisions

List Specification Sections Revisions for a Project

v2.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • specification_area_id
    stringquery

Response · 200 · object

  • data
    object[]
GET /rest/v2.0/companies/{company_id}/projects/{project_id}/specification_sections

List Specification Sections for a Project

v2.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • specification_area_id
    stringquery
  • filter_set_id
    stringquery
  • filter_division_id
    stringquery
  • search_string
    stringquery
  • filters[division_ids]
    string[]query

Response · 200 · object

  • data
    object[]
GET /rest/v2.0/companies/{company_id}/projects/{project_id}/specification_sets

List Specification Sets for a Project

v2.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • specification_area_id
    stringquery
  • with_none_set
    stringquery
  • is_recycle_bin
    stringquery

Response · 200 · object

  • data
    object[]
PATCH /rest/v2.0/companies/{company_id}/projects/{project_id}/specification_sets

Bulk update for Specification Sets for a Project

v2.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired

Request body

  • creation_params
    object[]
  • updation_params
    object[]
  • deletion_params
    object[]

Response · 200 · object

  • data
    object[]
DELETE /rest/v2.0/companies/{company_id}/projects/{project_id}/specification_uploads/{specification_upload_id}

Delete Specification Upload

v2.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired
  • specification_upload_id
    stringpathrequired
  • specification_area_id
    stringquery

Response · 200

No response body.

GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_areas

List Specification Areas for a Project

v2.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · object

  • data
    object[]
POST /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_areas

Create Specification Area

v2.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired

Request body

  • specification_area
    objectrequired

Response · 201 · object

  • data
    object
PUT /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_areas/{specification_area_id}

Update Specification Area

v2.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired
  • specification_area_id
    stringpathrequired

Request body

  • specification_area
    objectrequired

Response · 200 · object

  • data
    object
DELETE /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_areas/{specification_area_id}

Delete Specification Area

v2.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired
  • specification_area_id
    stringpathrequired

Response · 200

No response body.

GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_areas/{specification_area_id}/specification_section_revisions

List Specification Sections Revisions for a Project

v2.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired
  • specification_area_id
    stringpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • search_string
    stringquery
  • filter_division_id
    stringquery
  • with_prostore_url
    booleanquery

Response · 200 · object

  • data
    object
GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_areas/{specification_area_id}/specification_sections

List Specification Sections for a Project

v2.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired
  • specification_area_id
    stringpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • filter_set_id
    stringquery
  • filter_division_id
    stringquery
  • search_string
    stringquery
  • filters[division_ids]
    string[]query
  • exclude_ids
    string[]query
  • viewable_document_id_required
    booleanquery

Response · 200 · object

  • data
    object[]
GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_areas/{specification_area_id}/specification_sections/deletion_log

Get list of deleted specification sections for a Project

v2.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired
  • specification_area_id
    stringpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • filter_set_id
    stringquery
  • filter_division_id
    stringquery
  • filter_division_ids
    string[]query
  • search_string
    stringquery
  • exclude_ids
    string[]query

Response · 200 · object

  • data
    object[]
GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_areas/{specification_area_id}/specification_sections/unreviewed_uploads

Get unreviewed uploads for specification sections for a Project

v2.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired
  • specification_area_id
    stringpathrequired

Response · 200 · object

  • data
    object
GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_configuration

List Specification Configurations

v2.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired
  • specification_configuration
    objectqueryrequired

Response · 200 · object

  • data
    object
PATCH /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_configuration

Update Specification Configurations

v2.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired
  • specification_configuration
    objectqueryrequired

Response · 200 · object

  • data
    object
GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_configuration/distribution_groups

List distribution groups for Specifications

v2.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · object

  • data
    object[]
GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_configuration/potential_distribution_members

List potential distribution members for Specifications

v2.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · object

  • data
    object[]
GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_section_divisions

List Specification Section Divisions

v2.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • specification_area_id
    stringquery
  • id
    stringquery
  • search_string
    stringquery
  • specification_set_ids
    string[]query
  • with_sections
    stringquery
  • view
    stringquery
  • no_filter
    booleanquery

Response · 200 · object

  • data
    object[]
POST /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_section_divisions

Create a Specification Section Division

v2.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired

Request body

  • specification_section_division
    objectrequired

Response · 200 · object

  • data
    object[]
PATCH /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_section_divisions

Update Specification Section Divisions

v2.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired

Request body

  • creation_params
    object[]
  • updation_params
    object[]
  • deletion_params
    object[]

Response · 200 · object

  • data
    object[]
GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_section_revisions

List Specification Sections Revisions for a Project

v2.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • search_string
    stringquery
  • filter_division_id
    stringquery
  • with_prostore_url
    booleanquery

Response · 200 · object

  • data
    object
GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_section_revisions/{id}

Show Specification Section Revision

v2.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired
  • id
    stringpathrequired
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · object

  • data
    object
PUT /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_section_revisions/{id}

Update Specification Section Revision

v2.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired
  • id
    stringpathrequired

Request body

  • specification_section
    object
  • specification_section_revision
    object

Response · 200 · object

  • data
    object[]
DELETE /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_section_revisions/{id}

Destroy Specification Section Revision

v2.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · object

  • data
    object
GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_section_revisions/{id}/change_history

Change History of Specification Section Revision

v2.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired
  • id
    stringpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • sort
    stringquery

Response · 200 · object

  • data
    object
GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_section_revisions/{id}/download

Download Specification Section Revision

v2.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · object

  • data
    object
GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_section_revisions/{id}/download_log

Download Log of Specification Section Revision

v2.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired
  • id
    stringpathrequired
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · object

  • data
    object[]
GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_section_revisions/{id}/header_info

Header info for Specification Section Revision

v2.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · object

  • data
    object
POST /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_section_revisions/bulk_update

Bulk Update Specification Section Revisions

v2.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired

Request body

  • id
    stringrequired
  • issued_date
    string
  • received_date
    string
  • specification_set_id
    string
  • revision
    string

Response · 200 · object

  • data
    object
POST /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_section_revisions/create_zip_download

Download zip of Specification Section Revisions

v2.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired

Request body

  • specification_section_revision_ids
    string[]required
  • has_public_markup
    boolean

Response · 200 · object

  • data
    object
POST /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_section_revisions/single_pdf_download

Download single pdf of Specification Section Revisions

v2.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired

Request body

  • specification_section_revision_ids
    string[]required

Response · 200 · object

  • data
    object
GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_sections

List Specification Sections for a Project

v2.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • specification_area_id
    stringquery
  • filter_set_id
    stringquery
  • filter_division_id
    stringquery
  • search_string
    stringquery
  • filters[division_ids]
    string[]query
  • viewable_document_id_required
    booleanquery

Response · 200 · object

  • data
    object[]
POST /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_sections

Create a Specification Section

v2.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired

Request body

  • specification_area_id
    string
  • specification_section
    objectrequired

Response · 200 · object

  • data
    object[]
POST /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_sections/bulk_edit_collection

Bulk edit specification sections

v2.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired

Request body

  • specification_section_revision_ids
    string[]required
  • specification_sections
    object
  • specification_section_revisions
    object

Response · 200 · object

  • data
    object
GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_sections/client_configs

Get Client Configuration for Specification Sections

v2.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired

Response · 200 · object

  • data
    object
POST /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_sections/create_submittals_from_specs

Create submittals from specs

v2.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired

Request body

  • specification_section_revision_ids
    string[]required
  • user_instructions
    string

Response · 200

No response body.

GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_sections/deletion_log

Get list of deleted specification sections for a Project

v2.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • filter_set_id
    stringquery
  • filter_division_id
    stringquery
  • filter_division_ids
    string[]query
  • search_string
    stringquery
  • exclude_ids
    string[]query

Response · 200 · object

  • data
    object[]
DELETE /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_sections/destroy_collection

Bulk delete specification sections

v2.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired

Request body

  • specification_section_revision_ids
    string[]required

Response · 200 · object

  • data
    object
GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_sections/divisions_and_sets

Get divisions and sets options for specification sections for a Project

v2.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · object

  • data
    object
GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_sections/flags_and_permissions

Get Permissions and Feature Flags for Specification Sections

v2.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired

Response · 200 · object

  • data
    object
GET /rest/v2.1/companies/{company_id}/projects/{project_id}/specification_sections/unreviewed_uploads

Get unreviewed uploads for specification sections for a Project

v2.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired

Response · 200 · object

  • data
    object

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