Execution Steps
This chapter focuses on services for the execution steps.
Get execution step
A GET
to /execution-steps/{id}
returns the execution step with the given id.
Path parameters
Parameter | Description |
---|---|
|
the id of the execution step |
HTTP request
GET /api/rest/latest/execution-steps/6 HTTP/1.1
Accept: application/json
Host: localhost:8080
Request parameters
Parameter | Description |
---|---|
|
which fields of the elements should be returned (optional) |
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1432
{
"_type" : "execution-step",
"id" : 6,
"execution_status" : "BLOCKED",
"action" : "<p>Click the button</p>",
"expected_result" : "<p>The page shows up</p>",
"comment" : "<p>This is quite simple.</p>",
"last_executed_by" : "User-J9",
"last_executed_on" : "2015-04-26T10:00:00.000+00:00",
"execution_step_order" : 1,
"referenced_test_step" : {
"_type" : "action-step",
"id" : 2,
"_links" : {
"self" : {
"href" : "http://localhost:8080/api/rest/latest/test-steps/2"
}
}
},
"execution" : {
"_type" : "execution",
"id" : 3,
"execution_status" : "BLOCKED",
"_links" : {
"self" : {
"href" : "http://localhost:8080/api/rest/latest/executions/3"
}
}
},
"custom_fields" : [ {
"code" : "CUF_TAG",
"label" : "Tag Cuf",
"value" : [ "tag_1", "tag_2", "tag_3" ]
} ],
"test_step_custom_fields" : [ {
"code" : "CUF_TXT",
"label" : "Basic Text Cuf",
"value" : "The Value"
} ],
"attachments" : [ ],
"_links" : {
"self" : {
"href" : "http://localhost:8080/api/rest/latest/execution-steps/6"
},
"project" : {
"href" : "http://localhost:8080/api/rest/latest/projects/10"
},
"execution" : {
"href" : "http://localhost:8080/api/rest/latest/executions/3"
},
"attachments" : {
"href" : "http://localhost:8080/api/rest/latest/execution-steps/6/attachments"
}
}
}
Response fields
Path | Type | Description |
---|---|---|
|
|
the type of the entity |
|
|
the id of the execution step |
|
|
the status of this execution step |
|
|
the action to be accomplished, format is html |
|
|
the state or behavior that should be observable when the action has been performed, format is html) |
|
|
the comment left after executing the step |
|
|
the date this execution step was last executed |
|
|
the user who last executed this execution |
|
|
the order of the step in the execution |
|
|
the test step referenced by this execution step |
|
|
the execution this step belongs to |
|
|
the custom fields of this execution step |
|
|
the denormalized custom fields of the referenced test step |
|
|
the attachments of the this step |
|
|
related links |
Links
Relation | Description |
---|---|
|
link to this execution step |
|
link to the project of this execution step |
|
link to the execution of this execution step |
|
link to the attachments of this execution step |
Modify status of execution step
A PATCH
to /execution-steps/{id}/execution-status/{status}
modifies the execution status of the execution step with the given id to the given status.
Path parameters
Parameter | Description |
---|---|
|
the id of the execution step |
|
the new status of that execution step (success, blocked, ready, running, error, failure, not-found, not-run, settled, untestable or warning) |
HTTP request
PATCH /api/rest/latest/execution-steps/6/execution-status/Success HTTP/1.1
Accept: application/json
Host: localhost:8080
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1318
{
"_type" : "execution-step",
"id" : 6,
"execution_status" : "SUCCESS",
"action" : "<p>Click the button</p>",
"expected_result" : "<p>The page shows up</p>",
"comment" : "<p>This is quite simple.</p>",
"last_executed_by" : "User-J9",
"last_executed_on" : "2015-04-26T10:00:00.000+00:00",
"execution_step_order" : 1,
"referenced_test_step" : {
"_type" : "action-step",
"id" : 2,
"_links" : {
"self" : {
"href" : "http://localhost:8080/api/rest/latest/test-steps/2"
}
}
},
"execution" : {
"_type" : "execution",
"id" : 3,
"execution_status" : "BLOCKED",
"_links" : {
"self" : {
"href" : "http://localhost:8080/api/rest/latest/executions/3"
}
}
},
"custom_fields" : [ {
"code" : "CUF_TAG",
"label" : "Tag Cuf",
"value" : [ "tag_1", "tag_2", "tag_3" ]
} ],
"test_step_custom_fields" : [ {
"code" : "CUF_TXT",
"label" : "Basic Text Cuf",
"value" : "The Value"
} ],
"attachments" : [ ],
"_links" : {
"self" : {
"href" : "http://localhost:8080/api/rest/latest/execution-steps/6"
},
"project" : {
"href" : "http://localhost:8080/api/rest/latest/projects/10"
},
"execution" : {
"href" : "http://localhost:8080/api/rest/latest/executions/3"
}
}
}
Response fields
Path | Type | Description |
---|---|---|
|
|
the type of the entity |
|
|
the id of the execution step |
|
|
the status of this execution step |
|
|
the action to be accomplished, format is html |
|
|
the state or behavior that should be observable when the action has been performed, format is html) |
|
|
the comment left after executing the step |
|
|
the date this execution step was last executed |
|
|
the user who last executed this execution |
|
|
the order of the step in the execution |
|
|
the test step referenced by this execution step |
|
|
the execution this step belongs to |
|
|
the custom fields of this execution step |
|
|
the denormalized custom fields of the referenced test step |
|
|
the attachments of the test step |
|
|
related links |
Links
Relation | Description |
---|---|
|
link to this execution step |
|
link to the project of this execution step |
|
link to the execution of this execution step |
Modify an execution step
A PATCH
to /execution-steps/{id}
modifies the execution step with the given id.
Path parameters
Parameter | Description |
---|---|
|
the id of the execution step |
HTTP request
PATCH /api/rest/latest/execution-steps/6 HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 180
Host: localhost:8080
{
"_type" : "execution-step",
"comment" : "<p>Updated comment.</p>",
"custom_fields" : [ {
"code" : "TXT_STATUS",
"value" : "Updated execution step CUF value"
} ]
}
Request fields
Path | Type | Description |
---|---|---|
|
|
the type of the entity (mandatory) |
|
|
the new comment of the execution step |
|
|
an array of custom fields |
|
|
the code of the custom field to modify |
|
|
the value of the custom field. It should match the type of the field (text, date etc). If the field accepts only a single value the content is a string, if it accepts multiple values (eg, tags) the content is an array of strings. |
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1377
{
"_type" : "execution-step",
"id" : 6,
"execution_status" : "SUCCESS",
"action" : "<p>Click the button</p>",
"expected_result" : "<p>The page shows up</p>",
"comment" : "<p>Updated comment.</p>",
"last_executed_by" : "User-J9",
"last_executed_on" : "2015-04-26T10:00:00.000+00:00",
"execution_step_order" : 1,
"referenced_test_step" : null,
"execution" : {
"_type" : "execution",
"id" : 3,
"execution_status" : "BLOCKED",
"_links" : {
"self" : {
"href" : "http://localhost:8080/api/rest/latest/executions/3"
}
}
},
"custom_fields" : [ {
"code" : "TXT_STATUS",
"label" : "text",
"value" : "Updated execution step CUF value"
}, {
"code" : "TAGS_RELATED",
"label" : "see also",
"value" : [ "see this", "also that" ]
} ],
"test_step_custom_fields" : [ {
"code" : "TC_TEXT",
"label" : "test case cuf",
"value" : "Updated test case step value"
}, {
"code" : "TC_LABELS",
"label" : "labels",
"value" : [ "was", "not", "updated" ]
} ],
"attachments" : [ ],
"_links" : {
"self" : {
"href" : "http://localhost:8080/api/rest/latest/execution-steps/6"
},
"project" : {
"href" : "http://localhost:8080/api/rest/latest/projects/10"
},
"execution" : {
"href" : "http://localhost:8080/api/rest/latest/executions/3"
}
}
}