5G-ROUTES Tenant Web Portal
by sozosk

5G-ROUTES Tenant Web Portal

Generate Token
GET /GenerateToken

Generate user access token.

Request headers

username
string required

The use case leader username

Example:
EDIuser
password
string required

The use case leader password

Example:
password

Responses

200 OK
Body
Object
token
string

The access token that can be used in subsequent API calls.

Example:
eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJhY2U5ZDRkMi0wYjhkLTExZWEtOTUxOC00MjAxMGE5YTAwMDMiLCJ0eXBlIjoiYWNjZXNzIiwicHJpbWFyeU9yZ2FuaXNhdGlvbiI6IjhkY2MzNjgwLTBiOGEtMTFlYS05NTE4LTQyMDEwYTlhMDAwMyIsImN1cnJlbnRPcmdhbmlzYXRpb24iOiI4ZGNjMzY4MC0wYjhhLTExZWEtOTUxOC00MjAxMGE5YTAwMDMiLCJzY29wZSI6WyJjdXN0b21lci13cml0ZSIsIm9yZGVyLXJlYWQiXSwicHJlZmVycmVkX3VzZXJuYW1lIjoiamQiLCJlbWFpbCI6ImpkQGNybS5jb20iLCJleHAiOjE1Nzk4ODA2Mjl9.-uJyEW-Y_QgHb1q-WHBBMew3J_TnUfvqy-NDFmIzFhbS3gkerE5QAqp4cgNMr5BiGcyt174UVhYGXp2Fg7BKcw
expirationdate_utc
string

The expiration date/time of the token.

Example:
02:59:59.8692352
400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter.

401 Unauthorized

The provided API Key or Token is invalid.

403 Forbidden

The API key or Token does not have permissions to perform the request.

404 Not Found

The requested resource does not exist.

500 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request.

502 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request.

503 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance.

504 Gateway Timeout

The server did not receive a timely response from the upstream server.

Example 1

Example 1

GET /generatetoken HTTP/1.1 

username: EDIuser
password: 3D1us3r

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "token": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJhY2U5ZDRkMi0wYjhkLTExZWEtOTUxOC00MjAxMGE5YTAwMDMiLCJ0eXBlIjoiYWNjZXNzIiwicHJpbWFyeU9yZ2FuaXNhdGlvbiI6IjhkY2MzNjgwLTBiOGEtMTFlYS05NTE4LTQyMDEwYTlhMDAwMyIsImN1cnJlbnRPcmdhbmlzYXRpb24iOiI4ZGNjMzY4MC0wYjhhLTExZWEtOTUxOC00MjAxMGE5YTAwMDMiLCJzY29wZSI6WyJjdXN0b21lci13cml0ZSIsIm9yZGVyLXJlYWQiXSwicHJlZmVycmVkX3VzZXJuYW1lIjoiamQiLCJlbWFpbCI6ImpkQGNybS5jb20iLCJleHAiOjE1Nzk4ODA2Mjl9.-uJyEW-Y_QgHb1q-WHBBMew3J_TnUfvqy-NDFmIzFhbS3gkerE5QAqp4cgNMr5BiGcyt174UVhYGXp2Fg7BKcw",
    "expirationdate_utc": "1651643388"
}
show more
Use Cases
Create Use Case
POST /usecases/create
Update Use Case
PUT /usecases/update/{id}
List Use Cases
GET /usecases
Delete Use Case
DELETE /usecases/delete/{id}
Create Use Case
POST /usecases/create

Create a new Use Case.

Request headers

token
string required

The authorization token required for API calls to ensure that the client is trusted.

Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IkFEU0YgVXNlciIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFEU0YiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQURTRnVzZXIiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiIxOSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL3N5c3RlbSI6IjEiLCJleHAiOjE2NTIxOTM2Mzl9.JC9wMvR0w_oWI-duR48zoDiJPU_y0cAkWbu-4F9585Y

Request body

Object
code
string required

User readable code (id) of the Use Case.

Example:
1.1
description
string required

The Use Case description.

Example:
Dynamic vehicles platooning
responsible
string nullable

The partner responsible for the Use Case.

Example:
EDI
contact
string nullable

The Use Case leader.

Example:
John Smith
category
string required

The use case category.

Enumeration:
AUTOMATED_DRIVING
AWARENESS_DRIVING
SENSING_DRIVING
MULTIMODAL_SERVICES
UNINTERUPTED_INFOTAINMENT

Responses

200 OK

The request has succeded.

Body
Object
id
string Numerical Key

The Use Case identifier.

Example:
10123
400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter.

401 Unauthorized

The provided API Key or Token is invalid.

403 Forbidden

The API key or Token does not have permissions to perform the request.

404 Not Found

The requested resource does not exist.

500 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request.

502 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request.

503 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance.

504 Gateway Timeout

The server did not receive a timely response from the upstream server.

Example 1

Example 1

POST /usecases/create HTTP/1.1 

token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IkFEU0YgVXNlciIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFEU0YiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQURTRnVzZXIiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiIxOSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL3N5c3RlbSI6IjEiLCJleHAiOjE2NTIxOTM2Mzl9.JC9wMvR0w_oWI-duR48zoDiJPU_y0cAkWbu-4F9585Y
Content-Type: application/json

{
    "code": "1.1",
    "description": "Dynamic vehicles platooning",
    "responsible": "EDI",
    "contact": "John Smith",
    "category": "AUTOMATED_DRIVING"
}

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "id": "10123"
}
show more
Update Use Case
PUT /usecases/update/{id}

Update a Use Case. It is possible to supply a partial body so that only supplied items will be updated.

Path variables

id
string Numerical Key required

The Use Case identifier.

Example:
10123

Request headers

token
string required

The authorization token required for API calls to ensure that the client is trusted.

Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IkFEU0YgVXNlciIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFEU0YiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQURTRnVzZXIiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiIxOSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL3N5c3RlbSI6IjEiLCJleHAiOjE2NTIxOTM2Mzl9.JC9wMvR0w_oWI-duR48zoDiJPU_y0cAkWbu-4F9585Y

Request body

Object
code
string required

User readable code (id) of the Use Case.

Example:
1.1
description
string required

The Use Case description.

Example:
Dynamic vehicles platooning
responsible
string nullable

The partner responsible for the Use Case.

Example:
EDI
contact
string nullable

The Use Case leader.

Example:
John Smith
category
string required

The Use Case category.

Enumeration:
AUTOMATED_DRIVING
AWARENESS_DRIVING
SENSING_DRIVING
MULTIMODAL_SERVICES
UNINTERUPTED_INFOTAINMENT

