Use this information to get a current status summary of an execution.
The following elements are described:
Request
| Aspect |
Value |
| Endpoint URL |
/api/behaviour/executions/{executionId}/progress |
| HTTP Method |
GET |
Path parameters
| Field |
Description |
Mandatory |
| executionId |
ID of the execution |
Yes |
Response
| Aspect |
Value |
| Content-Type |
application/json |
| Response Code |
200 (OK) |
Body
| Field |
Description |
| id |
ID assigned to the execution |
| name |
Name assigned to the execution |
| startedAt |
Date and time the execution started (this might be empty if the execution has not yet
started) |
| finishedAt |
Date and time the execution completed (this might be empty if the execution has not yet
completed) |
| status |
Current execution status (PASS,
IN_PROGRESS, ABORTED, FAIL, or PENDING) |
| stageReports |
A list of reports for each stage in the execution |
| registeredAssemblies |
Details any assemblies created or referenced as part of the execution |
| registeredMetrics |
List of IDs for any metrics recorded during the execution |
| error |
Details of an error if one has occurred |
Each
stageReport entry contains:
| Field |
Description |
| name |
Name of the stage |
| steps |
List of reports for each step |
Each
stepReport entry contains:
| Field |
Description |
| status |
Status of the step execution (PASS, IN_PROGRESS, ABORTED, FAIL, or PENDING) |
| startTime |
Date and time the step execution started (this might be empty if the step has not yet
started) |
| endTime |
Date and time the step execution completed (this might be empty if the step has not yet
completed) |
| stepDisplayName |
Display name of the step being executed |
| stepType |
Type of step (PRECONDITION, ACTION, or EXPECTATION) |
| slices |
List of sentences detailing the action the steps takes |
| error |
Message detailing an error if one has occurred |
Each
registeredAssemblies entry contains:
| Field |
Description |
| assemblyName |
Name of the assembly instance |
| assemblyId |
ID of the assembly instance |
| assemblyDescriptorName |
Name of the descriptor for this Assembly instance |
| installed |
Boolean set to true if the assembly was installed as part of this scenario execution |
| uninstalled |
Boolean set to true if the assembly was uninstalled as part of this scenario
execution |