REST API

QW_Add_Relations_Custom_Code

OVERVIEW

This REST API helps to add the Relation/Traceability between the items using the custom work item code.

Method: POST

Input: 

Authorization: Basic Auth token in the Request Headers

Post Body

Key Value Is Mandatory? Description
SourceIdKeys String Yes Enter the source id key like DMS-20174
TargetIdKeys String Yes Enter the target id key like ECO-30829
RelationType String No Enter Relation Type
Comments String No Enter comments whatever you want

Make sure to input the work item’s custom code and not the original code.

Like, In ECO-30829, ECO is the custom code and CR its original code so you need to enter ECO here.

Output:

Orcanos Output class:

{
       "IsSuccess": true,
       "Data": "Relation added successfully.",  ---> Success message
       "Message": "",
      "HttpCode": 200
}

IsSuccess: if successful then true else false

Data: JSON object. Status Ok if the relation is added successfully.

Message: Error message in case IsSuccess is false

HttpCode: Response HttpCode

Related Articles