Responses

200 OK

The request has succeded.

Body
Object
id
string Numerical Key

The Use Case identifier.

Example:
10123
400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter.

401 Unauthorized

The provided API Key or Token is invalid.

403 Forbidden

The API key or Token does not have permissions to perform the request.

404 Not Found

The requested resource does not exist.

500 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request.

502 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request.

503 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance.

504 Gateway Timeout

The server did not receive a timely response from the upstream server.

Example 1

Example 1

PUT /usecases/update/10123 HTTP/1.1 

token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IkFEU0YgVXNlciIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFEU0YiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQURTRnVzZXIiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiIxOSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL3N5c3RlbSI6IjEiLCJleHAiOjE2NTIxOTM2Mzl9.JC9wMvR0w_oWI-duR48zoDiJPU_y0cAkWbu-4F9585Y
Content-Type: application/json

{
    "code": "1.1",
    "description": "Dynamic vehicles platooning",
    "responsible": "EDI",
    "contact": "John Smith",
    "category": "MULTIMODAL_SERVICES"
}

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "id": "10123"
}
show more
List Use Cases
GET /usecases

Retreive list of Use Cases (based on provided token).

Request headers

token
string required

The authorization token required for API calls to ensure that the client is trusted.

Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IkFEU0YgVXNlciIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFEU0YiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQURTRnVzZXIiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiIxOSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL3N5c3RlbSI6IjEiLCJleHAiOjE2NTIxOTM2Mzl9.JC9wMvR0w_oWI-duR48zoDiJPU_y0cAkWbu-4F9585Y

Responses

200 OK

The request has succeded.

Body
Array
Object
use_case_id
string Numerical Key

The Use Case identifier.

Example:
10123
code
string

User readable code of the Use Case.

Example:
5.2
category
string

The Use Case category.

Example:
MULTIMODAL_SERVICES
contact
string

The Use Case Leader

Example:
John Smith
description
string

The Use Case description.

Example:
5.2 - 5G-based proactive and multimodal management of passengers and freight
responsible
string

The partner responsible for the Use Case.

Example:
WINGS
updated_date
string

The Use Case last updated date.

Example:
2022-04-27T09:20:34.447
400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter.

401 Unauthorized

The provided API Key or Token is invalid.

403 Forbidden

The API key or Token does not have permissions to perform the request.

404 Not Found

The requested resource does not exist.

500 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request.

502 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request.

503 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance.

504 Gateway Timeout

The server did not receive a timely response from the upstream server.

Example 1

Example 1

GET /usecases HTTP/1.1 

token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IkFEU0YgVXNlciIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFEU0YiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQURTRnVzZXIiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiIxOSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL3N5c3RlbSI6IjEiLCJleHAiOjE2NTIxOTM2Mzl9.JC9wMvR0w_oWI-duR48zoDiJPU_y0cAkWbu-4F9585Y

HTTP/1.1 200 OK 

Content-Type: application/json

[
    {
        "use_case_id": "10123",
        "code": "5.2",
        "category": "MULTIMODAL_SERVICES",
        "contact": "John Smith",
        "description": "5.2 - 5G-based proactive and multimodal Management of Passengers and freight",
        "responsible": "WINGS",
        "updated_date": "2022-04-27T09:20:34.447"
    },
    {
        "use_case_id": "10124",
        "code": "5.3",
        "category": "MULTIMODAL_SERVICES",
        "contact": "John Smith",
        "description": "5.3 - FRMCS telemetry operation",
        "responsible": "EVR",
        "updated_date": "2022-04-27T09:20:34.447"
    }
]
show more
Delete Use Case
DELETE /usecases/delete/{id}

Delete a Use Case.

Path variables

id
string Numerical Key required

The Use Case identifier.

Example:
10123

Request headers

token
string required

The authorization token required for API calls to ensure that the client is trusted.

Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IkFEU0YgVXNlciIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFEU0YiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQURTRnVzZXIiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiIxOSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL3N5c3RlbSI6IjEiLCJleHAiOjE2NTIxOTM2Mzl9.JC9wMvR0w_oWI-duR48zoDiJPU_y0cAkWbu-4F9585Y

Responses

200 OK

The request has succeded.

400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter.

401 Unauthorized

The provided API Key or Token is invalid.

403 Forbidden

The API key or Token does not have permissions to perform the request.

404 Not Found

The requested resource does not exist.

500 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request.

502 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request.

503 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance.

504 Gateway Timeout

The server did not receive a timely response from the upstream server.

Example 1

Example 1

DELETE /usecases/delete/10123 HTTP/1.1 

token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IkFEU0YgVXNlciIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFEU0YiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQURTRnVzZXIiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiIxOSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL3N5c3RlbSI6IjEiLCJleHAiOjE2NTIxOTM2Mzl9.JC9wMvR0w_oWI-duR48zoDiJPU_y0cAkWbu-4F9585Y

HTTP/1.1 200 OK
show more
KPIs
Create New KPI
POST /usecases/{id}/status_pi/create
Update KPI
PUT /usecases/{id}/status_pi/update/{status_pi_id}
List KPIs
GET /usecases/{id}/status_pi
Delete KPI
DELETE /usecases/{id}/status_pi/delete/{status_pi_id}
Create New KPI
POST /usecases/{id}/status_pi/create

Create a new KPI for a Use Case.

Path variables

id
string Numerical Key required

The Use Case identifier.

Example:
10123

Request headers

token
string required

The authorization token required for API calls to ensure that the client is trusted.

Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IkFEU0YgVXNlciIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFEU0YiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQURTRnVzZXIiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiIxOSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL3N5c3RlbSI6IjEiLCJleHAiOjE2NTIxOTM2Mzl9.JC9wMvR0w_oWI-duR48zoDiJPU_y0cAkWbu-4F9585Y

Request body

Object
composite_kpi
string required

The composite KPI type.

Enumeration:
LOCALISATION
THROUGHPUT
SERVICE_CONTINUITY
RELIABILITY
LATENCY
name
string required

The name of the Stauts Pi.

Example:
Cruise speed deviation
code
string

User readable code of the Status PI.

Example:
crd
unit
string nullable

The unit of the Status PI.

Enumeration:
cm
m
m/s
deg
ms
s
%
Mbps
Hz
Example:
m
red_threshold
number required

The red threshold of the Status PI.

Example:
10
green_threshold
number required

The green threshold of the Status PI.

Example:
5
red_threshold_operator
string required

The operator of the red threshold.

Enumeration:
>

Greater than

<

Less than

>=

Greater than or equals

<=

Less than or equals

