PATCH /rest/v1.0/tasks/{id}
Update the specified Task.
Servers
- https://api.procore.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
Integer | Yes |
ID of the task |
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 |
|---|---|---|---|
project_id |
Integer | Yes |
ID of the project this task belongs to. |
task |
Object | Yes |
Task object. |
task.finish |
String | No |
Task finish timestamp. |
task.milestone |
Boolean | No |
True if this task is a milestone. |
task.percentage |
Integer | No |
Percent complete value for this task. |
task.critical_path |
Boolean | No |
True if this task is on the critical path. |
task.baseline_start |
String | No |
The baseline start timestamp for this task. |
task.parent_id |
Integer | No |
ID of the parent task. |
task.source_uid |
String | No |
The unique identifier for this task from the external system which owns the schedule data. |
task.resource_ids[] |
Array | No |
Resources assigned to this task, represented as an array of resource ID values. |
task.actual_finish |
String | No |
Actual finish timestamp for this task. |
task.schedule_duration |
Number | No |
The duration of this task in days as defined by the external system which owns the schedule data. |
task.actual_start |
String | No |
Actual start timestamp for this task. |
task.baseline_finish |
String | No |
The baseline finish timestamp for this task. |
task.name |
String | No |
Task name. |
task.activity_id |
String | No |
For tasks imported from external systems which have the concept of
an "Activity ID" (for example Primavera P6), this attribute is
used to hold the Activity ID value. Note that due to an oversight
during the creation of this API, the value supplied here will be
rendered as the |
task.notes |
String | No |
Arbitrary notes about this task. |
task.manually_edited |
Boolean | No |
Set to true if the task has been created or modified in Procore, false if the task was imported from an external schedule and has not been modified in Procore. |
task.row_number |
Integer | No |
The row number of a task defines the sequence in which tasks are normally expected to be displayed. |
task.finish_variance |
Number | No |
The finish variance in days for this task, as calculated by the external system which owns the schedule data. |
task.has_children |
Boolean | No |
Flag set to true if this is a summary task, i.e. this task has child tasks. |
task.full_outline_path |
String | No |
Task full outline path. |
task.start_variance |
Number | No |
The start variance in days for this task, as calculated by the external system which owns the schedule data. |
task.wbs |
String | No |
Work Breakdown Structure (WBS) number for this task. |
task.start |
String | No |
Task start timestamp. |
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.