Esc

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

Observations

28 endpoints23 implementedAll modules →
  1. GET /rest/v1.0/observations/assigneesList Observation Assignee options
  2. GET /rest/v1.0/observations/category_configurable_field_setsList Observation Category Configurable Field Sets
  3. GET /rest/v1.0/observations/default_distributionList Observation Default Distribution Members
  4. GET /rest/v1.0/observations/itemsList Observation Items
  5. POST /rest/v1.0/observations/itemsCreate Observation Item
  6. GET /rest/v1.0/observations/items/{id}Show Observation Item
  7. PATCH /rest/v1.0/observations/items/{id}Update Observation Item
  8. GET /rest/v1.0/observations/items/{id}/pdfGet Observation Item PDF url
  9. POST /rest/v1.0/observations/items/{id}/send_emailSend Observation Item Email
  10. GET /rest/v1.0/observations/items/{item_id}/response_logsList Observation Item Response Logs
  11. POST /rest/v1.0/observations/items/{item_id}/response_logsCreate Observation Item Response Log
  12. GET /rest/v1.0/observations/items/next_available_numberShow Next Available Number for Observation Items
  13. POST /rest/v1.0/observations/items/send_unsentSend unsent Observation Items
  14. GET /rest/v1.0/observations/potential_distribution_membersList Observation Potential Distribution Members
  15. GET /rest/v1.0/observations/typesList Observation Types
  16. GET /rest/v1.0/projects/{project_id}/checklist/list_item_observationsList Checklist Item Observations
  17. GET /rest/v1.0/projects/{project_id}/observation_templates
  18. POST /rest/v1.0/projects/{project_id}/observation_templates
  19. GET /rest/v1.0/projects/{project_id}/observation_templates/{id}
  20. PATCH /rest/v1.0/projects/{project_id}/observation_templates/{id}
  21. DELETE /rest/v1.0/projects/{project_id}/observation_templates/{id}
  22. POST /rest/v1.0/projects/{project_id}/observation_templates/{id}/create_observation
  23. DELETE /rest/v1.0/projects/{project_id}/observations/items/{id}Delete Observation Item
  24. GET /rest/v1.0/projects/{project_id}/observations/items/statusesList available Observation Item statuses with localized labels
  25. GET /rest/v1.0/projects/{project_id}/observations/response_logsList Observations Response Logs
  26. GET /rest/v1.0/projects/{project_id}/recycle_bin/observations/itemsList Recycled Observation Items
  27. GET /rest/v1.0/projects/{project_id}/recycle_bin/observations/items/{id}Show Recycled Observation
  28. PATCH /rest/v1.0/projects/{project_id}/recycle_bin/observations/items/{id}/restoreRetrieve Recycled Observation
GET /rest/v1.0/observations/assignees

List Observation Assignee options

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerqueryrequired
  • page
    integerquery
  • per_page
    integerquery
  • filters[category_id]
    integerquery

Response · 200 · object[]

  • id
    integer
  • name
    string
  • vendor
    object
GET /rest/v1.0/observations/category_configurable_field_sets

List Observation Category Configurable Field Sets

v1.0Documented

Parameters

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

Response · 200 · object[]

  • id
    integerrequired
  • category
    stringrequired
  • category_key
    string
  • observations_category_id
    integer
  • configurable_field_set
    objectrequired
GET /rest/v1.0/observations/default_distribution

List Observation Default Distribution Members

v1.0Implemented

Parameters

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

Response · 200 · object[]

  • id
    integer
  • login
    string
  • name
    string
GET /rest/v1.0/observations/items

List Observation Items

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • filters[assignee_company_id]
    integer[]query
  • filters[checklist_list_id]
    string[]query
  • filters[created_by_id]
    integer[]query
  • filters[id]
    integer[]query
  • filters[location_id]
    integer[]query
  • filters[assignee_id]
    integer[]query
  • filters[checklist_item_id]
    integerquery
  • filters[custom_fields]
    objectquery
  • filters[priority]
    string[]query
  • filters[search]
    stringquery
  • filters[status]
    integer[]query
  • filters[type_id]
    integer[]query
  • filters[trade_ids]
    integer[]query
  • filters[updated_at]
    string (date)query
  • project_id
    integerqueryrequired
  • page
    integerquery
  • per_page
    integerquery
  • sort
    stringquery
  • view
    stringquery

Response · 200 · object[]

  • id
    integer
  • created_at
    string (date-time)
  • closed_at
    string (date-time)
  • deleted_at
    string (date-time)
  • updated_at
    string (date-time)
  • number
    string
  • name
    string
  • description_rich_text
    string
  • status
    string
  • priority
    string
  • date_notified
    string (date)
  • due_date
    string (date)
  • personal
    boolean
  • origin
    object
  • assignee
    object
  • assignees
    object[]
  • created_by
    object
  • location
    object
  • specification_section
    object
  • trade
    object
  • category
    object
  • type
    object
  • custom_fields
    object
  • permissions
    object