=

Equals

Example:
>=
green_threshold_operator
string required

The operator of the green threshold.

Enumeration:
>

Greater than

<

Less than

>=

Greater than or equals

<=

Less than or equals

=

Equals

Example:
<

Responses

200 OK

The request has succeded.

Body
Object
id
string Numerical Key

The Status PI identifier.

Example:
2048
400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter.

401 Unauthorized

The provided API Key or Token is invalid.

403 Forbidden

The API key or Token does not have permissions to perform the request.

404 Not Found

The requested resource does not exist.

500 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request.

502 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request.

503 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance.

504 Gateway Timeout

The server did not receive a timely response from the upstream server.

Example 1

Example 1

POST /usecases/10123/status_pi/create HTTP/1.1 

token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IkFEU0YgVXNlciIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFEU0YiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQURTRnVzZXIiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiIxOSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL3N5c3RlbSI6IjEiLCJleHAiOjE2NTIxOTM2Mzl9.JC9wMvR0w_oWI-duR48zoDiJPU_y0cAkWbu-4F9585Y
Content-Type: application/json

{
    "composite_kpi": "LOCALISATION",
    "name": "Cruise speed deviation",
    "code": "crd",
    "unit": "m",
    "red_threshold": 10,
    "green_threshold": 5,
    "red_threshold_operator": ">=",
    "green_threshold_operator": "<"
}

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "id": "2048"
}
show more
Update KPI
PUT /usecases/{id}/status_pi/update/{status_pi_id}

Update KPI of a Use Case.

Path variables

id
string Numerical Key required

The Use Case identifier.

Example:
10123
status_pi_id
string Numerical Key required

The Status PI identifier.

Example:
2048

Request headers

token
string required

The authorization token required for API calls to ensure that the client is trusted.

Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IkFEU0YgVXNlciIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFEU0YiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQURTRnVzZXIiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiIxOSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL3N5c3RlbSI6IjEiLCJleHAiOjE2NTIxOTM2Mzl9.JC9wMvR0w_oWI-duR48zoDiJPU_y0cAkWbu-4F9585Y

Request body

Object
composite_kpi
string required

The composite KPI type.

Enumeration:
LOCALISATION
BANDWIDTH
CAPACITY
RELIABILITY
LATENCY
Example:
LOCALISATION
name
string required

The name of the Stauts Pi.

Example:
Cruise speed deviation
code
string GUID

User readable code of the Status PI.

Example:
crd
unit
string nullable

The unit of the Status PI.

Enumeration:
cm
m
m/s
deg
ms
s
%
Mbps
Hz
Example:
m
red_threshold
number required

The red threshold of the Status PI.

Example:
10
green_threshold
number required

The green threshold of the Status PI.

Example:
5
red_threshold_operator
string required

The operator of the red threshold.

Enumeration:
>

Greater than

&lt;

Less than

>=

Greater than or equals

&lt;=

Less than or equals

=

Equals

Example:
>=
green_threshold_operator
string required

The operator of the green threshold.

Enumeration:
>

Greater than

&lt;

Less than

>=

Greater than or equals

&lt;=

Less than or equals

=

Equals

Example:
<

Responses

200 OK

The request has succeded.

Body
Object
id
string Numerical Key

The Status PI identifier.

Example:
2048
400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter.

401 Unauthorized

The provided API Key or Token is invalid.

403 Forbidden

The API key or Token does not have permissions to perform the request.

404 Not Found

The requested resource does not exist.

500 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request.

502 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request.

503 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance.

504 Gateway Timeout

The server did not receive a timely response from the upstream server.

Example 1

Example 1

PUT /usecases/10123/status_pi/update/2048 HTTP/1.1 

token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IkFEU0YgVXNlciIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFEU0YiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQURTRnVzZXIiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiIxOSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL3N5c3RlbSI6IjEiLCJleHAiOjE2NTIxOTM2Mzl9.JC9wMvR0w_oWI-duR48zoDiJPU_y0cAkWbu-4F9585Y
Content-Type: application/json

{
    "composite_kpi": "LOCALISATION",
    "name": "Cruise speed deviation",
    "code": "crd",
    "unit": "m",
    "red_threshold": 10,
    "green_threshold": 5,
    "red_threshold_operator": ">=",
    "green_threshold_operator": "<"
}

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "id": "2048"
}
show more
List KPIs
GET /usecases/{id}/status_pi

Retreive list of KPIs of a Use Case.

Path variables

id
string Numerical Key required

The Use Case identifier.

Example:
10123

Request parameters

composite_kpi
string optional

Filter based on composite KPI

Enumeration:
LOCALISATION
BANDWIDTH
CAPACITY
RELIABILITY
LATENCY

Request headers

token
string required

The authorization token required for API calls to ensure that the client is trusted.

Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IkFEU0YgVXNlciIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFEU0YiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQURTRnVzZXIiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiIxOSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL3N5c3RlbSI6IjEiLCJleHAiOjE2NTIxOTM2Mzl9.JC9wMvR0w_oWI-duR48zoDiJPU_y0cAkWbu-4F9585Y

Responses

200 OK

The request has succeded.

Body
Array
Object
status_pi_id
string Numerical Key

The Status PI identifier.

Example:
2048
composite_kpi
string

The composite KPI type.

Example:
LOCALISATION
name
string

The Status PI name.

Example:
Cruise speed deviation
code
string

User readable code of the Status PI (unique per Use Case).

Example:
crsd
unit
string

The unit od the Status PI.

Example:
m
red_threshold
string

The red threshold of the Status PI.

Example:
10
green_threshold
string

The green threshold of the Status PI.

Example:
5
red_threshold_operator
string

The operator of the red threshold.

Example:
>=
green_threshold_operator
string

The operator of the green threshold.

Example:
<
400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter.

401 Unauthorized

The provided API Key or Token is invalid.

403 Forbidden

The API key or Token does not have permissions to perform the request.

404 Not Found

The requested resource does not exist.

500 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request.

502 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request.

503 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance.

504 Gateway Timeout

The server did not receive a timely response from the upstream server.

Example 1
Example 2

Example 1

GET /usecases/10123/statuspi HTTP/1.1 

