Get Result Alert Status

11 min

Endpoint Information

URL: {gateway-url}/alerts/status/type/result?executionStatusName={executionStatusName}

Method: GET

Authentication: Required (Bearer Token)

Company Header: Required (X-Company-Id)

Headers

Header	Type	Required	Description
Authorization	String	Yes	Bearer token used for authentication. Example: Bearer <your_access_token>.
X-Company-Id	Long	Yes	The company ID used to scope the request.
Accept	String	No	Recommended value: application/json.

Query Parameters

Parameter	Type	Required	Description
executionStatusName	String	Yes	Execution alert status name. Use EXECUTION_COMPLETED to get result-based alert statuses.

Request Body

This endpoint does not require a request body.

Response Body

{
  "data": [
    "Test Successful",
    "Test Failed",
    "Test Unexecuted",
    "Test Stopped",
    "Test Error",
    "Test Timed Out"
  ]
}

Response Fields

Parameter	Type	Description
data	Array of strings	List of active result alert statuses related to the given execution alert status.

Behavior Notes

This endpoint returns result alert statuses that depend on the given execution alert status.

Use EXECUTION_COMPLETED to retrieve selectable result statuses.

If executionStatusName is EXECUTION_STARTED, the endpoint returns an empty list because there are no result statuses related to the beginning of execution.

The response does not include result.code or result.message.

Error Response Format

Error responses use the common problem detail format.

{
  "instance": "/alerts/status/type/result",
  "status": 400,
  "title": "Bad Request",
  "type": "https://errors.testinium.com/exception",
  "timestamp": "2026-08-18T12:08:41.165927056Z",
  "errorType": "EXCEPTION",
  "errors": {
    "code": 400,
    "message": "Required request parameter 'executionStatusName' is missing",
    "field": "executionStatusName"
  }
}

Error Codes

HTTP Code	Error Message	Description
400	BAD_REQUEST	The request is malformed, the required query parameter is missing or blank, or a required header is missing.
401	UNAUTHORIZED	Authentication failed, authentication is required, or the token is invalid.
403	FORBIDDEN	The user does not have permission to access the requested company or resource.
405	METHOD_NOT_ALLOWED	The HTTP method is not supported. This endpoint only supports GET.
500	INTERNAL_SERVER_ERROR	An unexpected error occurred on the server side.

Application Error Codes

Code	Error Type	HTTP Code	Description
400	EXCEPTION	400	The required executionStatusName query parameter is missing.
10000	EXCEPTION	401	Authentication failed.
10001	EXCEPTION	401	Authentication is required to access this resource.
10002	EXCEPTION	401	The provided token is invalid.
10003	EXCEPTION	403	The user is not authorized for the requested resource.
10004	EXCEPTION	400	A required header is missing. For example, X-Company-Id is not provided.
10005	EXCEPTION	400	A required token claim is missing.
10007	EXCEPTION	403	The user does not have access to the requested resource.
10008	EXCEPTION	500	The routed notification service is unavailable.
20005	VALIDATION	400	The executionStatusName query parameter is blank.
20009	EXCEPTION	405	The HTTP method is not supported.

Example Request

curl --location '{gateway-url}/alerts/status/type/result?executionStatusName=EXECUTION_COMPLETED' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <your_access_token>' \
--header 'X-Company-Id: <company_id>'

Example Request For Empty Result

curl --location '{gateway-url}/alerts/status/type/result?executionStatusName=EXECUTION_STARTED' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <your_access_token>' \
--header 'X-Company-Id: <company_id>'

{
  "data": []
}