RIS_CONTROLANALYSIS_INTERFACE

This method allows adding, editing and deleting a control analysis, or adding an attachment to a control analysis, through a REST web service. Only a control analysis that is linked to a risk plan in the draft step can be added or edited; for released risk plans, it is not possible to add or edit the data of a control analysis.

POST /apigateway/se/generic/gn_webservice/gn_webservice_execute.php

Query parameters:

Query parameters	Type	Required	Description
cdprod	Numeric	Yes	Product code Constant value: 215
classname	String	Yes	Class name used in WADL Constant value: ris_controlanalysis_interface
classpath	String	Yes	Path to the class used in WADL Constant value: ri_import

Example request:

Supported attributes:

Request body parameter	Type	Required	Description
idcontrol	String	Yes¹	Control ID #
idplan	String	Yes	Plan ID #
cdcontrolresp	String	Yes¹	Responsible ID #
cdcontrolteam	String	No	Responsible team ID #
idcontrolanalysis	String	Yes²	Control analysis ID #
gnaca_cdassoc	String	No	Element ID # superior to the control
fgautomationtype	String	No	Automation type: 1 - Automatic 2 - Semiautomatic 3 - Manual
fgcontrolcharact	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
fgcontrolfreq	String	No	Control 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
cdmeasunity	String	No	Measurement unit ID #
vlcost	String	No	Controls cost
cdeval	String	No	Evaluation method ID #
dscontrolanalysis	String	No	Control analysis 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 2 – Edit 3 - Delete

info

Yes¹ - It will not be mandatory during deletion. Action = 3
Yes² - Mandatory only for deletion. Action = 3
If the action field is not completed, the default value will be 1.

{
  "idcontrol": "string",
  "idplan": "string",
  "cdcontrolresp": "string",
  "cdcontrolteam": "string",
  "idcontrolanalysis": "string",
  "gnaca_cdassoc": "string",
  "fgautomationtype": 1,
  "fgcontrolcharact": 1,
  "fgcontrolfreq": 1,
  "fgimplement": 1,
  "dtimplement": "string",
  "dtnexteval": "string",
  "qtevalpendency": 1,
  "cdmeasunity": "string",
  "vlcost": 1.1,
  "cdeval": "string",
  "dscontrolanalysis": "string",
  "instance": "string",
  "idact": "string",
  "action": 1
}

Example of request for deletion:

{
  "idcontrolanalysis": "string",
  "idplan": "string",
  "action": 3
}

Example response:

200 OK

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