Find fields

Use case

Here we will find the details of all the fields for the loan contract header 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 fields, use the following endpoint:

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

Learn more about the find fields endpoint in the Tuum developer portal.

Sample response

Below you will find the response to the sample request:

Response

{
  "errors": null,
  "validationErrors": null,
  "data": [
    {
      "fieldId": "AssetVal",
      "name": "AssetAmount",
      "fieldSetId": "Contract Extras",
      "entityName": "LOAN.CONTRACT_HEADER",
      "valueType": "NUMBER",
      "unique": false,
      "required": false,
      "active": true,
      "copyFromEntityName": null,
      "copyFromFieldId": null,
      "activityCode": null,
      "lookupEntityName": null,
      "lookupTypeCode": null
    },
    {
      "fieldId": "InitVal",
      "name": "Initial Downpayment",
      "fieldSetId": "Contract Extras",
      "entityName": "LOAN.CONTRACT_HEADER",
      "valueType": "NUMBER",
      "unique": false,
      "required": false,
      "active": true,
      "copyFromEntityName": null,
      "copyFromFieldId": null,
      "activityCode": null,
      "lookupEntityName": null,
      "lookupTypeCode": null
    },
    {
      "fieldId": "ResVal",
      "name": "Residual Value",
      "fieldSetId": "Contract Extras",
      "entityName": "LOAN.CONTRACT_HEADER",
      "valueType": "NUMBER",
      "unique": false,
      "required": false,
      "active": true,
      "copyFromEntityName": null,
      "copyFromFieldId": null,
      "activityCode": null,
      "lookupEntityName": null,
      "lookupTypeCode": null
    }
  ]
}

Result

From the response, we can see the details of the defined fields for the loan contract header entity.

If there is more than one field set in the entity, the details of all the fields are returned in the response.