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

REQ_REFERENCE_INTERFACE

Previous  Top  Next

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

 

Method

POST

 

Input parameters

ID #

Constant value

Parameter

Type

Description

cdprod

227

QUERY

NUMERIC

Product code

classname

req_reference_interface

QUERY

STRING

Class name used in WADL

classpath

req_import

QUERY

STRING

Path to the class used in WADL

 

Request body

{

 "idrequirement": "string",

 "nmrequirement": "string",

         "idreqtype": "string",

         "idrespuser": "string",

         "idrespteam": "string",

         "dsurl": "string",

         "iddocument": "string",

         "iduserinit": "string",

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

idrequirement

X

Requirement ID #

nmrequirement

X

Requirement name

idreqtype

X

Requirement type ID #

idrespuser

X

Responsible user ID

idrespteam

 

Responsible team ID #.

iddocument

 

Document ID #

dsurl

 

Url

iduserinit

X1

Starter user's ID

dsdescription

 

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

 

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