POST /rest/v1.0/observations/items

Create Observation Item

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • run_configurable_validations
    booleanquery
  • view
    stringquery

Request body

  • project_id
    integerrequired
  • inspection_item_failed
    integer
  • observation
    objectrequired

Response · 201 · object

  • id
    integer
  • number
    string
  • name
    string
  • description_rich_text
    string
  • status
    string
  • checklist_item
    object
  • checklist_list
    object
  • priority
    string
  • date_notified
    string (date)
  • due_date
    string (date)
  • closed_at
    string (date-time)
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • deleted_at
    string (date-time)
  • personal
    boolean
  • asset_ids
    string[]
  • current_drawing_revision_ids
    integer[]
  • drawing_revisions
    integer[]
  • drawing_ids
    integer[]
  • origin
    object
  • viewpoint
    object
  • attachments
    object[]
  • assignee
    object
  • assignees
    object[]
  • distribution_members
    object[]
  • distribution_member_ids
    integer[]
  • created_by
    object
  • specification_section
    object
  • location
    object
  • trade
    object
  • type
    object
  • contributing_behavior
    object
  • contributing_condition
    object
  • hazard
    object
  • download_all_attachments_uuid
    string
  • custom_fields
    object
GET /rest/v1.0/observations/items/{id}

Show Observation Item

v1.0Implemented

Parameters

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

Response · 200 · object

  • id
    integer
  • number
    string
  • name
    string
  • description_rich_text
    string
  • status
    string
  • checklist_item
    object
  • checklist_list
    object
  • priority
    string
  • date_notified
    string (date)
  • due_date
    string (date)
  • closed_at
    string (date-time)
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • deleted_at
    string (date-time)
  • personal
    boolean
  • asset_ids
    string[]
  • current_drawing_revision_ids
    integer[]
  • drawing_revisions
    integer[]
  • drawing_ids
    integer[]
  • origin
    object
  • viewpoint
    object
  • attachments
    object[]
  • assignee
    object
  • assignees
    object[]
  • distribution_members
    object[]
  • distribution_member_ids
    integer[]
  • created_by
    object
  • specification_section
    object
  • location
    object
  • trade
    object
  • type
    object
  • contributing_behavior
    object
  • contributing_condition
    object
  • hazard
    object
  • download_all_attachments_uuid
    string
  • custom_fields
    object
PATCH /rest/v1.0/observations/items/{id}

Update Observation Item

v1.0Implemented

Parameters

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

Request body

  • project_id
    integerrequired
  • observation
    objectrequired

Response · 200 · object

  • id
    integer
  • number
    string
  • name
    string
  • description_rich_text
    string
  • status
    string
  • checklist_item
    object
  • checklist_list
    object
  • priority
    string
  • date_notified
    string (date)
  • due_date
    string (date)
  • closed_at
    string (date-time)
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • deleted_at
    string (date-time)
  • personal
    boolean
  • asset_ids
    string[]
  • current_drawing_revision_ids
    integer[]
  • drawing_revisions
    integer[]
  • drawing_ids
    integer[]
  • origin
    object
  • viewpoint
    object
  • attachments
    object[]
  • assignee
    object
  • assignees
    object[]
  • distribution_members
    object[]
  • distribution_member_ids
    integer[]
  • created_by
    object
  • specification_section
    object
  • location
    object
  • trade
    object
  • type
    object
  • contributing_behavior
    object
  • contributing_condition
    object
  • hazard
    object
  • download_all_attachments_uuid
    string
  • custom_fields
    object
GET /rest/v1.0/observations/items/{id}/pdf

Get Observation Item PDF url

v1.0Documented

Parameters

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

Response · 200 · object

  • id
    integer
  • url
    string
  • pdf_url
    string
POST /rest/v1.0/observations/items/{id}/send_email

Send Observation Item Email

v1.0Implemented

Parameters

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

Request body

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

Response · 200

No response body.

GET /rest/v1.0/observations/items/{item_id}/response_logs

List Observation Item Response Logs

v1.0Documented

Parameters

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

Response · 200 · object[]

  • id
    integer
  • item_id
    integer
  • status
    string
  • comment
    string
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • created_by_name
    string
  • attachments
    object[]
  • created_by
    object
POST /rest/v1.0/observations/items/{item_id}/response_logs

Create Observation Item Response Log

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • item_id
    integerpathrequired
  • run_configurable_validations
    booleanquery

Request body

  • project_id
    integerrequired
  • response_log
    objectrequired
  • status
    string

