REQ_REFERENCE_INTERFACE

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

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

Query parameters:

Query parameters	Type	Required	Description
cdprod	Numeric	Yes	Product code Constant value: 227
classname	String	Yes	Class name used in WADL Constant value: req_reference_interface
classpath	String	Yes	Path to the class used in WADL Constant value: req_import

Example request:

Supported attributes:

Request body parameter	Type	Required	Description
idrequirement	String	Yes	Requirement ID #
nmrequirement	String	Yes	Requirement name
idreqtype	String	Yes	Requirement type ID #
idrespuser	String	Yes	Responsible user ID
idrespteam	String	No	Responsible team ID #
iddocument	String	No	Document ID #
dsurl	String	No	Url
iduserinit	String	Yes¹	Starter user ID
dsdescription	String	No	Description
instance	String	No	The value of this constant must be: %WF_IDINSTANCE%
idact	String	No	Instance activity ID #
action	String	No	The action type that will be performed on the screen: 1 - Insert

info

Yes¹ - The iduserinit field will be required when the requirement revision is via workflow.

{
  "idrequirement": "string",
  "nmrequirement": "string",
  "idreqtype": "string",
  "idrespuser": "string",
  "idrespteam": "string",
  "dsurl": "string",
  "iddocument": "string",
  "iduserinit": "string",
  "dsdescription": "string",
  "instance": "string",
  "idact": "string",
  "action": 1
}

Example response:

200 OK

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