CONTROL

This method allows inserting, editing, and deleting controls through a REST API.

info

Controls can be inserted or edited only in plans that are in the draft step. For released plans, it is not possible to add or change control data.

Insertion

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

Request example:

Request body parameter	Type	Required	Description
idControlLibrary	String	Yes	Control library ID #
idPlan	String	Yes	Plan ID #
idResp	String	Yes	Responsible ID #
idTeam	String	No	Responsible team ID #
idControl	String	No	ID #
idParent	String	No	Upper level element ID #
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
fgImplement	String	Yes¹	Implementation: 1 - Not implemented 2 - Partly implemented 3 - Completely implemented
dtImplement	String	No	Implementation date
dtNextEval	String	No	Next evaluation date
qtEvalPendency	String	No	Execution deadline
idMeasunity	String	No	Measurement unit ID #
vlCost	String	No	Cost
idEval	String	Yes¹	Evaluation method ID #
dsControl	String	No	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",
  "idPlan": "string",
  "idResp": "string",
  "idTeam": "string",
  "idControl": "string",
  "idParent": "string",
  "fgAutomationType": "1",
  "fgControlCharact": "1",
  "fgControlFrequency": "1",
  "fgImplement": "1",
  "dtImplement": "string",
  "dtNextEval": "string",
  "qtEvalPendency": "1",
  "idMeasunity": "string",
  "vlCost": "1.1",
  "idEval": "string",
  "dsControl": "string",
  "instance": "string",
  "idact": "string",
  "attribute": "string"
}

Edit

PUT /apigateway/se/rest/v1/risk/control/{idControl}

info

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

warning

The idControl variable does not accept special characters.

Request example:

Request body parameter	Type	Required	Description
idResp	String	No	Responsible ID #
idTeam	String	No	Responsible team ID #
fgAutomationType	String	No	Automation type: 1 - Automatic 2 - Semiautomatic 3 - Manual
fgControlCharact	String	No	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	No	Frequency: 1 - Based on event 2 - Daily 3 - Weekly 4 - Monthly 5 - Quarterly 6 - Biannual 7 - Yearly
fgImplement	String	No	Implementation: 1 - Not implemented 2 - Partly implemented 3 - Completely implemented
dtImplement	String	No	Implementation date
dtNextEval	String	No	Next evaluation date
qtEvalPendency	String	No	Execution deadline
idMeasunity	String	No	Measurement unit ID #
vlCost	String	No	Cost
idEval	String	No	Evaluation method ID #
dsControl	String	No	Control analysis 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.

{
  "idResp": "string",
  "idTeam": "string",
  "fgAutomationType": "1",
  "fgControlCharact": "1",
  "fgControlFrequency": "1",
  "fgImplement": "1",
  "dtImplement": "string",
  "dtNextEval": "string",
  "qtEvalPendency": "1",
  "idMeasunity": "string",
  "vlCost": "1.1",
  "idEval": "string",
  "dsControl": "string",
  "instance": "string",
  "idact": "string",
  "attribute": "string"
}

Deletion

Example of a deletion request:

DELETE /apigateway/se/rest/v1/risk/control/{idControl}

info

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

warning

The idControl variable does not accept special characters.

Response example:

200 OK

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