Retrieve current service test details including result if available.

get/service-tests/{id}

This endpoint is called to retrieve the current details and status for a service test request. The result of the test will be returned if available.

Securityoauth2
Request
path Parameters
id
required
string

Find service test details relating to the specified identifier

header Parameters
X-Request-ID
required
string

Unique identifier to identify request and response events across the gateway

X-Conversation-ID
required
string

Identifier to track message journey across the gateway

Responses
200

Request successful - service test details were returned

400

Bad request - supplied request was malformed or missing mandatory parameters

401

Unauthorised access

403

The client is not permitted to access this resource.

404

Service Test not found with the specified id

422

Unprocessable entity - invalid data was provided

500

Unexpected Fibre Gateway error

503

Fibre Gateway is temporarily unavailable

Response samples
application/json
{
  • "id": 123,
  • "status": "IN_PROGRESS",
  • "created": "2022-01-01T09:09:33.001Z",
  • "updated": "2022-01-01T09:45:39.001Z",
  • "supplierReference": "A12345",
  • "serviceId": "SI2345432345345",
  • "problemType": "string",
  • "serviceSpecification": {
    • "id": "ftthl2r",
    • "name": "FTTH"
    },
  • "supplier": "DUMMY_SUPPLIER",
  • "characteristics": [
    • {
      • "name": "string",
      • "value": "string"
      }
    ],
  • "result": {
    • "testValidity": "2022-01-01T09:45:39.001Z",
    • "testMeasures": [
      • {
        • "metricName": "ONT_LIGHT_LEVEL",
        • "captureDateTime": "2022-01-01T09:45:39.001Z",
        • "metricValue": "-14.5",
        • "unitOfMeasure": "decibel",
        • "ruleViolation": false,
        • "ruleSeverity": "WARNING"
        }
      ],
    • "testOutcome": {
      • "testResult": "AMBER",
      • "code": "NO_FAULT_FOUND",
      • "description": "string",
      • "supplierCodes": [
        • "D1234"
        ],
      • "supplierText": "string"
      }
    }
}