POST /rest/v2.0/companies/{company_id}/projects/{project_id}/workflows/instances/bulk_create
Asynchronously bulk create workflow instances for a list of project-level items. If an active instance already exists for an item, a failure will be returned for that item.
The returned async operation id can be used to query for status using the GET /rest/v2.0/companies/{company_id}/async_operations/{operation_id} API. The result field of the operation contains a list of completed and failed items.
For example:
{
"completed_items": [
{
"item_id": "123",
"instance_id": "456"
}
],
"failed_items": [
{
"item_id": "789",
"step": "create",
"message": "Item not found"
]
}
Servers
- https://api.procore.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
project_id |
String | Yes |
Unique identifier for the project. |
company_id |
String | Yes |
Unique identifier for the company. |
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. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
tool_type |
String | Yes |
Tool that instances are being created for. |
tool_subtype |
String | No |
Tool sub-type. Only required for specific tools. |
items[] |
Array | Yes |
List of objects to create workflow instances for. |
items[].item_id |
String | No |
ID of the item to create the workflow for. |
items[].preset_id |
String | No |
ID of the workflow configuration to use when creating the workflow. |
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.