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

RIS_RISK_INTERFACE

Previous  Top  Next

This method allows adding and deleting a risk, or adding an attachment to a risk, through a REST Web Service. The risk recorded or edited will be made available on the Risk > File > Risk screen.

 

Method

POST

 

Input parameters

ID #

Constant value

Parameter

Type

Description

cdprod

215

QUERY

NUMERIC

Product code

classname

ris_risk_interface

QUERY

STRING

Class name used in WADL

classpath

ri_import

QUERY

STRING

Path to the class used in WADL

 

Request body

{

 "idrisk": "string",

 "nmrisk": "string",

 "idtype": "string",

 "idresp": "string",

 "idteam": "string",

 "fgclass": 1,

 "fgsymbol": 1,

 "dsrisk": "text",

 "instance": "string",

 "idact": "string",

 "action": 1

}

 

Request body for deletion

{

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

idrisk

X

Risk ID #

nmrisk

X1

Risk name

idtype

X1

Risk type ID #.

idresp

 

Responsible user ID

idteam

 

Responsible team ID #.

fgclass

 

Risk classification:

1 – Loss

2 – Opportunity

fgsymbol

 

Risk icon ID #

dsrisk

 

Risk description

instance

 

The value of this constant must be:

%WF_IDINSTANCE%

idact

 

Instance activity ID #

action

 

The action type that will be performed on the screen:

1 – Insert

3 – Delete

 

X1 - They are not mandatory during deletion. Action = 3