CONTROL-LIBRARY

This method allows inserting and deleting control libraries through a REST API. Created libraries will be available on the Risk > Library > Control screen.

Insertion

POST /apigateway/se/rest/v1/risk/control-library

Request example:

Request body parameter	Type	Required	Description
idControlLibrary	String	No	ID #
nmControlLibrary	String	Yes	Name
idType	String	Yes	Type ID #
idResp	String	No	Responsible ID #
idTeam	String	No	Responsible team ID #
fgImplement	String	Yes¹	Implementation: 1 - Not implemented 2 - Partly implemented 3 - Completely implemented
dtImplement	String	No	Implementation date
fgRelevant	String	No	Relevant: 1 - Yes 2 - No
fgAutomationType	String	Yes¹	Automation type: 1 - Automatic 2 - Semiautomatic 3 - Manual
fgControlCharact	String	Yes¹	Characteristics: 1 - Detective 2 - Preventive 3 - Detective + Preventive 4 - Customized in general parameters 5 - Customized in general parameters 6 - Customized in general parameters
fgControlFrequency	String	Yes¹	Frequency: 1 - Based on event 2 - Daily 3 - Weekly 4 - Monthly 5 - Quarterly 6 - Biannual 7 - Yearly
idProcedure	String	No	Procedure ID #
fgSymbol	String	No	Icon ID #: Between 0 and 99.
idEval	String	Yes¹	Evaluation method ID #
dsControlLibrary	String	No	Description
dsDocument	String	No	Procedure description
instance	String	No	Constant value: %WF_IDINSTANCE%
idact	String	No	Instance activity ID #
attribute	String	No	Attributes 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.

info

Yes¹ - Mandatory if it is configured in the general parameters.

{
  "idControlLibrary": "string",
  "nmControlLibrary": "string",
  "idType": "string",
  "idResp": "string",
  "idTeam": "string",
  "fgImplement": 1,
  "dtImplement": "string",
  "fgRelevant": 1,
  "fgAutomationType": 1,
  "fgControlCharact": 1,
  "fgControlFrequency": 1,
  "idProcedure": "string",
  "fgSymbol": 1,
  "idEval": "string",
  "dsControlLibrary": "string",
  "dsDocument": "string",
  "instance": "string",
  "idact": "string",
  "attribute": "string"
}

Deletion

Example of a deletion request:

DELETE /apigateway/se/rest/v1/risk/control-library/{idControlLibrary}

info

{idControlLibrary} must be replaced with the control ID #.

warning

The idControlLibrary variable does not accept special characters.

Response example:

200 OK

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