REST API

QW_Get_RunParameter

OVERVIEW

This REST API helps to Get all details of the Run Parameter added into the given execution set

Input: 

Authorization: Basic Auth token in the Request Headers

Method: GET

Request Param:

Key Value Is Mandatory? Description
VersionId Integer Yes Enter the version id of the project like 1296
ItemType String Yes Enter the item type like T_EXEC
ItemId Integer Yes Enter the item id like 36373
PageNo Integer Enter the page number for which you want to show records like, 1
PageSize Integer Yes Enter Page size, that how many items you want to show in the same time like, 10
SearchQuery String Yes Enter the search string from which you want to search the items.
OrderBy String No Enter Order by like ASC/DESC as you want to get results accordingly.

Output:

Orcanos Output class:

{
    "IsSuccess": true, --->>Request Result
    "Data": {
        "param": [
            {
                "Test_Exec_ID": 36373, --->Execution Set Name for which user wants to get the details
                "Param_ID": 22, ---> Parameter id which is added into the excution set
                "Param_Name": "All Project Users", ----> Parameter Name which is added into the execution set
                "Param_Value": "Author", --->Parameter value which is selected into the parameter
                "Param_Value_Code": null, ---> Parameter value code 
                "Mandatory": "False", ---> Mandatory value selected into the parameter
                "Mandatory_desc": "No", ---> mandatory descending selected into the parameter
                "Ref_Table_Desc": null, --->Related table value of parameter
                "Project_Name": null,  ---->Project name if specified
                "is_chcecked": false ---> Is checked or not in parameter for value
            }
        ],
        "total_records": 1,---> No. of records which are found related to this execution set
        "current_page": 1,  --->No. of pages available 
        "page_size": 10  ---> No. of page size available.
    },
    "Message": "Success",
    "HttpCode": 200
}

IsSuccess: if successful then true else false

Data: JSON object. Status Ok if the API displays all information successfully.

Message: Error message in case IsSuccess is false

HttpCode: Response HttpCode

Related Articles