Response · 201 · object

  • id
    integer
  • item_id
    integer
  • status
    string
  • comment
    string
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • created_by_name
    string
  • attachments
    object[]
  • created_by
    object
GET /rest/v1.0/observations/items/next_available_number

Show Next Available Number for Observation Items

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerqueryrequired

Response · 200 · object

  • next_available_number
    string
POST /rest/v1.0/observations/items/send_unsent

Send unsent Observation Items

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired

Request body

  • project_id
    integerrequired

Response · 200 · object[]

  • id
    integer
  • created_at
    string (date-time)
  • closed_at
    string (date-time)
  • deleted_at
    string (date-time)
  • updated_at
    string (date-time)
  • number
    string
  • name
    string
  • description_rich_text
    string
  • status
    string
  • priority
    string
  • date_notified
    string (date)
  • due_date
    string (date)
  • personal
    boolean
  • origin
    object
  • assignee
    object
  • assignees
    object[]
  • created_by
    object
  • location
    object
  • specification_section
    object
  • trade
    object
  • category
    object
  • type
    object
  • custom_fields
    object
  • permissions
    object
GET /rest/v1.0/observations/potential_distribution_members

List Observation Potential Distribution Members

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerqueryrequired
  • page
    integerquery
  • per_page
    integerquery
  • filters[search]
    stringquery
  • filters[category_id]
    integerquery

Response · 200 · object[]

  • id
    integer
  • login
    string
  • name
    string
GET /rest/v1.0/observations/types

List Observation Types

v1.0Implemented

Parameters

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

Response · 200 · object[]

  • id
    integerrequired
  • category
    stringrequired
  • category_key
    string
  • category_id
    integerrequired
  • name
    stringrequired
  • active
    boolean
  • company_active
    boolean
  • parent_inactive
    boolean
  • in_use
    boolean
  • kind
    string
  • name_translations
    object
  • localized_name
    string
GET /rest/v1.0/projects/{project_id}/checklist/list_item_observations

List Checklist Item Observations

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • filters[id]
    integer[]query
  • filters[item_id]
    integer[]query
  • filters[created_at]
    string (date)query
  • filters[updated_at]
    string (date)query
  • sort
    stringquery

Response · 200 · object[]

  • id
    integer
  • checklist_item_id
    integer
  • checklist_list_id
    integer
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • created_by
    object
GET /rest/v1.0/projects/{project_id}/observation_templates

GET projects/{project_id}/observation_templates

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Response · 200 · object[]

  • id
    integerrequired
  • name
    stringrequired
  • observation_title
    string
  • active
    booleanrequired
  • company_observation_template_id
    integer
  • observation_type
    object
  • priority
    string
  • trade
    object
  • assignee
    object
  • assignees
    object[]
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
POST /rest/v1.0/projects/{project_id}/observation_templates

POST projects/{project_id}/observation_templates

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Response · 201 · object

  • id
    integerrequired
  • name
    stringrequired
  • observation_title
    string
  • active
    booleanrequired
  • company_observation_template_id
    integer
  • observation_type
    object
  • priority
    string
  • trade
    object
  • assignee
    object
  • assignees
    object[]
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
GET /rest/v1.0/projects/{project_id}/observation_templates/{id}

GET projects/{project_id}/observation_templates/{id}

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · object

  • id
    integerrequired
  • name
    stringrequired
  • observation_title
    string
  • active
    booleanrequired
  • company_observation_template_id
    integer
  • observation_type
    object
  • priority
    string
  • trade
    object
  • assignee
    object
  • assignees
    object[]
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
PATCH /rest/v1.0/projects/{project_id}/observation_templates/{id}

PATCH projects/{project_id}/observation_templates/{id}

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · object

  • id
    integerrequired
  • name
    stringrequired
  • observation_title
    string
  • active
    booleanrequired
  • company_observation_template_id
    integer
  • observation_type
    object
  • priority
    string
  • trade
    object
  • assignee
    object
  • assignees
    object[]
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
DELETE /rest/v1.0/projects/{project_id}/observation_templates/{id}

DELETE projects/{project_id}/observation_templates/{id}

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 204

No response body.

POST /rest/v1.0/projects/{project_id}/observation_templates/{id}/create_observation

