POST /rest/v1.0/workforce-planning/v2/companies/{company_id}/projects/{project_id}/resource-requests
Creates a new Resource Request for a specified project within a given company. Resource requests can be based on work hours (start_time and end_time) or percent allocation (percent_allocated).
Servers
- https://api.procore.com
Path parameters
Name | Type | Required | Description |
---|---|---|---|
project_id |
Integer | Yes |
Unique identifier for the project |
company_id |
Yes |
Unique identifier for the company. This parameter accepts both formats:
A proxy layer automatically handles both formats, but using the Procore company ID is preferred for consistency with other Procore APIs. |
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 |
---|---|---|---|
work_scope_text |
String | No |
Scope of Work for the Resource Request. |
work_days |
Object | No |
Object to control working days (Sunday - Saturday as 0-6 index). |
work_days.0 |
Boolean | No | |
work_days.1 |
Boolean | No | |
work_days.2 |
Boolean | No | |
work_days.3 |
Boolean | No | |
work_days.4 |
Boolean | No | |
work_days.5 |
Boolean | No | |
work_days.6 |
Boolean | No | |
start_time |
String | No |
Start time of the request (HH:MM am/pm format). |
quantity |
Integer | No |
Number of resource requests to create. |
instruction_text |
String | No |
Instructions for the Resource Request. |
state_id |
String | No |
UUID of the Assignment State. |
start_day |
String | Yes |
The first day the requested resource is needed (ISO 8601). |
end_day |
String | Yes |
The last day the requested resource is needed (ISO 8601). |
category_id |
String | No |
UUID of the Project Category. |
tag_ids[] |
Array | No |
Array of UUIDs representing Tags. |
percent_allocated |
Integer | No |
Allocation percentage if the request is not hour-based. |
subcategory_id |
String | No |
UUID of the Project Subcategory. |
job_title_id |
String | No |
Job Title UUID for this request. |
end_time |
String | No |
End time of the request (HH:MM am/pm format). |
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.