Follow

REST API changes in QMetry Test Management Release 7.5

Why it has been changed?

QMetry has been undergone a major re-factoring with standardization and core engine structural change with release 7.5. REST API revitalization will provide seamless automation without consuming additional session for the users. Folders are audit trailed in more detail with REST API providing folder location.

Download the attached document for detailed information on What has been changed, Common API Changes, Individual API changes and What is not affected by these changes.

 

What has been changed?

Common API Changes:

  • URL endpoints will no more consist of /AA888.
    • EXAMPLE: https://<YOUR_COMPANY>.qmetry.com/rest instead of https://<YOUR_COMPANY>.qmetry.com/AA888/rest
  • Users can use “apiKey” instead of “usertoken”, which will not enforce logout from User Interface.
    • We recommend to use API KEY instead of user token in all the REST calls. API key remains same as long as it's regenerated.
    • You can get the API Key from QMetry Login > User Profile Settings > API Key >> Generate.
    • API Key can be used instead of Usertoken in all the API's. Use it as : apiKey:
    • EXAMPLE:

 

Using Usertoken (Earlier)

Using API Key (Current)

Document Section

Request

Response

Document Section

Request

Response

6.6 Delete Requirement Folder

Accept: application/json

Content type: application/json

Scope: <Domain Id> :<Release Id> :<Cycle Id>

Usertoken: <usertoken>

 

     {

      "success": true,

      "code":

     "CO.DELETE_FOLDER_SUCCESS,    }

 

6.6 Delete Requirement Folder

Accept: application/json

Content type: application/json

Scope: <Domain Id> :<Release Id> :<Cycle Id>

apiKey: <api key>

[{

      "id": <Parent Folder id>

     }, {

      "success": true,

      "code":     "CO.DELETE_FOLDER_SUCCESS"

     }]

 

 

 

Individual API Changes:

  • Delete Requirement Folder
  • Get Testcase Run Id using Testcase id
  • List Custom List Values
  • Link Issue to Requirement
  • Search Testcase
  • Login API

 

Version earlier than 7.5

Version 7.5

Document Section

Request

Response

Document Section

Request

Response

6.6 Delete Requirement Folder

No Change

 

     {

      "success": true,

      "code":

     "CO.DELETE_FOLDER_SUCCESS",

     }

 

6.6 Delete Requirement Folder

No Change

[{

      "id": <Parent Folder id>

     }, {

      "success": true,

      "code":

     "CO.DELETE_FOLDER_SUCCESS"

     }]

 

 

 

Version earlier than 7.5

Version 7.5

Document Section

Request

Response

Document Section

Request

Response

9.1 Get Testcase Run Id using Testcase id

No Change

 

[

    {

        "data": [

            {

                "defects": "<Defects linked to testsuite>",

                "testSuiteName": "<Testsuite Name>",

                "description": "<Testcase Description>",

                "tsEntityKey": "<Testsuite Entity Key>",

                "platform": "<Platform Name>",

                "tcRunID": <Testcase Run ID>,

                "executedVersion": <Executed Version>,

                "tsID": <Testsuite Id>

            }

        ],

        "total": 1

    }

]

 

9.1 Get Testcase Run Id using Testcase id

No Change

{

        "data": [

            {

                "defects": "<Defects linked to testsuite>",

                "testSuiteName": "<Testsuite Name>",

                "description": "<Testcase Description>",

                "tsEntityKey": "<Testsuite Entity Key>",

                "platform": "<Platform Name>",

                "tcRunID": <Testcase Run ID>,

                "executedVersion": <Executed Version>,

                "tsID": <Testsuite Id>

            }

        ],

        "total": 1

    }

 

 

 

 

Version earlier than 7.5

Version 7.5

Document Section

Request

Response

Document Section

Request

Response

10.5 List Custom List Values

No Change

 

   { 

      "Id":<List Value Id>,

      "Alias":"<Alias Value Name>",

      "Name":"<Name of Value>",

      "Value": <Value> 

   }

.....

...

]

 

10.5 List Custom List Values

No Change

 

{

    "data": [{

            "Id": < List Value Id > ,

            "Alias": "<Alias Value Name>",

            "Name": "<Name of Value>",

            "Value": < Value >

        }

        .....

        ...

    ]

}

 

Version earlier than 7.5

Version 7.5

Document Section

Request

Response

Document Section

Request

Response

12.9 Link Requirement to Issue

No Change

 

   "success":false,

   "code":"IS.ENTITY_ALREADY_LINKED",

   "data":[ 

      { 

         "ALREADY_LINKED_KEY":"<Issue Id>"

      }

   ],

   "bothFeature":true

}

 

12.9 Link Requirement to Issue

No Change

   "success":false,

   "code":"IS.ENTITY_ALREADY_LINKED",

   "data":[ 

      { 

         "ALREADY_LINKED_KEY":"<Issue Id>"

      }

   ]

}

 

 

 

 

 

 

 

 

 

 

Version earlier than 7.5

Version 7.5

Document Section

Request

Response

Document Section

Request

Response

13.1 Search Testcase

No Change

 

…          "releaseName": "Release",

          "buildName": "Build"

      }

  ],

  "total": 1,

  "buildId": 1,

  "cycleId": 1,

  }

 

13.1 Search Testcase

No Change

…          "releaseName": "Release",

          "buildName": "Build"

      }

  ],

  "total": 1,

  "buildId": 1,

  "cycleId": 1,

  "UDFTypeData": {}

  }

 

 

Version earlier than 7.5

Version 7.5

Document Section

Request

Response

Document Section

Request

Response

3. Authentication Using User Token

No Change

 

{

    "success": true,

    "usertoken": "xxxx"

}

 

3. Authentication Using User Token

No Change

{

    "success": true,

    "usertoken": "xxxx",

    "resfreshToken": "xxxx"

}

 

 

What has not been changed?

None of the APIs other than above mentioned APIs are changed.

No change in User Experience.

No change in Authentication mechanism.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

0 Comments

Article is closed for comments.
Powered by Zendesk