POST projects/{project_id}/observation_templates/{id}/create_observation

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 201 · object

  • id
    integer
  • number
    string
  • name
    string
  • description_rich_text
    string
  • status
    string
  • checklist_item
    object
  • checklist_list
    object
  • priority
    string
  • date_notified
    string (date)
  • due_date
    string (date)
  • closed_at
    string (date-time)
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • deleted_at
    string (date-time)
  • personal
    boolean
  • asset_ids
    string[]
  • current_drawing_revision_ids
    integer[]
  • drawing_revisions
    integer[]
  • drawing_ids
    integer[]
  • origin
    object
  • viewpoint
    object
  • attachments
    object[]
  • assignee
    object
  • assignees
    object[]
  • distribution_members
    object[]
  • distribution_member_ids
    integer[]
  • created_by
    object
  • specification_section
    object
  • location
    object
  • trade
    object
  • type
    object
  • contributing_behavior
    object
  • contributing_condition
    object
  • hazard
    object
  • download_all_attachments_uuid
    string
  • custom_fields
    object
DELETE /rest/v1.0/projects/{project_id}/observations/items/{id}

Delete Observation Item

v1.0Implemented

Parameters

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

Response · 204

No response body.

GET /rest/v1.0/projects/{project_id}/observations/items/statuses

List available Observation Item statuses with localized labels

v1.0Implemented

Parameters

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

Response · 200 · object[]

  • value
    string
  • label
    string
GET /rest/v1.0/projects/{project_id}/observations/response_logs

List Observations Response Logs

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • filters[id]
    integer[]query
  • filters[updated_at]
    string (date)query

Response · 200 · object[]

  • id
    integer
  • item_id
    integer
  • status
    string
  • comment
    string
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • created_by_name
    string
  • attachments
    object[]
  • created_by
    object
GET /rest/v1.0/projects/{project_id}/recycle_bin/observations/items

List Recycled Observation Items

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • filters[type_id]
    integer[]query
  • filters[trade_ids]
    integer[]query
  • filters[assignee_id]
    integer[]query
  • filters[status]
    integer[]query
  • filters[priority]
    string[]query
  • filters[location_id]
    integer[]query
  • filters[created_by_id]
    integer[]query
  • filters[assignee_company_id]
    integer[]query
  • filters[updated_at]
    string (date)query

Response · 200 · object[]

  • id
    integer
  • created_at
    string (date-time)
  • closed_at
    string (date-time)
  • deleted_at
    string (date-time)
  • updated_at
    string (date-time)
  • number
    string
  • name
    string
  • description_rich_text
    string
  • status
    string
  • priority
    string
  • date_notified
    string (date)
  • due_date
    string (date)
  • personal
    boolean
  • origin
    object
  • assignee
    object
  • assignees
    object[]
  • created_by
    object
  • location
    object
  • specification_section
    object
  • trade
    object
  • category
    object
  • type
    object
  • custom_fields
    object
  • permissions
    object
GET /rest/v1.0/projects/{project_id}/recycle_bin/observations/items/{id}

Show Recycled Observation

v1.0Implemented

Parameters

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

Response · 200 · object

  • id
    integer
  • number
    string
  • name
    string
  • description_rich_text
    string
  • status
    string
  • priority
    string
  • date_notified
    string (date)
  • due_date
    string (date)
  • closed_at
    string (date-time)
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • deleted_at
    string (date-time)
  • personal
    boolean
  • current_drawing_revision_ids
    integer[]
  • drawing_revisions
    integer[]
  • drawing_ids
    integer[]
  • origin
    object
  • attachments
    object[]
  • assignee
    object
  • distribution_members
    object[]
  • created_by
    object
  • specification_section
    object
  • location
    object
  • trade
    object
  • type
    object
  • category
    object
  • assignees
    object[]
  • permissions
    object
  • viewpoint
    object
  • hazard_id
    integer
  • location_id
    integer
  • trade_id
    integer
  • overdue
    boolean
  • contributing_behavior
    object
  • contributing_condition
    object
  • hazard
    object
  • custom_fields
    object
PATCH /rest/v1.0/projects/{project_id}/recycle_bin/observations/items/{id}/restore

Retrieve Recycled Observation

v1.0Implemented

Parameters

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

Response · 200 · object

  • id
    integer
  • number
    string
  • name
    string
  • description_rich_text
    string
  • status
    string
  • priority
    string
  • date_notified
    string (date)
  • due_date
    string (date)
  • closed_at
    string (date-time)
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • deleted_at
    string (date-time)
  • personal
    boolean
  • current_drawing_revision_ids
    integer[]
  • drawing_revisions
    integer[]
  • drawing_ids
    integer[]
  • origin
    object
  • attachments
    object[]
  • assignee
    object
  • distribution_members
    object[]
  • created_by
    object
  • specification_section
    object
  • location
    object
  • trade
    object
  • type
    object
  • category
    object
  • assignees
    object[]
  • permissions
    object
  • viewpoint
    object
  • hazard_id
    integer
  • location_id
    integer
  • trade_id
    integer
  • overdue
    boolean
  • contributing_behavior
    object
  • contributing_condition
    object
  • hazard
    object
  • custom_fields
    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