POST /rest/v1.0/companies/{company_id}/configurable_field_sets
Creates a Configurable Field Set
Servers
- https://api.procore.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
company_id |
Integer | 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. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
include_lov_entries |
Boolean | No |
whether or not to include LOV entries in the response (defaults to true) |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
configurable_field_set |
Object | Yes | |
configurable_field_set.category |
String | No |
Required and only needed when associating projects for an Observations Configurable Field Set.(0 = quality, 1 = safety, 2 = commissioning, 3 = warranty, 4 = work to complete) Possible values:
|
configurable_field_set.name |
String | Yes |
Name |
configurable_field_set.action_plan_type_id |
Integer | No |
Action Plan Type unique identifier |
configurable_field_set.company_configurable_field_set_default_column_name |
String | No |
the column name on CompanyConfigurableFieldSetDefault to set the Configurable Field Set as default to. Only needed if company_default is true. Possible values:
|
configurable_field_set.class_name |
String | Yes |
Class Name of the object the Configurable Field Set is applied to Possible values:
|
configurable_field_set.project_ids[] |
Array | No | |
configurable_field_set.fields |
Object | Yes |
All fields that make up the form of the class name. |
configurable_field_set.fields.field_1 |
Object | No |
An example of what a field would look like |
configurable_field_set.fields.field_1.name |
String | Yes |
the name of the field |
configurable_field_set.fields.field_1.required |
Boolean | No |
Whether or not the field is required |
configurable_field_set.fields.field_1.visible |
Boolean | Yes |
whether the field is visible or not in the form |
configurable_field_set.generic_tool_id |
Integer | No |
Generic tool unique identifier |
configurable_field_set.inspection_type_id |
Integer | No |
Inspection type unique identifier |
configurable_field_set.company_default |
Boolean | No |
If the Configurable Field Set is the company default for new projects |
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.