REST API

Update Step API

OVERVIEW

This REST API facilitates the user in updating and reordering the step(s) of a work item (Test case) and Defect. Users can perform simple update or reorder or both actions as per the request initiated.

Method: Post

Input: 

Authorization: Using an API key in the Request Headers. For more information, please refer to our Orcanos REST API article.

Post body:

Purpose of the Fields given in this API: 

Parameter Value Mandatory Description
ItemID Yes Enter the test case or Defect item ID where the test step need to be added
ObjectType String Yes Enter the ObjectType – OBJECT/DEFECT. OBJECT for Work item (Testcase) and DEFECT for Defect.
CurrentStepNumber String Yes Enter the step number which is to be updated or moved
NewStepNumber String Enter the step number position where the existing step is to be moved
Description String Yes  Enter the step description
 ExpectedValue String    Enter the expected value
LowerLimit String   Enter the lower limit value
UpperLimit
String   Enter the upper limit value

NewStepNumber is required only when the user needs to reorder the test steps.

Output:

Orcanos Output class:

{
    “IsSuccess”: true,
    “Data”: “”,
    “Message”: “Step updated successfully.”,
     “HttpCode”: 200
}

IsSuccess: if successful then true else false

Message: ‘Step updated successfully’ message in case Is Success is true, error message in case Is Success is false

HttpCode: Response HttpCode

Related Articles