Create field set

Use case

We will create a field set for additional scoring details under the risk scoring decision entity.

Use case data	API parameter with values
The path parameter is the entity name (in this case, RISK.SCORING_DECISION).	".../custom-fields/RISK.SCORING_DECISION..."
The body consists of a unique field set ID and name.	"name": "Additional scoring details", "fieldSetId": "additional_scoring"

Sample API call

To create the field set, use the following endpoint:

https://risk-api.sandbox.tuumplatform.com/api/v1/custom-fields/RISK.SCORING_DECISION/field-set

Learn more about the create field set endpoint in the Tuum developer portal.

Sample request

The sample request body is as follows:

JSON

{
  "name": "Additional scoring details",
  "fieldSetId": "additional_scoring"
}

cURL

curl -X 'POST' \
  'https://risk-api.sandbox.tuumplatform.com/api/v1/custom-fields/RISK.SCORING_DECISION/field-set' \
  -H 'accept: */*' \
  -H 'x-channel-code: SYSTEM' \
  -H 'x-tenant-code: MB' \
  -H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMDgtMjVUMTY6Mzc6MDkiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2OTI5ODE0Mjl9.XrSvnLNcGZZZT4V1iW9-N0CxRu-85oZlKouH8o6r9ao' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Additional scoring details",
  "fieldSetId": "additional_scoring"
}'

Sample response

Below you will find the response to the sample request:

Response

{
  "errors": null,
  "validationErrors": null,
  "data": {
    "entityName": "RISK.SCORING_DECISION",
    "fieldSetId": "additional_scoring",
    "name": "Additional scoring details"
  }
}

Result

We have created a field set for additional risk scoring details. Next, we will create fields for the field set that we just made.