Navigation:  Integration via REST web services > Published web services > Risk >

RIS_CONTROLANALYSIS_INTERFACE

Previous  Top  Next

This method allows adding and deleting a control analysis, or adding an attachment to a control analysis, through a REST Web Service. It is only allowed to add or edit a control analysis that is linked to a risk plan in draft, for the approved risk plans it is not possible to add or edit the data of the control analysis data.

 

Method

POST

 

Input parameters

ID #

Constant value

Parameter

Type

Description

cdprod

215

QUERY

NUMERIC

Product code

classname

ris_controlanalysis_interface

QUERY

STRING

Class name used in WADL

classpath

ri_import

QUERY

STRING

Path to the class used in WADL

 

Request body

{

 "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

}

 

Request body for deletion

{

 "idcontrolanalysis": "string",

 "idplan": "string",

 "action": 3

}

 

Output parameter

{

   "success": true,

   "total": 1,

   "results": [

       {

           "Result": true,

           "Code": 1

       }

   ]

}

 

To enter each of these request items it is necessary to follow the pattern documented below.

Request

ID #

Required

Description

idcontrol

X1

Control ID #

idplan

X

Plan ID #

cdcontrolresp

X1

Responsible ID #

cdcontrolteam

 

Responsible team ID #.

idcontrolanalysis

X2

Control analysis ID #

gnaca_cdassoc

 

Element ID # superior to the control

fgautomationtype

 

Automation type:

1 – Automatic

2 – Semiautomatic

3 – Manual

fgcontrolcharact

 

Control characteristic:

1 – Detective

2 – Preventive

3 - Detective + Preventive

fgcontrolfreq

 

Control frequency:

1 - Based on event

2 – Daily

3 - Weekly

4 - Monthly

5 - Quarterly

6 - Biannual

7 - Yearly

fgimplement

 

Implementation:

1 – Not implemented

2 – Partly implemented

3 – Completely implemented

dtimplement

 

Implementation date

dtnexteval

 

Next evaluation date

qtevalpendency

 

Execution deadline

cdmeasunity

 

Measurement unit ID #

vlcost

 

Controls cost

cdeval

 

Evaluation method ID #

dscontrolanalysis

 

Control analysis description

instance

 

CONSTANT VALUE: %WF_IDINSTANCE%

idact

 

Instance activity ID #

action

 

The action type that will be performed on the screen:

1 – Insert

3 – Delete

 

X1 - It will not be mandatory during deletion. Action = 3

X2 - It will only be mandatory during deletion. Action = 3