POST /rest/v1.0/observations/items
Creates an Observation Item.
Servers
- https://api.procore.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Procore-Company-Id |
Integer | Yes |
Unique company identifier associated with the Procore User Account. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
run_configurable_validations |
Boolean | No |
Whether or not Configurable validations from the Observation Items Category Configurable Field Set should be run (default: false). See (https://developers.procore.com/reference/observations#list-observation-category-configurable-field-sets) for a list of Observation Category configurable validations enabled on this project. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
project_id |
Integer | Yes |
The ID of the Project the Observation Item belongs to |
inspection_item_failed |
Integer | No |
1 denotes that this Observation Item is being created from a failed Checklist Item. This will update the status of the Checklist Item to 'no' (fail). |
observation |
Object | Yes |
Item object |
observation.contributing_condition_id |
Integer | No |
The ID of the Contributing Condition associated to the Observation Item |
observation.specification_section_id |
Integer | No |
The ID of the specification section to set on the Observation. |
observation.description |
String | No |
The Description of the Observation Item |
observation.distribution_member_ids[] |
Array | No |
An array of the User IDs of the Observation Item distribution members |
observation.document_management_document_revision_ids[] |
Array | No |
PDM document to attach to the response |
observation.drawing_revision_ids[] |
Array | No |
Drawing Revisions to attach to the response |
observation.trade_id |
Integer | No |
The ID of the Trade of the Observation Item |
observation.hazard_id |
Integer | No |
The ID of the Hazard associated to the Observation Item |
observation.custom_field_%{custom_field_definition_id} |
Object | No |
Value of the custom field. The data type of the value passed in corresponds with the data_type of the Custom Field Definition. For a lov_entry data_type the value passed in should be the ID of one of the Custom Field Definition's LOV Entries. For a lov_entries data_type the value passed in should be an array of IDs of the Custom Field Definition's LOV Entries. |
observation.priority |
String | No |
The Priority of the Observation Item Possible values:
|
observation.contributing_behavior_id |
Integer | No |
The ID of the Contributing Behavior associated to the Observation Item |
observation.type_id |
Integer | Yes |
The ID of the Type of the Observation Item |
observation.assignee_id |
Integer | No |
The ID of the User that will be assigned to the Observation Item |
observation.incident_action_id |
Integer | No |
Sets the origin to the ID of an Incident Action (Note: the Item's origin can either be a coordination_issue_id, checklist_list_id or incident_action_id) |
observation.checklist_item_id |
Integer | No |
Sets the origin to the ID of a Checklist Item (Note: the Item's origin can either be a coordination_issue_id, checklist_list_id or incident_action_id) |
observation.mt_location[] |
Array | No |
Use this for creating a new multi-tier or single-tier Location. This will be ignored if |
observation.personal |
Boolean | No |
The Privacy status of the Observation Item |
observation.file_version_ids[] |
Array | No |
File Versions to attach to the response |
observation.image_ids[] |
Array | No |
Images to attach to the response |
observation.number |
Integer | No |
The Number of the Observation Item |
observation.upload_ids[] |
Array | No |
Uploads to attach to the response |
observation.status |
String | No |
The Status of the Observation Item Possible values:
|
observation.location_id |
Integer | No |
The ID of the Location of the Observation Item. |
observation.coordination_issue_id |
Integer | No |
Sets the origin to the ID of a Coordination Issue (Note: the Item's origin can either be a coordination_issue_id, checklist_list_id or incident_action_id) |
observation.form_ids[] |
Array | No |
Forms to attach to the response |
observation.name |
String | Yes |
The Name of the Observation Item |
observation.created_by_id |
Integer | No |
The ID of the User creating the Observation Item. Only Observations Admin Users can set the creator |
observation.due_date |
String | No |
The Due Date of the Observation Item |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.