PATCH /rest/v1.0/companies/{company_id}/configurable_field_sets/{id}
Updates a Configurable Field Set.
Servers
- https://api.procore.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
Integer | Yes |
Configurable Field Set ID |
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. |
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.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.custom_field_1 |
Object | No |
Existing Custom Fields to be edited for this Configurable Field Set |
configurable_field_set.fields.custom_field_1.id |
Integer | No |
Custom Field Metadatum ID |
configurable_field_set.fields.custom_field_1.name |
String | No |
The name of the Custom Field |
configurable_field_set.fields.custom_field_1.data_type |
String | No |
Data type of the Custom Field Possible values:
|
configurable_field_set.fields.custom_field_1.description |
String | No |
The description of the Custom Field Definition |
configurable_field_set.fields.custom_field_1.required |
Boolean | No |
Whether or not the Field is required |
configurable_field_set.fields.custom_field_1.column |
Number | No |
Column the Field is position on the Form |
configurable_field_set.fields.custom_field_1.column_width |
Number | No |
How many columns the field spans on the Form |
configurable_field_set.fields.custom_field_1.label |
String | No |
The label of the Custom Field Definition |
configurable_field_set.fields.custom_field_1.visible |
Boolean | No |
Whether or not the Custom Field is visible |
configurable_field_set.fields.custom_field_1.position |
Integer | No |
The display position of the Custom Field, which is sorted ascending, lowest position is visually the top left of the page on a grid basis (used in conjunction with column_width property to calculate row and column properties). |
configurable_field_set.fields.custom_field_1.row |
Number | No |
Row the Field is position on the Form |
configurable_field_set.fields.custom_field_1.custom_field_definition_id |
Integer | No |
Custom Field Definition ID |
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.include_all_projects |
Boolean | No |
Whether or not all projects selected |
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.