Skip to main content
Version: 2.2.3

TREATMENT

This method allows inserting treatments through a REST API.

POST /apigateway/se/rest/v1/risk/treatment

Request example:

Request body parameterTypeRequiredDescription
idTreatmentStringNoID #
nmTreatmentStringYesName
idTypeStringYesType ID #
nmResultStringNoResult name
fgRequiredActionPlanNumericNoAction plan required: 1 - Yes; 2 - No.
idActionPlanTemplateStringNoAction plan template ID #
dsTreatmentStringNoDescription
attributeStringNoAttributes
Example:
identifier_of_attribute1=value_of_attribute1;
identifier_of_attribute2=value_of_attribute2;
identifier_of_attribute3=value_of_attribute3
Example with multivalued attribute:
identifier_of_attribute1=value1_of_attribute1, value2_of_attribute1, value3_of_attribute1.
Note: For attributes with a numeric value, the decimal place separator must be '.'. For date fields, the value must have the "Y-M-D" (Year-Month-Day) format.

Insertion request example:

{
"idTreatment": "string",
"nmTreatment": "string",
"idType": "string",
"dsTreatment": "string",
"attribute": "string",
"fgRequiredActionPlan": "1",
"idActionPlanTemplate": "string"
}

Response example:

200 OK

{
"success": true,
"total": 1,
"results": [
{
"Result": true,
"Code": 1
}
]
}