PATCH /rest/v1.0/projects/{project_id}/generic_tools/{generic_tool_id}/generic_tool_items
Update all selected Generic Tool Items. For more information on Generic Tool and Correspondence Tool endpoints, see Working with the Correspondence Tool.
Servers
- https://api.procore.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
project_id |
Integer | Yes |
Unique identifier for the project. |
generic_tool_id |
Integer | Yes |
Unique identifier for the Generic Tool |
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 |
|---|---|---|---|
completion_mode |
String | No |
Whether to update what can be or nothing if one can not be updated. Defaults to "all_or_nothing" Possible values:
|
view |
String | No |
If supplied customize the response format Possible values:
|
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
generic_tool_items[] |
Array | Yes | |
generic_tool_items[].specification_section_id |
Integer | No |
The specification section identifier for the generic tool item. |
generic_tool_items[].task_ids[] |
Array | No | |
generic_tool_items[].sub_job_id |
Integer | No |
The sub job identifier for the generic tool item. |
generic_tool_items[].cost_impact_value |
String | No |
Specifies a value for the cost impact of the generic tool item. |
generic_tool_items[].quantity |
Integer | No |
The quantity of the generic tool item. |
generic_tool_items[].uom |
String | No |
Unit of measure for the quantity field |
generic_tool_items[].status |
String | No |
The status of the generic tool item. |
generic_tool_items[].assignee_ids[] |
Array | No | |
generic_tool_items[].cost_impact |
String | No |
The cost impact of the generic tool item. |
generic_tool_items[].trade_id |
Integer | No |
The trade identifier for the generic tool item. |
generic_tool_items[].custom_field_%{custom_field_definition_id} |
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. |
|
generic_tool_items[].id |
Integer | Yes |
The unique idenfitier of the generic tool item. |
generic_tool_items[].schedule_impact |
String | No |
The schedule impact of the generic tool item. |
generic_tool_items[].schedule_impact_value |
String | No |
Specifies a value for the schedue impact of the generic tool item. |
generic_tool_items[].location_id |
Integer | No |
The location identifier for the generic tool item. |
generic_tool_items[].trade_ids[] |
Array | No | |
generic_tool_items[].private |
Boolean | No |
If this property is set to true, the generic tool item is private. If this property is set to false, the generic tool item is not private. |
generic_tool_items[].received_from_id |
Integer | No |
The unique identifier for the Received From entity for the generic tool item. |
generic_tool_items[].due_date |
String | No |
The due date for the generic tool item. |
generic_tool_items[].cost_code_id |
Integer | No |
The cost code identifier for the generic tool 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.