Skip to main content
Version: 2.2.3

REQ_MAPPING_INTERFACE

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.

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

Query parameters:

Query parametersTypeRequiredDescription
cdprodNumericYesProduct code
Constant value: 227
classnameStringYesClass name used in WADL
Constant value: req_mapping_interface
classpathStringYesPath to the class used in WADL
Constant value: req_import

Example request:

Supported attributes:

Request body parameterTypeRequiredDescription
idmappingStringYesRequirement mapping ID #
nmmappingStringYesRequirement mapping name
fgobjectmapIntegerYesMapping 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.
idreqreferenceStringYesReference requirement ID #
idrespuserStringYesResponsible user ID
idrespteamStringNoResponsible team ID #
idbusinessunitStringYesBusiness unit ID #
iddeptStringYes¹Department ID #
idobjectStringYes²Object ID #
iduserinitStringYes³Starter user ID
instanceStringNoThe value of this constant must be:
%WF_IDINSTANCE%
idactStringNoInstance activity ID #
actionIntegerNoThe action type that will be performed on the screen:
1 - Insert
info
  • Yes¹ - The iddept field will be required only when the requirement mapping is by business unit and department.
  • Yes² - The idobject field will be required only when the requirement mapping is by item/supplier/supply/asset/waste.
  • Yes³ - The iduserinit field will be required only when the requirement mapping revision is by workflow.
{
"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
}

Example response:

200 OK

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