Superloop Connect - Service Diagnostic Test Options

Introduction

Use this endpoint to get a list of diagnostic tests available for a service.

Request Lifecycle

To get the list of diagnostic tests available for a service, you must make a GET request to /api/connect/services/{serviceId}/diagnostic-tests/options. The response’s http status will be 200 with the diagnostic tests options in the response body.

Request Specifications

Table 1. API Versions
Version	Header	Changes
1 (Deprecated)	X-API-VERSION=1	Initial Version
2 (Deprecated)	X-API-VERSION=2	No change
3	X-API-VERSION=3	No change
4	X-API-VERSION=4	No change
5	X-API-VERSION=5	No change
6	X-API-VERSION=6	No Change
7	X-API-VERSION=7	No Change

API Version 1, 2, 3, 4, 5, 6 and 7

GET Request

Table 2. GET Request
Verb	GET
URI	/api/connect/services/{serviceId}/diagnostic-tests/options

Table 3. GET Request Path Variables
Path Variable	Purpose
`serviceId`	The id of the service resource

Table 4. GET HTTP Request Headers
Name	Description
`Authorization`	The OAuth bearer access token
`X-API-VERSION`	The version of the endpoint you are accessing

GET Response

Table 5. GET HTTP Status Codes
Status Code	Meaning
200	The body contains the list of available diagnostic tests
401	Bearer token is missing or invalid
404	You do not have permission to perform this task or The id of the service resource provided does not exist
500	There was an unexpected error retrieving the options

Table 6. GET Response Body Fields
Path	Type	Description
`testTypes`	`Array`	The list of tests available for service

API Version 1, 2, 3, 4, 5, 6 and 7 - Examples

Successful Request

A list of diagnostic tests available is returned by sending a GET request to /api/connect/services/{serviceId}/diagnostic-tests/options.

GET Request

GET /api/connect/services/12345/diagnostic-tests/options HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 7
Host: 360-api.superloop.com

Successful GET Response

HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 82

{
  "testTypes" : [ "port-reset", "ntd-uni-d-status", "ntd-status", "loopback" ]
}

Once you have a list of available diagnostic tests, you can run a service diagnostic test by choosing a test and making a request with the service id.