Apps documentation
Requirements and Test Management for Jira
Cloud Server/Data Center
Requirements and Test Management for Jira

Cloud

Server/Data Center

Documentation
FAQ
Release notes
Articles & Videos
Last updated Aug 4, 2021

Example of use

How to create a new Test Case - an example of payload

{
    "projectKey": "TEMP",
    "summary": "Create TC Edit with ID",
    "description": "desc",
    "preconditions": "pre1",
    "labels": ["Frontend", "Backend"],
    "assigneeId": "{{assigneeId}}",
    "components": [
    	{"id": "10000"}
    ],
    "versions": [
    	{"id": "10000"}
    ],
    "environment": "dhdh",
    "priority": {
        "id": 1
    },
    "coveredRequirements": [
        "{{ReqTestKey}}"
    ],
    "timeEstimate": 3,
    "testKey": "newtestkeyd",
    "steps": [
        [{"value": "step1"}, {"value": "step2"}, {"value": "step3"}],
        [{"groupName": "stepgroup"}]
    ],
    "links": [
    {
      "testKey": "newtestkeyd"
    }
  ]
}

Operation SET - generates an exact set of links indicated in the payload

{
    "coveredRequirements":{
      "set":[
         {
            "testKey":"{{ReqTestKey2}}"
         }
      ]
   }
}

Operation ADD - adds links indicated in the payload

{
    "coveredRequirements":{
      "add":[
         {
            "testKey":"{{ReqTestKey2}}"
         }
      ]
   }
}

Operation REMOVE - deletes links indicated in the payload

{
    "coveredRequirements":{
      "remove":[
         {
            "testKey":"{{ReqTestKey2}}"
         }
      ]
   }
}
Note

In case of leaving the SET/ADD/REMOVE playload empty, the set operation will be applied. It means that:

  • links which are not defined in the new playload will be removed
  • existing links will stay the same
  • new links will be added.

How to set up a Components field

It’s possible to set up the Components using their id as well as name:

 "components": [
    	{"name": "{{ComponentName}}"}
    ],
 "components": [
    	{"id": "{{ComponentId}}"}
    ],

How to set up a Priority field

It’s possible to set up the Priority using their id as well as name:


 "priority": [
    	{"name": "{{PriorityName}}"}
    ],
 "priority": [
    	{"id": "{{PriorityId}}"}
    ],

How to set up Test Steps

Rows are defined as a list of the objects: {'value':'cellValue'}.

Groups are defined as objects with the attribute “groupName”: {'groupName':'cellValue'}.

"steps": [
        [{"value": "row1_cell_1"}, {"value": "row1_cell_2"}, {"value": "row1_cell_3"}],
        [{"groupName": "updatestepgroup"}],
        [{"value": "row1_cell_1"}, {"value": "row1_cell_2"}, {"value": "row1_cell_3"}],
    ]