token: eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJhY2U5ZDRkMi0wYjhkLTExZWEtOTUxOC00MjAxMGE5YTAwMDMiLCJ0eXBlIjoiYWNjZXNzIiwicHJpbWFyeU9yZ2FuaXNhdGlvbiI6IjhkY2MzNjgwLTBiOGEtMTFlYS05NTE4LTQyMDEwYTlhMDAwMyIsImN1cnJlbnRPcmdhbmlzYXRpb24iOiI4ZGNjMzY4MC0wYjhhLTExZWEtOTUxOC00MjAxMGE5YTAwMDMiLCJzY29wZSI6WyJjdXN0b21lci13cml0ZSIsIm9yZGVyLXJlYWQiXSwicHJlZmVycmVkX3VzZXJuYW1lIjoiamQiLCJlbWFpbCI6ImpkQGNybS5jb20iLCJleHAiOjE1Nzk4ODA2Mjl9.-uJyEW-Y_QgHb1q-WHBBMew3J_TnUfvqy-NDFmIzFhbS3gkerE5QAqp4cgNMr5BiGcyt174UVhYGXp2Fg7BKcw

HTTP/1.1 200 OK 

Content-Type: application/json

[
    {
        "status_pi_id": "2048",
        "composite_kpi": "LOCALISATION",
        "name": "Cruise speed deviation",
        "code": "crd",
        "unit": "m",
        "red_threshold": 10,
        "red_threshold_operator": ">=",
        "green_threshold": 5,
        "green_threshold_operator": "<"
    },
    {
        "status_pi_id": "2049",
        "composite_kpi": "BANDWIDTH",
        "name": "Minimum granted throughput",
        "code": "mgt",
        "unit": "Mbps",
        "red_threshold": 2,
        "red_threshold_operator": "<=",
        "green_threshold": 5,
        "green_threshold_operator": ">"
    },
    {
        "status_pi_id": "2050",
        "composite_kpi": "CAPACITY",
        "name": "Nb vehicles per cell per MHz",
        "code": "nvpcp",
        "unit": null,
        "red_threshold": 0.1,
        "red_threshold_operator": "<",
        "green_threshold": 0.5,
        "green_threshold_operator": ">"
    },
    {
        "status_pi_id": "2051",
        "composite_kpi": "RELIABILITY",
        "name": "Packet loss intensity (packets per mil. packets)",
        "code": "pli",
        "unit": null,
        "red_threshold": 20,
        "red_threshold_operator": ">",
        "green_threshold": 20,
        "green_threshold_operator": "<"
    },
    {
        "status_pi_id": "2052",
        "composite_kpi": "LATENCY",
        "name": "Latency (ms) (Median - 50% percentile)",
        "code": "lat50",
        "unit": "ms",
        "red_threshold": 200,
        "red_threshold_operator": ">",
        "green_threshold": 100,
        "green_threshold_operator": "<"
    }
]
show more

Example 2 - with parameter

GET /usecases/10123/statuspi?composite_kpi=LOCALISATION HTTP/1.1 

token: eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJhY2U5ZDRkMi0wYjhkLTExZWEtOTUxOC00MjAxMGE5YTAwMDMiLCJ0eXBlIjoiYWNjZXNzIiwicHJpbWFyeU9yZ2FuaXNhdGlvbiI6IjhkY2MzNjgwLTBiOGEtMTFlYS05NTE4LTQyMDEwYTlhMDAwMyIsImN1cnJlbnRPcmdhbmlzYXRpb24iOiI4ZGNjMzY4MC0wYjhhLTExZWEtOTUxOC00MjAxMGE5YTAwMDMiLCJzY29wZSI6WyJjdXN0b21lci13cml0ZSIsIm9yZGVyLXJlYWQiXSwicHJlZmVycmVkX3VzZXJuYW1lIjoiamQiLCJlbWFpbCI6ImpkQGNybS5jb20iLCJleHAiOjE1Nzk4ODA2Mjl9.-uJyEW-Y_QgHb1q-WHBBMew3J_TnUfvqy-NDFmIzFhbS3gkerE5QAqp4cgNMr5BiGcyt174UVhYGXp2Fg7BKcw

HTTP/1.1 200 OK 

Content-Type: application/json

[
    {
        "status_pi_id": "2048",
        "composite_kpi": "LOCALISATION",
        "name": "Cruise speed deviation",
        "code": "crd",
        "unit": "m",
        "red_threshold": 10,
        "red_threshold_operator": ">=",
        "green_threshold": 5,
        "green_threshold_operator": "<"
    }
]
show more
Delete KPI
DELETE /usecases/{id}/status_pi/delete/{status_pi_id}

Delete a KPI.

Path variables

id
string Numerical Key required

The Use Case identifier.

Example:
10123
status_pi_id
string Numerical Key required

The Status PI identifier.

Example:
2048

Request headers

token
string required

The authorization token required for API calls to ensure that the client is trusted.

Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IkFEU0YgVXNlciIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFEU0YiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQURTRnVzZXIiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiIxOSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL3N5c3RlbSI6IjEiLCJleHAiOjE2NTIxOTM2Mzl9.JC9wMvR0w_oWI-duR48zoDiJPU_y0cAkWbu-4F9585Y

Responses

200 OK

The request has succeded.

400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter.

401 Unauthorized

The provided API Key or Token is invalid.

403 Forbidden

The API key or Token does not have permissions to perform the request.

404 Not Found

The requested resource does not exist.

500 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request.

502 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request.

503 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance.

504 Gateway Timeout

The server did not receive a timely response from the upstream server.

Example 1

Example 1

DELETE /usecases/10123/status_pi/delete/2048 HTTP/1.1 

token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IkFEU0YgVXNlciIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFEU0YiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQURTRnVzZXIiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiIxOSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL3N5c3RlbSI6IjEiLCJleHAiOjE2NTIxOTM2Mzl9.JC9wMvR0w_oWI-duR48zoDiJPU_y0cAkWbu-4F9585Y

HTTP/1.1 200 OK
show more
Test Cases
Create Test Case
POST /usecases/{id}/scenario/create
Update Test Case
PUT /usecases/{id}/scenario/{test_scenario_id}/update
List Test Cases
GET /usecases/{id}/scenario
Delete Test Case
DELETE /usecases/{id}/scenario/{test_scenario_id}/delete
Create Test Case
POST /usecases/{id}/scenario/create

Create a new Test Case.

Path variables

id
string Numerical Key required

The Use Case identifier.

Example:
10123

Request headers

token
string required

The authorization token required for API calls to ensure that the client is trusted.

Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IkFEU0YgVXNlciIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFEU0YiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQURTRnVzZXIiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiIxOSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL3N5c3RlbSI6IjEiLCJleHAiOjE2NTIxOTM2Mzl9.JC9wMvR0w_oWI-duR48zoDiJPU_y0cAkWbu-4F9585Y

Request body

Object
description
string required

The Test Scenario description.

Example:
Test Scenario 1.1_1
type
string required

