GET /rest/v1.0/companies/{company_id}/configurable_field_sets/find_by_index
Returns the details for a specified Configurable Field Set if found. If not, template of type Field Set will be returned with ID null.
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 |
|---|---|---|---|
Procore-Company-Id |
Integer | Yes |
Unique company identifier associated with the Procore User Account. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
scope[action_plan_type_id] |
Integer | No |
Required for an Action Plans Plan Configurable Field Set (type of ConfigurableFieldSet::ActionPlans::Plan) |
project_id |
Integer | No |
Project ID that is associated to the Configurable Field Set, if applicable |
scope[inspection_type_id] |
Integer | No |
Required for an Inspection Configurable Field Set. If a value is provided, only field set of the specific Inspection type is returned. If no value is provided, only field set of unassociated Inspections (Inspections with no type) is returned. |
scope[category] |
Integer | No |
Required for an Observations Configurable Field Set (0 = quality, 1 = safety, 2 = commissioning, 3 = warranty, 4 = work to complete) |
scope[generic_tool_id] |
Integer | No |
Required for a Generic Tool Item Configurable Field Set (type of ConfigurableFieldSet::GenericToolItem) |
type |
String | Yes |
The type of Configurable Field Set |
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.