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

REQ_MAPPING_INTERFACE

Previous  Top  Next

This method allows inserting a requirement mapping using a REST web service. The recorded requirement mapping will be available on the Requirement > File > Requirement mapping screen.

 

Method

POST

 

Input parameters

ID #

Constant value

Parameter

Type

Description

cdprod

227

QUERY

NUMERIC

Product code

classname

req_mapping_interface

QUERY

STRING

Class name used in WADL

classpath

req_import

QUERY

STRING

Path to the class used in WADL

 

Request body

{

 "idmapping": "string",

 "nmmapping": "string",

 "fgobjectmap": 1,

 "idreqreference": "string",

 "idrespuser": "string",

 "idrespteam": "string",

 "idbusinessunit": "string",

 "iddept": "string",

 "idobject": "string",

 "iduserinit": "string",

 "instance": "string",

 "idact": "string",

 "action": 1

}

 

Output parameter

{

   "success": true,

   "total": 1,

   "results": [

       {

           "Result": true,

           "Code": 1

       }

   ]

}

 

To insert each of these requirement items, the standard documented below must be followed.

Request

ID #

Required

Description

idmapping

X

Requirement mapping ID #

nmmapping

X

Requirement mapping name

fgobjectmap

X

Mapping scope:

1 – Business unit;

2 – Business unit and department;

3 – Business unit and item;

4 – Business unit and supplier;

5 – Business unit and supply;

6 – Business unit and asset;

7 – Business unit and waste.

idreqreference

X

Reference requirement ID #

idrespuser

X

Responsible user ID

idrespteam

 

Responsible team ID #.

idbusinessunit

X

Business unit ID #

iddept

X1

Department ID #

idobject

X2

Object ID #

iduserinit

X3

Starter user's ID

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

 

1 - The iddept field will be required only when the requirement mapping is by business unit and department.

2 - The idobject field will be required only when the requirement mapping is by item/supplier/supply/asset/waste.

3 - The iduserinit field will be required only when the requirement mapping revision is by workflow.