The Test Scenario type.

Enumeration:
LAB
FIELD

Responses

200 OK

The request has succeded.

Body
Object
id
string Numerical Key

The Test Scenario identifier.

Example:
10078
400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter.

401 Unauthorized

The provided API Key or Token is invalid.

403 Forbidden

The API key or Token does not have permissions to perform the request.

404 Not Found

The requested resource does not exist.

500 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request.

502 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request.

503 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance.

504 Gateway Timeout

The server did not receive a timely response from the upstream server.

Example 1

Example 1

POST /usecases/10123/scenario/create HTTP/1.1 

token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IkFEU0YgVXNlciIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFEU0YiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQURTRnVzZXIiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiIxOSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL3N5c3RlbSI6IjEiLCJleHAiOjE2NTIxOTM2Mzl9.JC9wMvR0w_oWI-duR48zoDiJPU_y0cAkWbu-4F9585Y
Content-Type: application/json

{
    "description": "Test Scenario 1.1_1",
    "type": "FIELD"
}

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "id": "10078"
}
show more
Update Test Case
PUT /usecases/{id}/scenario/{test_scenario_id}/update

Update a Test Case.

Path variables

id
string Numerical Key required

The Use Case identifier.

Example:
10123
test_scenario_id
string Numerical Key required

The Test Scenario identifier.

Example:
10078

Request headers

token
string required

The authorization token required for API calls to ensure that the client is trusted.

Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IkFEU0YgVXNlciIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFEU0YiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQURTRnVzZXIiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiIxOSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL3N5c3RlbSI6IjEiLCJleHAiOjE2NTIxOTM2Mzl9.JC9wMvR0w_oWI-duR48zoDiJPU_y0cAkWbu-4F9585Y

Request body

Object
description
string required

The Test Scenario description.

Example:
Test Scenario 1.1_1
type
string required

The Test Scenario type.

Enumeration:
LAB
FIELD

Responses

200 OK

The request has succeded.

Body
Object
id
string Numerical Key

The Test Scenario identifier.

Example:
10078
400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter.

401 Unauthorized

The provided API Key or Token is invalid.

403 Forbidden

The API key or Token does not have permissions to perform the request.

404 Not Found

The requested resource does not exist.

500 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request.

502 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request.

503 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance.

504 Gateway Timeout

The server did not receive a timely response from the upstream server.

Example 1

Example 1

PUT /usecases/10123/scenario/10078/update HTTP/1.1 

token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IkFEU0YgVXNlciIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFEU0YiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQURTRnVzZXIiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiIxOSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL3N5c3RlbSI6IjEiLCJleHAiOjE2NTIxOTM2Mzl9.JC9wMvR0w_oWI-duR48zoDiJPU_y0cAkWbu-4F9585Y
Content-Type: application/json

{
    "description": "Test Scenario 1.1_1",
    "type": "LAB"
}

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "id": "10078"
}
show more
List Test Cases
GET /usecases/{id}/scenario

Retreive list of Test Case of a Use Case.

Path variables

id
string Numerical Key required

The Use Case identifier.

Example:
10123

Request headers

token
string required

The authorization token required for API calls to ensure that the client is trusted.

Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IkFEU0YgVXNlciIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFEU0YiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQURTRnVzZXIiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiIxOSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL3N5c3RlbSI6IjEiLCJleHAiOjE2NTIxOTM2Mzl9.JC9wMvR0w_oWI-duR48zoDiJPU_y0cAkWbu-4F9585Y

Responses

200 OK

The request has succeded.

Body
Array
Object
id
string Numerical Key

The Test Scenario identifier.

Example:
10078
description
string

The Test Scenario description.

Example:
Test Scenario 1.1_1
type
string

The Test Scenario Type

Enumeration:
LAB
FIELD
Example:
LAB
400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter.

401 Unauthorized

The provided API Key or Token is invalid.

403 Forbidden

The API key or Token does not have permissions to perform the request.

404 Not Found

The requested resource does not exist.

500 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request.

502 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request.

503 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance.

504 Gateway Timeout

The server did not receive a timely response from the upstream server.

Example 1

Example 1

GET /usecases/10123/scenario HTTP/1.1 

token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IkFEU0YgVXNlciIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFEU0YiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQURTRnVzZXIiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiIxOSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL3N5c3RlbSI6IjEiLCJleHAiOjE2NTIxOTM2Mzl9.JC9wMvR0w_oWI-duR48zoDiJPU_y0cAkWbu-4F9585Y

HTTP/1.1 200 OK 

Content-Type: application/json

[
    {
        "id": "10078",
        "description": "Test Scenario 1.1_1",
        "type": "LAB"
    },
    {
        "id": "10079",
        "description": "Test Scenario 1.1_2",
        "type": "LAB"
    },
    {
        "id": "10080",
        "description": "Test Scenario 1.1_3",
        "type": "FIELD"
    }
]
show more
Delete Test Case
DELETE /usecases/{id}/scenario/{test_scenario_id}/delete

Delete a Test Case.

Path variables

id
string Numerical Key required

The Use Case identifier.

Example:
10123
test_scenario_id
string Numerical Key required

The Test Scenario identifier.

Example:
10078

Request headers

token
string required

The authorization token required for API calls to ensure that the client is trusted.

Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IkFEU0YgVXNlciIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFEU0YiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQURTRnVzZXIiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiIxOSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL3N5c3RlbSI6IjEiLCJleHAiOjE2NTIxOTM2Mzl9.JC9wMvR0w_oWI-duR48zoDiJPU_y0cAkWbu-4F9585Y

Responses

200 OK

The request has succeded.

400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter.

401 Unauthorized

The provided API Key or Token is invalid.

403 Forbidden

The API key or Token does not have permissions to perform the request.

404 Not Found

The requested resource does not exist.

500 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request.

502 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request.

503 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance.

504 Gateway Timeout

The server did not receive a timely response from the upstream server.

Example 1

Example 1

DELETE /usecases/10123/scenario/10078/delete HTTP/1.1 

token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IkFEU0YgVXNlciIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFEU0YiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQURTRnVzZXIiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiIxOSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL3N5c3RlbSI6IjEiLCJleHAiOjE2NTIxOTM2Mzl9.JC9wMvR0w_oWI-duR48zoDiJPU_y0cAkWbu-4F9585Y

