Find field sets

Use case

Here we will find the existing field sets for the loan contract entity.

Use case data
API parameters with values

The path parameter is the entity name (in this case, LOAN.CONTRACT_HEADER).

"...custom-fields/LOAN.CONTRACT_HEADER/..."

Sample API call

To find the field sets, use the following endpoint:

https://loan-api.sandbox.tuumplatform.com/api/v1/custom-fields/LOAN.CONTRACT_HEADER/field-set

Learn more about the find field sets endpoint in the Tuum developer portal.

Sample response

Below you will find the response to the sample request:

Response
{
  "errors": null,
  "validationErrors": null,
  "data": [
    {
      "entityName": "LOAN.CONTRACT_HEADER",
      "fieldSetId": "Contract Extras",
      "name": "Contracts"
    }
  ]
}

Result

From the response, we can see that the entity LOAN.CONTRACT_HEADER has one field set with ID Contract Extras. Next, we will find the details of all the fields for this entity.

Last updated

Was this helpful?