REST API: Test Execution

Owned by Support Advocate (ease solutions)
Last updated: Oct 20, 2020 by Angelica SalazarVersion comment
5 min read
POSTcom.easesolutions.jira.plugins.testmanagement/1.0/executed/prjKey/planId/resultId/step/stepIdExecute a single test step.
POSTcom.easesolutions.jira.plugins.testmanagement/1.0/executed/prjKey/planId/resultId/test/testIdExecute a test.
GETcom.easesolutions.jira.plugins.testmanagement/1.0/execution/prjKey/planIdGet all executions for an existing test plan.
POSTcom.easesolutions.jira.plugins.testmanagement/1.0/execution/prjKey/planIdCreate a new execution.
GETcom.easesolutions.jira.plugins.testmanagement/1.0/result/prjKey/planId/resultIdGet the report for previous test run.



POST /com.easesolutions.jira.plugins.testmanagement/1.0/executed/{prjKey}/{planId}/{resultId}/step/{stepId}
Example Response 
null


Execute a single test step.


PARAMETERS

prjKey*

resultId*

stepId*

planId*

passed

failed

failedContinue

failedContinueStep

message

The project key.

The id of an execution associated with the testplan.

The id of the teststep to execute.

The id of the testplan that contains the test which teststep should be executed.

Fill with anything to set passed to true.

Fill with anything to set failed to true. Values for passed and failedContinue are ignored.

Fill with anything to set failedContinue to true. Values for passed are ignored.

Fill with anything to set failedContinueStep to true. Values for passed are ignored.

A message to describe the teststep result. (Mandatory if failed or failedContinue is filled)

POST /com.easesolutions.jira.plugins.testmanagement/1.0/executed/{prjKey}/{planId}/{resultId}/test/{testId}
Example Response 
null


Execute a test.


PARAMETERS

prjKey*

resultId*

planId*

testId*

passed

failed

failedContinue

message

The project key.

The id of an execution associated with the testplan.

The id of the testplan that contains the test which should be executed.

The id of the test to execute.

Fill with anything to set passed to true.

Fill with anything to set failed to true. Values for passed and failedContinue are ignored.

Fill with anything to set failedContinue to true. Values for passed are ignored.

A message to describe the testresult. (Mandatory if failed or failedContinue is filled)

GET /com.easesolutions.jira.plugins.testmanagement/1.0/execution/{prjKey}/{planId}
Example Response 
[
  	{
    	"id": 12,
    	"name": "Example Execution 1",
    	"description": "An example execution",
    	"deleted": false,
    	"assignee": "admin",
    	"passed": false,
    	"failed": false,
    	"running": false,
    	"notrun": true,
    	"created": 1234567890123
  	},
  	{
    	"id": 13,
    	"name": "Example Execution 2",
    	"description": "Another example execution",
    	"deleted": false,
    	"assignee": "admin",
    	"passed": true,
    	"failed": false,
    	"running": false,
    	"notrun": false,
    	"created": 9876543210987
  	}
]


Get all executions for an existing test plan.


PARAMETERS

prjKey*

planId*

The project key.

The id of the test plan to get all executions for.

POST /com.easesolutions.jira.plugins.testmanagement/1.0/execution/{prjKey}/{planId}
Example Response 
{
  	"id": 12,
  	"name": "Example Execution",
  	"description": "An example execution",
  	"deleted": false,
  	"assignee": "Admin",
  	"passed": false,
  	"failed": false,
  	"running": false,
  	"notrun": true,
  	"created": 1234567890123,
  	"tests": [
    	{
      		"name": "Example Test",
      		"description": "An example test",
      		"descriptionRendered": "<p>An example test</p>",
      		"failureMessage": "",
      		"folders": [
        		"Testfolder"
      		],
      		"failed": false,
      		"passed": false,
      		"notrun": true,
      		"skipped": false,
      		"steps": [
        		{
          			"name": "Teststep 1",
          			"description": "An example teststep",
          			"failureMessage": "",
          			"failed": false,
          			"passed": false,
          			"notrun": true,
          			"skipped": false,
          			"expectedResult": "",
          			"id": 123,
          			"parameters": [
            			{
              				"key": "Parameter",
              				"identifier": "##parameter##",
              				"value": "A parameter value"
            			}
          			]
        		}
      		],
      		"id": 567,
      		"issueUrl": "http://host:port/jira/browse/PRJ-1",
      		"issueKey": "PRJ-1",
      		"issueStatus": "To Do",
      		"issueType": "New Feature"
    	}
  	]
}


Create a new execution.


PARAMETERS

prjKey*

planId*

name

desc

assignee

testProjectId

testComponents

testFixVersions

The project key.

The id of the test plan to create a new execution for.

A name for the execution.

A description for the execution.

The username of a JIRA user to assign the execution to.

The id of the target project. (Default: matches the project specified by the project key)

The test component of the target project.

The fix version in the target project.

GET /com.easesolutions.jira.plugins.testmanagement/1.0/result/{prjKey}/{planId}/{resultId}
Example Response 
{
  	"id": 12,
  	"name": "Example Execution",
  	"description": "An example execution",
  	"deleted": false,
  	"assignee": "Admin",
  	"passed": false,
  	"failed": false,
  	"running": false,
  	"notrun": true,
  	"created": 1234567890123,
  	"tests": [
    	{
      		"name": "Example Test",
      		"description": "An example test",
      		"descriptionRendered": "<p>An example test</p>",
      		"failureMessage": "",
      		"folders": [
        		"Testfolder"
      		],
      		"failed": false,
      		"passed": false,
      		"notrun": true,
      		"skipped": false,
      		"steps": [
        		{
          			"name": "Teststep 1",
          			"description": "An example teststep",
          			"failureMessage": "",
          			"failed": false,
          			"passed": false,
          			"notrun": true,
          			"skipped": false,
          			"expectedResult": "",
          			"id": 123,
          			"parameters": [
            			{
              				"key": "Parameter",
              				"identifier": "##parameter##",
              				"value": "A parameter value"
            			}
          			]
        		}
      		],
      		"id": 567,
      		"issueUrl": "http://host:port/jira/browse/PRJ-1",
      		"issueKey": "PRJ-1",
      		"issueStatus": "To Do",
      		"issueType": "New Feature"
    	}
  	]
}


Get the execution(report) for previous test run.


PARAMETERS

prjKey*

resultId*

planId*

The project key.

The id of the execution to return.

The id of the testplan the requested execution is associated to.