HTTP/1.1 200 OK
show more
Experiments
Set KPI Measurements
POST /usecases/{id}/scenario/{test_scenario_id}/test/{test_unique_key}
List Experiment Evaluations
GET /usecases/{id}/scenario/{test_scenario_id}/test/{test_unique_key}
Update Experiment description
PUT /usecases/{id}/scenario/{test_scenario_id}/test/{test_unique_key}/update
List Experiments
GET /usecases/{id}/scenario/{test_scenario_id}/test
Set KPI Measurements
POST /usecases/{id}/scenario/{test_scenario_id}/test/{test_unique_key}

Set KPI measurements for each KPI configured.

Path variables

id
string Numerical Key required

The Use Case identifier.

Example:
10078
test_scenario_id
string Numerical Key required

The Test Scenario identifier.

test_unique_key
string required

The Test unique key.

Example:
UC1.1SC10078LT_T1

Request headers

token
string required

The authorization token required for API calls to ensure that the client is trusted.

Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IkFEU0YgVXNlciIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFEU0YiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQURTRnVzZXIiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiIxOSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL3N5c3RlbSI6IjEiLCJleHAiOjE2NTIxOTM2Mzl9.JC9wMvR0w_oWI-duR48zoDiJPU_y0cAkWbu-4F9585Y

Request body

Array
Object
pi_code
string

User readable code of the Status PI.

Example:
crd
value
number

The value of the measurement

Example:
10

Responses

200 OK

The request has succeded.

Body
Array
Object
status_pi_code
string

User readable code of the Status PI.

Example:
crd
value
string

The value of the measurement

Example:
10
400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter.

401 Unauthorized

The provided API Key or Token is invalid.

403 Forbidden

The API key or Token does not have permissions to perform the request.

404 Not Found

The requested resource does not exist.

500 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request.

502 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request.

503 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance.

504 Gateway Timeout

The server did not receive a timely response from the upstream server.

Example 1

Example 1

POST /usecases/10078/scenario/{test_scenario_id}/test/UC1.1SC10078LT_T1 HTTP/1.1 

token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IkFEU0YgVXNlciIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFEU0YiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQURTRnVzZXIiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiIxOSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL3N5c3RlbSI6IjEiLCJleHAiOjE2NTIxOTM2Mzl9.JC9wMvR0w_oWI-duR48zoDiJPU_y0cAkWbu-4F9585Y
Content-Type: application/json

[
    {
        "pi_code": "crd",
        "value": 10
    },
        {
        "pi_code": "tdbvu",
        "value": 2.5
    },
        {
        "pi_code": "tdbvl",
        "value": 0.9
    }
]

HTTP/1.1 200 OK 

Content-Type: application/json

[
    {
        "pi_code": "crd",
        "value": 10
    },
        {
        "pi_code": "tdbvu",
        "value": 2.5
    },
        {
        "pi_code": "tdbvl",
        "value": 0.9
    }
]
show more
List Experiment Evaluations
GET /usecases/{id}/scenario/{test_scenario_id}/test/{test_unique_key}

Retreive KPI measurements and evaluations for each KPI configured.

Path variables

id
string Numerical Key required

The Test Scenario identifier.

Example:
10123
test_scenario_id
string Numerical Key required

The Test Scenario identifier.

Example:
10078
test_unique_key
string required

The Test unique key.

Example:
UC1.1SC10078LT_T1

Request headers

token
string required

The authorization token required for API calls to ensure that the client is trusted.

Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IkFEU0YgVXNlciIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFEU0YiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQURTRnVzZXIiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiIxOSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL3N5c3RlbSI6IjEiLCJleHAiOjE2NTIxOTM2Mzl9.JC9wMvR0w_oWI-duR48zoDiJPU_y0cAkWbu-4F9585Y

Responses

200 OK

The request has succeded.

Body
Array
Object
composite_kpi
string

The composite KPI type

Enumeration:
LOCALISATION
BANDWIDTH
RELIABILITY
CAPACITY
LATENCY
composite_kpi_value
number

Value of the composite KPI evaluation.

Example:
75
status_pi
Array

Status PI information

Object
description
string

The Status PI description.

Example:
Cruise speed deviation
code
string

User readable code of the Status PI

Example:
crd
value
number

The value of the measurement

Example:
10
evaluation
string

The evaluation of the measurement

Enumeration:
GOOD
ACCEPTABLE
BAD
400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter.

401 Unauthorized

The provided API Key or Token is invalid.

403 Forbidden

The API key or Token does not have permissions to perform the request.

404 Not Found

The requested resource does not exist.

500 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request.

502 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request.

503 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance.

504 Gateway Timeout

The server did not receive a timely response from the upstream server.

Example 1

Example 1

GET /usecases/10123/scenario/10078/test/UC1.1SC10078LT_T1 HTTP/1.1 

token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IkFEU0YgVXNlciIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFEU0YiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQURTRnVzZXIiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiIxOSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL3N5c3RlbSI6IjEiLCJleHAiOjE2NTIxOTM2Mzl9.JC9wMvR0w_oWI-duR48zoDiJPU_y0cAkWbu-4F9585Y

HTTP/1.1 200 OK 

Content-Type: application/json

[
    {
        "composite_kpi": "LOCALISATION",
        "composite_kpi_value": 75.0,
        "status_pi": [
            {
                "description": "Longitudinal distance deviation between any 2 vehicles",
                "code": "ldd",
                "value": 3.00,
                "evaluation": "Good"
            },
            {
                "description": "Lateral distance between any 2 vehicles",
                "code": "ldb",
                "value": 1.20,
                "evaluation": "Acceptable"
            }
        ]
    },
    {
        "composite_kpi": "BANDWIDTH",
        "composite_kpi_value": 50.0,
        "status_pi": [
            {
                "description": "Minimum granted throughput",
                "code": "mgt",
                "value": 5.00,
                "evaluation": "Acceptable"
            }
        ]
    },
    {
        "composite_kpi": "CAPACITY",
        "composite_kpi_value": 50.0,
        "status_pi": [
            {
                "description": "Nb vehicles per cell per MHz",
                "code": "nbv",
                "value": 0.30,
                "evaluation": "Acceptable"
            }
        ]
    },
    {
        "composite_kpi": "RELIABILITY",
        "composite_kpi_value": 100.0,
        "status_pi": [
            {
                "description": "Packet loss intensity (packets per mil. packets)",
                "code": "pli",
                "value": 5.00,
                "evaluation": "Good"
            }
        ]
    },
    {
        "composite_kpi": "LATENCY",
        "composite_kpi_value": 75.0,
        "status_pi": [
            {
                "description": "Latency (ms) (Median - 50% percentile)",
                "code": "lat50",
                "value": 200.00,
                "evaluation": "Acceptable"
            },
            {
                "description": "Latency (ms) (95% percentile)",
                "code": "lat95",
                "value": 150.00,
                "evaluation": "Good"
            }
        ]
    }
]
show more
Update Experiment description
PUT /usecases/{id}/scenario/{test_scenario_id}/test/{test_unique_key}/update

