POST /rest/v1.0/projects/{project_id}/generic_tools/{generic_tool_id}/generic_tool_items

Create a new Generic Tool Item in the specified Project and Generic Tool. 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

Name	Type	Required	Description
`view`	String	No	If supplied customize the response format Possible values: `"extended"`

view

String

If supplied customize the response format

Possible values:

"extended"

Request body fields

Name	Type	Required	Description
`generic_tool_item`	Object	Yes
`generic_tool_item.specification_section_id`	Integer	No	The specification section identifier for the generic tool item.
`generic_tool_item.cost_impact_value`	String	No	Specifies a value for the cost impact of the generic tool item.
`generic_tool_item.description`	String	No	The description of the generic tool item.
`generic_tool_item.distribution_member_ids[]`	Array	No	An array of distribution member identifiers for the generic tool item.
`generic_tool_item.document_management_document_revision_ids[]`	Array	No	PDM document to attach to the response
`generic_tool_item.assignee_ids[]`	Array	No	An array of assignee identifiers for the generic tool item.
`generic_tool_item.position`	String	No	The position/number of the generic tool item.
`generic_tool_item.cost_impact`	String	No	The cost impact of the generic tool item. Possible values: `"no_impact"` `"n_a"` `"yes_unknown"` `"tbd"` `"yes_known"`
`generic_tool_item.drawing_revision_ids[]`	Array	No	Drawing Revisions to attach to the response
`generic_tool_item.trade_id`	Integer	No	The trade identifier for the generic tool item.
`generic_tool_item.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_item.schedule_impact_value`	String	No	Specifies a value for the schedue impact of the generic tool item.
`generic_tool_item.attachments[]`	Array	No	Specifies an array of generic tool item attachments. To upload attachments you must upload the entire payload as a `multipart/form-data` content-type and specify each parameter as form-data together with `attachments[]` as files.
`generic_tool_item.attachments[].id`	Integer	No	ID
`generic_tool_item.attachments[].url`	String	No	URL
`generic_tool_item.attachments[].filename`	String	No	Filename
`generic_tool_item.title`	String	No	The title of the generic tool item.
`generic_tool_item.file_version_ids[]`	Array	No	File Versions to attach to the response
`generic_tool_item.image_ids[]`	Array	No	Images to attach to the response
`generic_tool_item.upload_ids[]`	Array	No	Uploads to attach to the response
`generic_tool_item.status`	String	No	The status of the generic tool item.
`generic_tool_item.schedule_impact`	String	No	The schedule impact status for the generic tool item. Possible values: `"no_impact"` `"n_a"` `"yes_unknown"` `"tbd"` `"yes_known"`
`generic_tool_item.location_id`	Integer	No	The location identifier for the generic tool item.
`generic_tool_item.form_ids[]`	Array	No	Forms to attach to the response
`generic_tool_item.skip_emails`	Boolean	No	If true creating and updating the item will not send emails to the users on the item.
`generic_tool_item.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_item.received_from_id`	Integer	No	The unique identifier for the Received From entity.
`generic_tool_item.due_date`	String	No	The due date for the generic tool item.
`generic_tool_item.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.