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

RIS_CONTROL_INTERFACE

Previous  Top  Next

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 arrowrgray File arrowrgray Control screen.

 

Method

POST

 

Input parameters

ID #

Constant value

Parameter

Type

Description

cdprod

215

QUERY

NUMERIC

Product code

classname

ris_control_interface

QUERY

STRING

Class name used in WADL

classpath

ri_import

QUERY

STRING

Path to the class used in WADL

 

Request body

{

 "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

}

 

Request body for deletion

{

 "idcontrol": "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

X

Control ID #

nmcontrol

X1

Control name

idtype

X1

Control type ID #

idresp

 

Responsible user ID

idteam

 

Responsible team ID #.

fgimplement

 

Implementation:

1 – Not implemented

2 – Partly implemented

3 – Completely implemented

dtimplement

 

Implementation date

fgrelevant

 

Relevant:

1 – Yes

2 – No

fgautomationtype

 

Automation type:

1 – Automatic

2 – Semiautomatic

3 – Manual

fgctrlcharact

 

Control characteristic:

1 – Detective

2 – Preventive

3 - Detective + Preventive

fgfrequency

 

Control frequency:

1 - Based on event

2 – Daily

3 - Weekly

4 - Monthly

5 - Quarterly

6 - Biannual

7 - Yearly

fgsymbol

 

Control icon ID #

dscontrol

 

Control description

dsdocument

 

Procedure 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