Update a Experiment description.

Path variables

id
string Numerical Key required

The Use Case identifier.

Example:
10123
test_scenario_id
string Numerical Key required

The Test Scenario identifier.

Example:
10078
test_unique_key
string required

The Test unique key

Example:
UC1.1SC10078LT_T1

Request headers

token
string required

The authorization token required for API calls to ensure that the client is trusted.

Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IkFEU0YgVXNlciIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFEU0YiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQURTRnVzZXIiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiIxOSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL3N5c3RlbSI6IjEiLCJleHAiOjE2NTIxOTM2Mzl9.JC9wMvR0w_oWI-duR48zoDiJPU_y0cAkWbu-4F9585Y

Request body

Object
description
string

The Test Description

Responses

200 OK

The request has succeded.

Body
Object
test_unique_key
string "UC" & <use case code> & "SC" & <test scenario id> & <test scenario type (LT or FT)> & "T" & #

The Test unique key.

Example:
UC1.1SC10078LT_T1
400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter.

401 Unauthorized

The provided API Key or Token is invalid.

403 Forbidden

The API key or Token does not have permissions to perform the request.

404 Not Found

The requested resource does not exist.

500 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request.

502 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request.

503 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance.

504 Gateway Timeout

The server did not receive a timely response from the upstream server.

Example 1

Example 1

POST /usecases/10123/scenario/10078/test/start HTTP/1.1 

token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IkFEU0YgVXNlciIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFEU0YiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQURTRnVzZXIiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiIxOSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL3N5c3RlbSI6IjEiLCJleHAiOjE2NTIxOTM2Mzl9.JC9wMvR0w_oWI-duR48zoDiJPU_y0cAkWbu-4F9585Y

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "id": "UC1.1SC10078LT_T1"
}
show more
List Experiments
GET /usecases/{id}/scenario/{test_scenario_id}/test

Retreive Experiments of a Test Case.

Path variables

id
string Numerical Key required

The Test Scenario identifier.

Example:
10123
test_scenario_id
string Numerical Key required

The Test Scenario identifier.

Example:
10078

Request headers

token
string required

The authorization token required for API calls to ensure that the client is trusted.

Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IkFEU0YgVXNlciIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFEU0YiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQURTRnVzZXIiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiIxOSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL3N5c3RlbSI6IjEiLCJleHAiOjE2NTIxOTM2Mzl9.JC9wMvR0w_oWI-duR48zoDiJPU_y0cAkWbu-4F9585Y

Responses

200 OK

The request has succeded.

Body
Array
Object
test_unique_Key
string

The Test unique key.

Example:
UC1.1SC10078LT_T1
description
string

The Test description.

Example:
This is a test for single data transmission
400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter.

401 Unauthorized

The provided API Key or Token is invalid.

403 Forbidden

The API key or Token does not have permissions to perform the request.

404 Not Found

The requested resource does not exist.

500 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request.

502 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request.

503 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance.

504 Gateway Timeout

The server did not receive a timely response from the upstream server.

Example 1

Example 1

GET /usecases/10123/scenario/10078/test HTTP/1.1 

token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IkFEU0YgVXNlciIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFEU0YiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQURTRnVzZXIiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiIxOSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL3N5c3RlbSI6IjEiLCJleHAiOjE2NTIxOTM2Mzl9.JC9wMvR0w_oWI-duR48zoDiJPU_y0cAkWbu-4F9585Y

HTTP/1.1 200 OK 

Content-Type: application/json

[
    {
        "test_unique_Key": "UC1.1SC10078LT_T1",
        "description": "This is a test for single data transmission"
    }
]
show more
Experiment Data
Upload Experiment Data
POST /usecases/{id}/scenario/{test_scenario_id}/test/{test_unique_key}/test_result/upload
Upload Experiment Data (New)
POST /test/{test_unique_key}/test_result/upload
List Experiment Data
POST /usecases/{id}/scenario/{test_scenario_id}/test/{test_unique_key}/test_result
Delete Experiment Data
POST /usecases/{id}/scenario/{test_scenario_id}/test/{test_unique_key}/test_result/{test_result_id}/delete
Upload Experiment Data
POST /usecases/{id}/scenario/{test_scenario_id}/test/{test_unique_key}/test_result/upload

Upload Experiment Data for an Experiment.

Path variables

id
string Numerical Key required

The Use Case identifier.

Example:
10123
test_scenario_id
string Numerical Key required

The Test Scenario identifier.

Example:
10078
test_unique_key
string required

The Test unique key.

Example:
UC1.1SC10078LT_T1

Request headers

token
string required

The authorization token required for API calls to ensure that the client is trusted.

Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IkFEU0YgVXNlciIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFEU0YiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQURTRnVzZXIiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiIxOSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL3N5c3RlbSI6IjEiLCJleHAiOjE2NTIxOTM2Mzl9.JC9wMvR0w_oWI-duR48zoDiJPU_y0cAkWbu-4F9585Y

Request body

Object
test_result_name
string required

The Test Result name

Example:
Vehicle positioning
file
string file object required

File contents provided via multipart/form-data

Responses

200 OK

The request has succeded.

Body
Object
id
string

The file identifier.

Example:
a9a34a59-c12b-a03a-8c8c-96173db71a89
400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter.

401 Unauthorized

The provided API Key or Token is invalid.

403 Forbidden

The API key or Token does not have permissions to perform the request.

404 Not Found

The requested resource does not exist.

500 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request.

502 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request.

503 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance.

504 Gateway Timeout

The server did not receive a timely response from the upstream server.

Example 1

Example 1

POST /usecases/10123/scenario/10078/test/UC1.1SC10078LT_T1/test_result/upload HTTP/1.1 

token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IkFEU0YgVXNlciIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFEU0YiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQURTRnVzZXIiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiIxOSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL3N5c3RlbSI6IjEiLCJleHAiOjE2NTIxOTM2Mzl9.JC9wMvR0w_oWI-duR48zoDiJPU_y0cAkWbu-4F9585Y
Content-Type: application/json

{
    "resultName": "Vehicle positioning",
    "file": ""
}

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "id": "a9a34a59-c12b-a03a-8c8c-96173db71a89"
}
show more
Upload Experiment Data (New)
POST /test/{test_unique_key}/test_result/upload

Upload Experiment Data for an Experiment.

Path variables

test_unique_key
string required

