In cases where you want the values of a custom field to be carried forward to other entities within the same module, you can define the parameters as shown in this topic.
Use case
We will create fields for an existing field set under the risk scoring request entity. In this scenario, we want the values for this field to be copied from a field in another entity in the risk module.
Use case data
API parameter with values
The path parameter is the entity name for which you are creating the field (in this case, RISK.SCORING_REQUEST).
In the body, we will enter a unique field ID, name, and data type. Also, we will specify the field set ID for which we are creating the field.
Note: The data type must be the same as the field from which you want to copy values. The field ID and name can be different.
We will also specify whether the field is unique, required, and active.
The entity name and field ID from which the values will be copied.
You can only copy values within the same module.
Sample API call
To create the field, use the following endpoint:
Sample request
The sample request body is as follows:
{
"fieldId": "internalCreditRating",
"name": "Measures probability of default according to internal credit rating model",
"fieldSetId": "CreditCheck",
"valueType": "TEXT",
"unique": false,
"required": false,
"active": true,
"copyFromEntityName": "RISK.SCORING_DECISION",
"copyFromFieldId": "internalCreditRating"
}
Learn more about the endpoint in the Tuum developer portal.
".../custom-fields/RISK.SCORING_REQUEST..."
"fieldId": "internalCreditRating",
"name": "Measures probability of default according to internal credit rating model",
"fieldSetId": "CreditCheck",
"valueType": "TEXT"