RIS_CONTROL_INTERFACE
This method allows adding and deleting a control, or adding an attachment to a control, through a REST web service. The control recorded or edited will be made available on the Risk -> File -> Control screen.
POST /apigateway/se/generic/gn_webservice/gn_webservice_execute.php
Query parameters:
Query parameters | Type | Required | Description |
---|---|---|---|
cdprod | Numeric | Yes | Product codeConstant value: 215 |
classname | String | Yes | Class name used in WADLConstant value: ris_control_interface |
classpath | String | Yes | Path to the class used in WADLConstant value: ri_import |
Example request:
Supported attributes:
Request body parameter | Type | Required | Description |
---|---|---|---|
idcontrol | String | Yes | Control ID # |
nmcontrol | String | Yes¹ | Control name |
idtype | String | Yes¹ | Control type ID # |
idresp | String | No | Responsible user ID |
idteam | String | No | Responsible team ID # |
fgimplement | String | No | 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 | No | Automation type: 1 - Automatic 2 - Semiautomatic 3 - Manual |
fgctrlcharact | String | No | Control characteristic: 1 - Detective 2 - Preventive 3 - Detective + Preventive 4 - Customized in general parameters 5 - Customized in general parameters 6 - Customized in general parameters |
fgfrequency | String | No | Control frequency: 1 - Based on event 2 - Daily 3 - Weekly 4 - Monthly 5 - Quarterly 6 - Biannual 7 - Yearly |
fgsymbol | String | No | Control icon ID # |
dscontrol | String | No | Control description |
dsdocument | String | No | Procedure description |
instance | String | No | Constant value: %WF_IDINSTANCE% |
idact | String | No | Instance activity ID # |
action | String | No | The action type that will be performed on the screen: 1 - Insert 3 - Delete |
info
Yes¹ - It will not be mandatory during deletion. Action=3
{
"idcontrol": "string",
"nmcontrol": "string",
"idtype": "string",
"idresp": "string",
"idteam": "string",
"fgimplement": 1,
"dtimplement": "string",
"fgrelevant": 1,
"fgautomationtype": 1,
"fgctrlcharact": 1,
"fgfrequency": 1,
"fgsymbol": 1,
"dscontrol": "string",
"dsdocument": "string",
"instance": "string",
"idact": "string",
"action": 1
}
Example of request for deletion:
{
"idcontrol": "string",
"action": 3
}
Example response:
200 OK
{
"success": true,
"total": 1,
"results": [
{
"Result": true,
"Code": 1
}
]
}