The Test unique key.

Example:
UC1.1SC10078LT_T1

Request headers

token
string required

The authorization token required for API calls to ensure that the client is trusted.

Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IkFEU0YgVXNlciIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFEU0YiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQURTRnVzZXIiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiIxOSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL3N5c3RlbSI6IjEiLCJleHAiOjE2NTIxOTM2Mzl9.JC9wMvR0w_oWI-duR48zoDiJPU_y0cAkWbu-4F9585Y

Request body

Object
test_result_name
string required

The Test Result name

Example:
Vehicle positioning
file
string file object required

File contents provided via multipart/form-data

Responses

200 OK

The request has succeded.

Body
Object
id
string

The file identifier.

Example:
a9a34a59-c12b-a03a-8c8c-96173db71a89
400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter.

401 Unauthorized

The provided API Key or Token is invalid.

403 Forbidden

The API key or Token does not have permissions to perform the request.

404 Not Found

The requested resource does not exist.

500 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request.

502 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request.

503 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance.

504 Gateway Timeout

The server did not receive a timely response from the upstream server.

Example 1

Example 1

POST /usecases/10123/scenario/10078/test/UC1.1SC10078LT_T1/test_result/upload HTTP/1.1 

token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IkFEU0YgVXNlciIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFEU0YiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQURTRnVzZXIiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiIxOSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL3N5c3RlbSI6IjEiLCJleHAiOjE2NTIxOTM2Mzl9.JC9wMvR0w_oWI-duR48zoDiJPU_y0cAkWbu-4F9585Y
Content-Type: application/json

{
    "resultName": "Vehicle positioning",
    "file": ""
}

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "id": "a9a34a59-c12b-a03a-8c8c-96173db71a89"
}
show more
List Experiment Data
POST /usecases/{id}/scenario/{test_scenario_id}/test/{test_unique_key}/test_result

Retreive Experiment Datas for an Experiment.

Path variables

id
string Numerical Key required

The Use Case identifier.

Example:
10123
test_scenario_id
string Numerical Key required

The Test Scenario identifier.

Example:
10078
test_unique_key
string required

The Test identifier.

Example:
UC1.1SC10078LT_T1

Request headers

token
string required

The authorization token required for API calls to ensure that the client is trusted.

Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IkFEU0YgVXNlciIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFEU0YiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQURTRnVzZXIiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiIxOSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL3N5c3RlbSI6IjEiLCJleHAiOjE2NTIxOTM2Mzl9.JC9wMvR0w_oWI-duR48zoDiJPU_y0cAkWbu-4F9585Y

Responses

200 OK

The request has succeded.

Body
Array
Object
test_result_name
string

The Test Result name.

Example:
Initial Test
id
string

The Test Result identifier.

Example:
50074
mime
string

The Test Result file extension.

Example:
.csv
name
string

The Test Resukt file name.

Example:
myfile01.csv
url
string

The Test Result file URL

Example:
https://5groutes.ebostechnologies.com/_5groutes/Test-Result-Upload/myfile01.csv
400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter.

401 Unauthorized

The provided API Key or Token is invalid.

403 Forbidden

The API key or Token does not have permissions to perform the request.

404 Not Found

The requested resource does not exist.

500 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request.

502 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request.

503 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance.

504 Gateway Timeout

The server did not receive a timely response from the upstream server.

Example 1

Example 1

POST /usecases/10123/scenario/10078/test/UC1.1SC10078LT_T1/test_result HTTP/1.1 

token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IkFEU0YgVXNlciIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFEU0YiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQURTRnVzZXIiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiIxOSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL3N5c3RlbSI6IjEiLCJleHAiOjE2NTIxOTM2Mzl9.JC9wMvR0w_oWI-duR48zoDiJPU_y0cAkWbu-4F9585Y

HTTP/1.1 200 OK 

Content-Type: application/json

[
    {
        "test_result_name": "Initial Test",
        "id": "50074",
        "mimi": ".csv",
        "name": "myfile01.csv",
        "url": "https://5groutes.ebostechnologies.com/_5groutes/Test-Result-Upload/myfile01.csv"
    }
]
show more
Delete Experiment Data
POST /usecases/{id}/scenario/{test_scenario_id}/test/{test_unique_key}/test_result/{test_result_id}/delete

Dete Experiment Data.

Path variables

id
string Numerical Key required

The Use Case identifier.

Example:
10123
test_scenario_id
string Numerical Key required

The Test Scenario identifier.

Example:
10078
test_unique_key
string required

The Test unique key.

Example:
UC1.1SC10078LT_T1
test_result_id
string required

The Test Result identifier.

Example:
60076

Request headers

token
string required

The authorization token required for API calls to ensure that the client is trusted.

Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IkFEU0YgVXNlciIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFEU0YiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQURTRnVzZXIiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiIxOSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL3N5c3RlbSI6IjEiLCJleHAiOjE2NTIxOTM2Mzl9.JC9wMvR0w_oWI-duR48zoDiJPU_y0cAkWbu-4F9585Y

Responses

200 OK

The request has succeded.

400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter.

401 Unauthorized

The provided API Key or Token is invalid.

403 Forbidden

The API key or Token does not have permissions to perform the request.

404 Not Found

The requested resource does not exist.

500 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request.

502 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request.

503 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance.

504 Gateway Timeout

The server did not receive a timely response from the upstream server.

Example 1

Example 1

POST /usecases/10123/scenario/10078/test/UC1.1SC10078LT_T1/test_result/60076/delete HTTP/1.1 

token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IkFEU0YgVXNlciIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFEU0YiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQURTRnVzZXIiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiIxOSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL3N5c3RlbSI6IjEiLCJleHAiOjE2NTIxOTM2Mzl9.JC9wMvR0w_oWI-duR48zoDiJPU_y0cAkWbu-4F9585Y

HTTP/1.1 200 OK
show more
Responses
200 OK

The request has succeded.

400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter.

401 Unauthorized

The provided API Key or Token is invalid.

403 Forbidden

The API key or Token does not have permissions to perform the request.

404 Not Found

The requested resource does not exist.

500 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request.

502 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request.

503 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance.

504 Gateway Timeout

The server did not receive a timely response from the upstream server.

Headers
token
string required

The authorization token required for API calls to ensure that the client is trusted.

Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IkFEU0YgVXNlciIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFEU0YiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQURTRnVzZXIiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiIxOSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL3N5c3RlbSI6IjEiLCJleHAiOjE2NTIxOTM2Mzl9.JC9wMvR0w_oWI-duR48zoDiJPU_y0cAkWbu-4F9585Y