POST /rest/v1.0/projects/{project_id}/action_plans/plans
Create an Action Plan
Servers
- https://api.procore.com
Path parameters
Name | Type | Required | Description |
---|---|---|---|
project_id |
Integer | Yes |
Unique identifier for the project. |
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 |
---|---|---|---|
plan |
Object | Yes | |
plan.location_id |
Integer | No |
Location ID to be set on the Action Plan |
plan.description |
String | No |
Description of the Action Plan |
plan.title |
String | Yes |
Title of the Action Plan |
plan.private |
Boolean | No |
Privacy flag of the Action Plan |
plan.manager_id |
Integer | No |
Party Person ID of the Action Plan Manager |
plan.plan_type_id |
Integer | Yes |
Plan Type ID to be set on the Action Plan |
plan.plan_approvers_attributes[] |
Array | No | |
plan.plan_approvers_attributes[].party_id |
Integer | Yes |
Party Person ID of the Action Plan Approver to be set |
plan.plan_receivers_attributes[] |
Array | No | |
plan.plan_receivers_attributes[].party_id |
Integer | Yes |
Party Person ID of the Action Plan Receiver to be set |
plan.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. |
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.