PATCH /rest/v1.1/projects/{project_id}/checklist/lists/{id}
Updates a specified Checklist (Inspection)
Servers
- https://api.procore.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
Integer | Yes |
Checklist ID |
project_id |
Integer | Yes |
Unique identifier for the project. |
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 |
If true, validations are run for the corresponding Configurable Field Set. Default value: false |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
list |
Object | Yes | |
list.file_version_ids[] |
Array | No |
File Versions to attach to the response |
list.point_of_contact_id |
Integer | No |
The ID of the Inspection's Point of Contact |
list.description |
String | No |
Description of the Inspection |
list.distribution_member_ids[] |
Array | No |
The IDs of the Distribution Members for the Inspection |
list.image_ids[] |
Array | No |
Images to attach to the response |
list.document_management_document_revision_ids[] |
Array | No |
PDM document to attach to the response |
list.number |
Integer | No |
The Number of the Checklist. If no number is passed in, the next available number will be used. |
list.upload_ids[] |
Array | No |
Uploads to attach to the response |
list.status |
String | No |
The Inspection's status Possible values:
|
list.inspection_type_id |
Integer | No |
The ID of the Inspection's Type |
list.drawing_revision_ids[] |
Array | No |
Drawing Revisions to attach to the response |
list.trade_id |
Integer | No |
The ID of the Trade involved in the Inspection |
list.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. |
list.inspector_ids[] |
Array | No |
The IDs of the Inspectors performing the Inspection |
list.location_id |
Integer | No |
The ID of the Location of the Inspection |
list.form_ids[] |
Array | No |
Forms to attach to the response |
list.name |
String | No |
The Name of the Inspection |
list.spec_section_id |
Integer | No |
The ID of the Inspection's Specification Section |
list.identifier |
String | No |
Identifier of the Inspection |
list.due_at |
String | No |
Timestamp indicating when the Inspection is due. |
list.private |
Boolean | No |
Indicates whether this Inspection is private Default value: true |
list.responsible_contractor_id |
Integer | No |
The ID of the Inspection's Responsible Contractor |
list.inspection_date |
String | No |
Date of the Inspection |
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.