API docs by Redocly

Datalake API

Download OpenAPI specification:

API to interact with Datalake data

Authentication

Get a JWT token

Get tokens from app_id / app_secret.
Once you have the access_token, you can add it to the Authorization Header prefixed with the Bearer keyword to authenticate on protected endpoints: Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...

Request Body schema: application/json

Authentication parameters

app_id
string
app_secret
string
grant_type
string
Enum: "client_credentials" "refresh_token"

Responses

Request samples

Content type
application/json
{
  • "app_id": "string",
  • "app_secret": "string",
  • "grant_type": "client_credentials"
}

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "refresh_token": "string"
}

CloudConnect

OXO: Get Software Update status

Get the OXO Software Update status

Authorizations:
bearerAuth
query Parameters
cc_product_ids
string

A valid cc_product_id or a list of several cc_product_id separated with ;.

page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

OXO: Create or Update the software update status of each registered systems

Records an update request for the given OXO systems. The POST request body must contain a list of systems update status with all mandatory parameters as shown in the example body below.

Authorizations:
bearerAuth
Request Body schema: application/json

OXO Software Update status parameters

Array of objects

Responses

Request samples

Content type
application/json
{
  • "systems": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true
}

OXO: Get Software Update status (POST)

Get the OXO Software Update status

Authorizations:
bearerAuth
query Parameters
page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Request Body schema: application/json
required
cc_product_ids
Array of strings

Filter the OXO Software Update status for the given cc_product_ids.

Responses

Request samples

Content type
application/json
{
  • "cc_product_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

OXO: Get the software update status of each registered systems

Return OXO cloudconnected systems enriched with software update status. An optional parameter min_release gives the possibility to filter results according to the OXO release. An optional parameter cc_product_ids gives the possibility to filter results according to the cc_product_id.

Authorizations:
bearerAuth
query Parameters
min_release
string

Minimum OXO release to search for

cc_product_ids
string

A valid cc_product_id or a list of several cc_product_id separated with ;.

page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

OXO: Get collected GlobalData by ccproduct-id or fleet-ref

Get the OXO collected GlobalData over the last 7 days.
By default, return all items. An optional parameter ids separated by ; can be used to filter data.
The type of these ids must be one of ccproduct-id or fleet-ref.
A 404 Not Found error is returned if the given id_type is invalid.

Authorizations:
bearerAuth
path Parameters
id_type
required
string
Enum: "ccproduct-id" "fleet-ref"

The type of ids specified in the request

query Parameters
ids
string

(Optional) A list of valid ccproduct-id or fleet-ref separated by ;

page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

OXO: List collected GlobalData by ccproduct-id or fleet-ref

Get the OXO collected GlobalData over the last 7 days.
By default, return all items. An optional parameter ids can be used to filter data.
The type of these ids must be one of ccproduct-id or fleet-ref.
A 404 Not Found error is returned if the given id_type is invalid.

Authorizations:
bearerAuth
path Parameters
id_type
required
string
Enum: "ccproduct-id" "fleet-ref"
query Parameters
page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Request Body schema: application/json
required
ids
Array of strings

(Optional) A list of valid ccproduct-id or fleet-ref

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

OXO: Get FTR data by cpu-id or fleet-ref

Get the OXO FTR data.
By default, return all items. An optional parameter ids separated by ; can be used to filter data.
The type of these ids must be one of cpu-id or fleet-ref.
A 404 Not Found error is returned if the given id_type is invalid.

Authorizations:
bearerAuth
path Parameters
id_type
required
string
Enum: "cpu-id" "fleet-ref"

The type of ids specified in the request

query Parameters
ids
string

(Optional) A list of valid cpu-id or fleet-ref separated by ;

page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

OXO: Get All Collectable Systems

Get the cc_product_id of all the OXO systems that can be collected by the data collector.

Authorizations:
bearerAuth
query Parameters
page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

OXO: Get systems infos for given fleets

Get systems infos for the specified fleet_refs and subfleet_refs. Note that the subfleet_refs field is optional in which case the request will return infos for all systems associated to the fleet_refs regardless of the subfleet_refs.
The POST request body must contain a fleet_ref / subfleet_ref pair in a JSON object.
Additional filtering is possible by adding a filter JSON object in the request body. (see example below)
A 400 Bad Request error is returned if the fleet_ref / subfleet_ref pair is missing in the request body.

Authorizations:
bearerAuth
Request Body schema: application/json
required

OXO Fleets Systems Infos parameters

Array of objects
object (OxoSystemsInfosFilters)
page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Request samples

Content type
application/json
{
  • "refs": [
    ],
  • "filters": {
    },
  • "page": 1,
  • "page_count": 50
}

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

OXO: Get systems infos for given applicants

Get systems infos for the specified applicants.
The POST request body must contain a list of applicants in JSON array.
Additional filtering is possible by adding a filter JSON object in the request body. (see example below)
A 400 Bad Request error is returned if applicants are missing in the request body.

Authorizations:
bearerAuth
Request Body schema: application/json
required

OXO Applicants Systems Infos parameters

applicants
Array of integers
object (OxoSystemsInfosFilters)
page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Request samples

Content type
application/json
{
  • "applicants": [
    ],
  • "filters": {
    },
  • "page": 1,
  • "page_count": 50
}

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

OXO: Get systems infos for given ir delegated

Get systems infos for the specified ir_delegated.
The POST request body must contain a list of ir_delegated in JSON array.
Additional filtering is possible by adding a filter JSON object in the request body. (see example below)
A 400 Bad Request error is returned if ir_delegated are missing in the request body.

Authorizations:
bearerAuth
Request Body schema: application/json
required

OXO Applicants Systems Infos parameters

ir_delegated
Array of integers
object (OxoSystemsInfosFilters)
page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Request samples

Content type
application/json
{
  • "ir_delegated": [
    ],
  • "filters": {
    },
  • "page": 1,
  • "page_count": 50
}

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

OXO: Get Ccproductid by cpuid

Returns the cc_product_id_key_main value of an OXO system identified by the given cpu_id.
A 204 No Content status is returned if there is no cc_product_id_key_main for the specified cpu_id.
A 404 Not Found error is returned in case the given cpu_id is not found in the DataLake.

Authorizations:
bearerAuth
path Parameters
cpu_id
required
string

A valid CPU Id

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ]
}

OXO: Returns the ccproductid associated to a given fleet_ref/install_id pair.

Returns the cc_product_id_key_main associated with the specified fleet_ref and install_id pair.
A field walled_garden is returned alongside the ccproductid with boolean value true or false depending on the OXO system walled garden status.
A 204 No Content status is returned if there is no cc_product_id_key_main for the specified fleet_ref and install_id pair.
A 400 Bad Request error is returned in case of misuse of URL parameter.

Authorizations:
bearerAuth
path Parameters
fleet_ref
required
string

A valid OXO system 'fleet ref'

query Parameters
install_id
required
string

A valid OXO system 'install id'

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ]
}

OXE: Get Software Update status

Get the OXE Software Update status

Authorizations:
bearerAuth
query Parameters
cc_product_ids
string

A valid cc_product_id or a list of several cc_product_id separated with ;.

page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

OXE: Create or Update the software update status of each registred systems

Records an update request for the given OXE systems. The 'Software Update Status' of the systems identified by their cc_product_id are updated according to the given data.

Authorizations:
bearerAuth
Request Body schema: application/json

OXE Software Update status parameters

Array of objects

Responses

Request samples

Content type
application/json
{
  • "systems": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true
}

OXE: Get Software Update status (POST)

Get the OXE Software Update status

Authorizations:
bearerAuth
query Parameters
page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Request Body schema: application/json
required
cc_product_ids
Array of strings

Filter the OXE Software Update status for the given cc_product_ids.

Responses

Request samples

Content type
application/json
{
  • "cc_product_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

OXE: Get the software update status of each registered systems

Return OXE cloudconnected systems enriched with software update status.
An optional parameter cc_product_ids gives the possibility to filter results according to the cc_product_id.

Authorizations:
bearerAuth
query Parameters
cc_product_ids
string

A valid cc_product_id or a list of several cc_product_id separated with ;.

page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

OXE: Get systems infos for given fleets

Get systems infos for the specified fleet_refs and company_ids. The POST request body must contain a fleet_ref / company_id pair in a JSON object.
Additional filtering is possible by adding a filter JSON object in the request body. (see example below)
A 400 Bad Request error is returned if the fleet_ref / company_id pair is missing in the request body.

Authorizations:
bearerAuth
Request Body schema: application/json
required

OXE Fleets Systems Infos parameters

Array of objects
object (OxeSystemsInfosFilters)
page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Request samples

Content type
application/json
{
  • "refs": [
    ],
  • "filters": {
    },
  • "page": 1,
  • "page_count": 50
}

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

OXE: Get systems infos for given applicants

Get systems infos for the specified applicants.
The POST request body must contain a list of applicants in JSON array.
Additional filtering is possible by adding a filter JSON object in the request body. (see example below)
A 400 Bad Request error is returned if applicants are missing in the request body.

Authorizations:
bearerAuth
Request Body schema: application/json
required

OXE Applicants Systems Infos parameters

applicants
Array of integers
object (OxeSystemsInfosFilters)
page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Request samples

Content type
application/json
{
  • "applicants": [
    ],
  • "filters": {
    },
  • "page": 1,
  • "page_count": 50
}

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

OXE: Get systems infos for given ir delegated

Get systems infos for the specified ir_delegated.
The POST request body must contain a list of ir_delegated in JSON array.
Additional filtering is possible by adding a filter JSON object in the request body. (see example below)
A 400 Bad Request error is returned if ir_delegated are missing in the request body.

Authorizations:
bearerAuth
Request Body schema: application/json
required

OXE Applicants Systems Infos parameters

ir_delegated
Array of integers
object (OxeSystemsInfosFilters)
page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Request samples

Content type
application/json
{
  • "ir_delegated": [
    ],
  • "filters": {
    },
  • "page": 1,
  • "page_count": 50
}

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

Get BP Custom Data by cpu-id

By default, return all the BP Custom Data.
Optional parameter allow a facility to get BP Custom Data for specidied cpuids separated by ;.

Authorizations:
bearerAuth
query Parameters
cpuids
string

(Optional) A list of valid cpuids separated by ;

page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

Create BP Custom Data

Create Business Partner custom data for the given cpu_ids.
A 400 Bad Request error is returned in case of malformed JSON body.

Authorizations:
bearerAuth
Request Body schema: application/json
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "custom_data": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true
}

Update BP Custom Data

Update Business Partner custom data for the given cpu_ids.
A 400 Bad Request error is returned in case of malformed JSON body.

Authorizations:
bearerAuth
Request Body schema: application/json
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "custom_data": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true
}

Delete BP Custom Data

Delete Business Partner custom data for the given cpu_ids.
A 204 No Content status is returned if BP Custom Data has been successfully deleted for the given cpu_ids.
A 400 Bad Request error is returned in case of malformed JSON body.

Authorizations:
bearerAuth
query Parameters
cpu_ids
required
string

A list of valid cpuids separated by ;

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "string"
}

OXE: Get RTR data

By default, return all the data available on the RTR server
Optional ccproductids parameter allow a facility to get RTR data only for the specified ccproductids separated by ;.

Authorizations:
bearerAuth
query Parameters
ccproductids
string

(Optional) A list of valid ccproductids separated by ;

page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

OXE: List RTR data

By default, return all the data available on the RTR server
Optional ccproductids parameter allow a facility to get RTR data only for the specified ccproductids separated by ;.

Authorizations:
bearerAuth
query Parameters
ccproductids
string

(Optional) A list of valid ccproductids separated by ;

page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

OXE: Get RTR Notification Data

By default, return all the RTR Notification data.
Optional ccproductids parameter allow a facility to get RTR Notification data only for the specified ccproductids separated by ;.

Authorizations:
bearerAuth
query Parameters
page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Request Body schema: application/json
required
ccproductids
Array of strings

(Optional) A list of valid ccproductids

Responses

Request samples

Content type
application/json
{
  • "ccproductids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

OXE: Create RTR Notification Data

Create RTR Notification Data for the given cc_product_ids.
The request body must contain a list with values to update.
A 400 Bad Request error is returned in case of malformed JSON body.

Authorizations:
bearerAuth
Request Body schema: application/json
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "rtr_notif": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true
}

OXE: Update RTR Notification Data

Update RTR Notification Data for the given cc_product_ids.
The request body must contain a list with values to update.
A 400 Bad Request error is returned in case of malformed JSON body.

Authorizations:
bearerAuth
Request Body schema: application/json
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "rtr_notif": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true
}

OXE: Delete RTR Notification Data

Delete RTR Notification Data for the given cc_product_ids.
A 204 No Content status is returned if the RTR Notification Data has been successfully deleted.
A 400 Bad Request status is returned in case the cc_product_ids parameter is not specified.

Authorizations:
bearerAuth
query Parameters
cc_product_ids
required
string

A list of valid cc_product_ids separated by ;

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "string"
}

OXE: Get RTR Notification Data (POST)

By default, return all the RTR Notification data.
Optional ccproductids parameter allow a facility to get RTR Notification data only for the specified ccproductids.

Authorizations:
bearerAuth
query Parameters
page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Request Body schema: application/json
required
ccproductids
Array of strings

(Optional) A list of valid ccproductids

Responses

Request samples

Content type
application/json
{
  • "ccproductids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

Get BP Applicant email by applicant number

By default, return all the BP Applicants Notification emails.
Optional parameter allow a facility to get BP Applicant Notification email for the specified applicant_number.

Authorizations:
bearerAuth
query Parameters
applicant_number
string

(Optional) The applicant_number for which to get applicant email

page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

Add BP Applicant email

Add BP Applicant Notification email for the specified applicant_number / notification_email pairs. The request body must contain a list of applicant_number / notification_email pairs to create.
A 400 Bad Request error is returned in case of malformed JSON body.

Authorizations:
bearerAuth
Request Body schema: application/json
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "applicant_notif": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true
}

Update BP Applicant email

Update BP Applicant Notification email for the specified applicant_number / notification_email pairs.
The request body must contain a list of applicant_number / notification_email pairs to update.
A 400 Bad Request error is returned in case of malformed JSON body.

Authorizations:
bearerAuth
Request Body schema: application/json
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "applicant_notif": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true
}

Get BP Company email by company id

By default, return all the BP Company Notification emails.
Optional parameter allow a facility to get BP Company Notification email for the specified company_id.

Authorizations:
bearerAuth
query Parameters
company_id
string

(Optional) The company's ID for which to get BP company email

page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

Add BP Company email

Add BP Company Notification email for the given company_ids / notification_email pairs.
The request body must contain a list of company_ids / notification_email pairs to create. A 400 Bad Request error is returned in case of malformed JSON body.

Authorizations:
bearerAuth
Request Body schema: application/json
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "bp_notif": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true
}

Update BP Company email

Update BP Company Notification email for the given company_ids / notification_email pairs. The request body must contain list of company_ids / notification_email pairs to update. A 400 Bad Request error is returned in case of malformed JSON body.

Authorizations:
bearerAuth
Request Body schema: application/json
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "bp_notif": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true
}

OXE: Get FleetRefs

Get all fleet_ref(s) for the specified company_id.
A 404 Not Found error is returned either if the given company_id is not found in the DataLake.

Authorizations:
bearerAuth
path Parameters
company_id
string

A valid company Id

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

OXE: Create FleetRef

Create a fleet_ref for the specified company_id.
The POST request body must contain fleet_ref and description in a JSON object.
A 404 Not Found error is returned if the specified company_id is not found in the DataLake.
A 400 Bad Request error is returned if the fleet_ref is missing in the request body.
The uniqueness of the wanted fleet_ref for the specified company_id is checked and a 409 Conflict error is returned if the specified fleet_ref already exists for this company.

Authorizations:
bearerAuth
path Parameters
company_id
string

A valid company Id

Request Body schema: application/json
required
fleet_ref
string
description
string

Responses

Request samples

Content type
application/json
{
  • "fleet_ref": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "success": true
}

OXE: Update FleetRef

Update OXE fleet refs for the given company_id and fleet_ref.
The request body must contain fleet_ref and description in a JSON object.
A 404 Not Found error is returned if the specified company_id is not found in the DataLake.
A 404 Not Found error is returned if the specified fleet_ref is not found for the given company_id.
A 400 Bad Request error is returned if the fleet_ref is missing in the request body.
The uniqueness of the wanted fleet_ref for the specified company_id is checked and a 409 Conflict error is returned if the specified fleet_ref already exists for this company.

Authorizations:
bearerAuth
path Parameters
company_id
string

A valid company Id

fleet_ref
string

A valid fleet_ref

Request Body schema: application/json
required
fleet_ref
string
description
string

Responses

Request samples

Content type
application/json
{
  • "fleet_ref": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "success": true
}

OXE: Delete FleetRefs

Delete the FleetRef specified by the company_id and fleet_ref pair.
Note: all associations if any between OXE systems and the specified FleetRef are automatically removed.
A 204 No Content status is returned if the specified fleet_ref has been successfully deleted.
A 404 Not Found error is returned if the specified company_id is not found in the DataLake.
A 404 Not Found error is returned if the specified fleet_ref is not found in the DataLake for the given company_id.

Authorizations:
bearerAuth
path Parameters
company_id
string

A valid company Id

fleet_ref
string

A valid fleet_ref

Responses

Response samples

Content type
application/json
{
  • "message": "Unauthorized"
}

OXE: Get Associated Systems

Get all the OXE systems associated to the given fleet_ref.
A 404 Not Found error is returned if the specified company_id/code> is not found in the DataLake.
A 404 Not Found error is returned if the specified fleet_ref doesn't exist for the given company_id.

Authorizations:
bearerAuth
path Parameters
company_id
string

A valid company Id

fleet_ref
string

A valid company Id

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

OXE: Associate systems to FleetRefs

Associate a fleet_ref of the given company_id to OXE systems defined by their system ids (internal_id_of_the_system).
The POST request body must contain a JSON object with the system Ids of the OXE systems that must be associated to the given fleet_ref.
A 404 Not Found error is returned if either the specified company_id is not found in the DataLake or if the specified fleet_ref doesn't exist for the given company_id.
A 400 Bad Request error is returned either if one of the specified system ids is not found in the DataLake or if no internal_id_of_the_system is specified in the POST request body.

Authorizations:
bearerAuth
path Parameters
company_id
string

A valid company Id

fleet_ref
string

A valid fleet_ref

Request Body schema: application/json
required
internal_id_of_the_system
Array of arrays

Responses

Request samples

Content type
application/json
{
  • "internal_id_of_the_system": [ ]
}

Response samples

Content type
application/json
{
  • "success": true
}

OXE: Delete FleetRef/Systems Associations

Delete all the Fleet-Ref/Systems associations for the given system_ids.
A 204 No Content status is returned if the Fleet-Ref/Systems associations have been successfully deleted.
A 400 Bad Request status is returned in case the system_ids parameter is not specified.

Authorizations:
bearerAuth
query Parameters
system_ids
Array of arrays

A valid system_id or a list of system_ids separated by ;

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "string"
}

OXE: Get FleetRef Associations by systemids

Get all the OXE FleetRef Associations.
Can be filtered for the given systemids separated by ;.
A 400 Bad Request status is returned in case the systemids parameter is not specified.

Authorizations:
bearerAuth
query Parameters
systemids
Array of arrays

(Optional) A list of valid system-id separated by ;

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

OXE: Get FleetRef of IR company

Returns the fleet_ref and company_id associated with the specified IR company (ir_company_id).
A 404 Not Found error is returned if the specified IR company does not exit in the DataLake.

Authorizations:
bearerAuth
path Parameters
ir_company_id
string

A valid IR company Id

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

OXE: FleetRef IR Association

Associate a given IR Company Id to the specified fleet_ref of the specified company.
A 404 Not Found error is returned if:
.. the specified IR company does not exit in the DataLake or
.. the specified company does not exit in the DataLake or
.. the specified fleet_ref does not exist for the specified company

Authorizations:
bearerAuth
path Parameters
company_id
string

A valid company Id

fleet_ref
string

A valid fleet_ref

ir_company_id
string

A valid IR company ID

Request Body schema: application/json
required
internal_id_of_the_system
Array of arrays

Responses

Request samples

Content type
application/json
{
  • "internal_id_of_the_system": [ ]
}

Response samples

Content type
application/json
{
  • "success": true
}

OXE: Delete FleetRef/IR company association

Delete association between the specified ir_company_id and the FleetRef specified by the fleet_ref and company_id pair.
A 204 No Content status is returned if the specified association has been successfully deleted.
A 404 Not Found error is returned if:
.. the specified IR company does not exit in the DataLake or
.. the specified company does not exit in the DataLake or
.. the specified fleet_ref does not exist for the specified company

Authorizations:
bearerAuth
path Parameters
company_id
string

A valid company Id

fleet_ref
string

A valid fleet_ref

ir_company_id
string

A valid IR company ID

Responses

Response samples

Content type
application/json
{
  • "message": "Unauthorized"
}

OXE: Get Services by FleetRefs

Get all services for the specified fleet_refs.
The POST request body must contain a list of fleet_refs in a JSON array.
A 400 Bad Request error is returned if fleet_refs are missing in the request body.

Authorizations:
bearerAuth
Request Body schema: application/json
required
Array of objects
page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Request samples

Content type
application/json
{
  • "refs": [
    ],
  • "page": 1,
  • "page_count": 50
}

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

OXE: Get Services by Applicant

Get all services for the specified applicants. The POST request body must contain a list of applicants in a JSON array.
A 400 Bad Request error is returned if applicants are missing in the request body.

Authorizations:
bearerAuth
Request Body schema: application/json
required
applicants
Array of strings
page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Request samples

Content type
application/json
{
  • "applicants": [
    ],
  • "page": 1,
  • "page_count": 50
}

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

OXE: Get Services by ir delegated

Get all services for the specified ir_delegated.
The POST request body must contain a list of ir_delegated in a JSON array.
A 400 Bad Request error is returned if ir_delegated are missing in the request body.

Authorizations:
bearerAuth
Request Body schema: application/json
required
ir_delegated
Array of strings
page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Request samples

Content type
application/json
{
  • "ir_delegated": [
    ],
  • "page": 1,
  • "page_count": 50
}

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

OXE: Get Services

Get all services.
The request can filter items by system_ids, applicants, ir_delegated or refs.

Authorizations:
bearerAuth
query Parameters
page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Request Body schema: application/json
optional
Any of
system_ids
Array of strings

Responses

Request samples

Content type
application/json
{
  • "refs": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

OXE: Get Cpuid by ccproductid

Returns the cpuid value of an OXE system identified by the given ccproductid.
A 404 Not Found status is returned in case the given ccproductid is not found in the DataLake.

Authorizations:
bearerAuth
path Parameters
cc_product_id
string

A valid CC Product Id

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ]
}

OXE: Get Collected Site Data

Get the OXE Collected Site Data over the last 2 months.
Items can be filtered by ccproductids separated by ;

Authorizations:
bearerAuth
query Parameters
ccproductids
string

A list of valid ccproduct-id separated by ;

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ]
}

OXE: List Collected Site Data

Get the OXE Collected Site Data over the last 2 months.
Items can be filtered by ccproductids

Authorizations:
bearerAuth
query Parameters
page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Request Body schema: application/json
required
ccproductids
Array of strings

A list of valid ccproduct-id

Responses

Request samples

Content type
application/json
{
  • "ccproductids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ]
}

OXE: Get Collected Rainbow Status

Get the OXE Collected Rainbow Status data over the last 2 months.
Can be filtered for the given ccproductids separated by ;

Authorizations:
bearerAuth
query Parameters
ccproductids
string

A list of valid ccproduct-id separated by ;

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ]
}

OXE: List Collected Rainbow Status

Get the OXE Collected Rainbow Status data over the last 2 months.
Can be filtered for the given ccproductids.

Authorizations:
bearerAuth
query Parameters
page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Request Body schema: application/json
required
ccproductids
Array of strings

A list of valid ccproduct-id

Responses

Request samples

Content type
application/json
{
  • "ccproductids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ]
}

OXE: Get last incident date

Get the OXE last incident date. Can be filtered for the given ccproductids separated by ;.

Authorizations:
bearerAuth
query Parameters
ccproductids
string

A list of valid ccproduct-id separated by ;

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ]
}

OXE: List last incident date

Get the OXE last incident date. Can be filtered for the given ccproductids.

Authorizations:
bearerAuth
query Parameters
page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Request Body schema: application/json
required
ccproductids
Array of strings

A list of valid ccproduct-id

Responses

Request samples

Content type
application/json
{
  • "ccproductids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ]
}

OXE: Get Incidents by ProductId

Returns the 100 last incidents (if any) occurred in the last 24 hours of an OXE system identified by the given product_id.

Authorizations:
bearerAuth
path Parameters
product_id
string

A valid ccproduct-id

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ]
}

OXE: Get Terminals by Category

Get all Terminals corresponding to the given category. Can be filtered for the given ccproductids separated by ;.

Authorizations:
bearerAuth
path Parameters
category
string
Enum: "term" "dect" "ip-phone"

The category of terminals to return

query Parameters
ccproductids
string

A list of valid ccproduct-id separated by ;

page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

OXE: Get Terminals by Category

Get all Terminals corresponding to the given category. Can be filtered for the given ccproductids separated by ;.

Authorizations:
bearerAuth
path Parameters
category
string
Enum: "term" "dect" "ip-phone"

The category of terminals to return

query Parameters
page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Request Body schema: application/json
required
ccproductids
Array of strings

A list of valid ccproduct-id

Responses

Request samples

Content type
application/json
{
  • "ccproductids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

OXE: Get Ccproductid by cpuid

Returns the cc_product_id_key_main value of an OXE system identified by the given cpu_id.
A 204 No Content status is returned if there is no cc_product_id_key_main for the specified cpu_id.
A 404 Not Found error is returned in case the given cpu_id is not found in the DataLake.

Authorizations:
bearerAuth
path Parameters
cpu_id
required
string

A valid CPU ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ]
}

OXO: Get FleetRefs

Get all fleet_ref(s) for the specified company_id.
A 404 Not Found error is returned either if the given company_id is not found in the DataLake.

Authorizations:
bearerAuth
path Parameters
company_id
string

A valid company Id

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

OXO: Create FleetRef

Create a fleet_ref for the specified company_id.
The POST request body must contain fleet_ref and description in a JSON object.
A 404 Not Found error is returned if the specified company_id is not found in the DataLake.
A 400 Bad Request error is returned if the fleet_ref is missing in the request body.
The uniqueness of the wanted fleet_ref for the specified company_id is checked and a 409 Conflict error is returned if the specified fleet_ref already exists for this company.

Authorizations:
bearerAuth
path Parameters
company_id
string

A valid company Id

Request Body schema: application/json
required
fleet_ref
string
description
string

Responses

Request samples

Content type
application/json
{
  • "fleet_ref": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "success": true
}

OXO: Update FleetRef

Update OXO fleet refs for the given company_id and fleet_ref.
The request body must contain fleet_ref and description in a JSON object.
A 404 Not Found error is returned if the specified company_id is not found in the DataLake.
A 404 Not Found error is returned if the specified fleet_ref is not found for the given company_id.
A 400 Bad Request error is returned if the fleet_ref is missing in the request body.
The uniqueness of the wanted fleet_ref for the specified company_id is checked and a 409 Conflict error is returned if the specified fleet_ref already exists for this company.

Authorizations:
bearerAuth
path Parameters
company_id
string

A valid company Id

fleet_ref
string

A valid fleet_ref

Request Body schema: application/json
required
fleet_ref
string
description
string

Responses

Request samples

Content type
application/json
{
  • "fleet_ref": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "success": true
}

OXO: Delete FleetRefs

Delete the FleetRef specified by the company_id and fleet_ref pair.
Note: all associations if any between OXO systems and the specified FleetRef are automatically removed.
A 204 No Content status is returned if the specified fleet_ref has been successfully deleted.
A 404 Not Found error is returned if the specified company_id is not found in the DataLake.
A 404 Not Found error is returned if the specified fleet_ref is not found in the DataLake for the given company_id.

Authorizations:
bearerAuth
path Parameters
company_id
string

A valid company Id

fleet_ref
string

A valid fleet_ref

Responses

Response samples

Content type
application/json
{
  • "message": "Unauthorized"
}

OXO: Get FleetRefs & SubfleetRefs

Get all fleet_ref(s) and subfleet_ref(s) for the specified company_id (note that fleet_refs and subfleet_refs linked together may not belong to the same company). A 404 Not Found error is returned either if there is neither fleet_ref nor subfleet_ref for the given company_id or if the given company_id is not found in the DataLake.

Authorizations:
bearerAuth
path Parameters
company_id
string

A valid company Id

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

OXO: Create SubfleetRref

Create a subfleet_ref for the specified fleet_ref.
The specified company_id identifies the BP creating the subfleet_ref and is stored alongside the subfleet_ref for filtering purposes.
The POST request body must contain subfleet_ref and description in a JSON object.
A 404 Not Found error is returned if either the specified fleet_ref or the company_id are not found in the DataLake.
A 400 Bad Request error is returned if the subfleet_ref is missing in the request body.
The uniqueness of the wanted subfleet_ref for the given fleet_ref is checked and a 409 Conflict error is returned if the specified subfleet_ref already exists.

Authorizations:
bearerAuth
path Parameters
company_id
string

A valid company Id

fleet_ref
string

A valid fleet_ref

Request Body schema: application/json
required
subfleet_ref
string
description
string

Responses

Request samples

Content type
application/json
{
  • "subfleet_ref": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "success": true
}

OXO: Update SubfleetRef

Update OXO subfleet refs for the given company_id, fleet_ref and subfleet_ref.
The request body must contain fleet_ref and description in a JSON object.
A 404 Not Found error is returned if the specified company_id is not found in the DataLake.
A 404 Not Found error is returned if the specified subfleet_ref is not found for the given fleet_ref and the given company_id.
A 400 Bad Request error is returned if the fleet_ref is missing in the request body.
The uniqueness of the wanted subfleet_ref is checked and a '409 Conflict' error is returned if the specified subfleet_ref already exists.

Authorizations:
bearerAuth
path Parameters
company_id
string

A valid company Id

fleet_ref
string

A valid fleet_ref

subfleet_ref
string

A valid subfleet_ref

Request Body schema: application/json
required
subfleet_ref
string
description
string

Responses

Request samples

Content type
application/json
{
  • "subfleet_ref": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "success": true
}

OXO: Delete SubfleetRefs

Delete the SubFleetRef specified by the company_id, fleet_ref and subfleet_ref triplet.
A 204 No Content status is returned if the specified subfleet_ref has been successfully deleted.
A 404 Not found status is returned if the company_id is not found in the DataLake.
A 404 Not found status is returned if the subfleet_ref is not found in the DataLake for the specified fleet_ref and company.

Authorizations:
bearerAuth
path Parameters
company_id
string

A valid company Id

fleet_ref
string

A valid fleet_ref

subfleet_ref
string

A valid subfleet_ref

Responses

Response samples

Content type
application/json
{
  • "message": "Unauthorized"
}

OXO: Get Cpuid by ccproductid

Returns the cpuid value of an OXO system identified by the given ccproductid.
A 404 Not Found status is returned in case the given ccproductid is not found in the DataLake.

Authorizations:
bearerAuth
path Parameters
cc_product_id
string

A valid CC Product Id

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ]
}

OXO: Get last incident date

Get the OXO last incident date. Can be filtered for the given ccproductids separated by ;.

Authorizations:
bearerAuth
query Parameters
ccproductids
string

A list of valid ccproduct-id separated by ;

page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "pagination": {
    },
  • "results": [
    ]
}

OXO: List last incident date

Get the OXO last incident date. Can be filtered for the given ccproductids.

Authorizations:
bearerAuth
query Parameters
page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Request Body schema: application/json
required
ccproductids
Array of strings

A list of valid ccproduct-id

Responses

Request samples

Content type
application/json
{
  • "ccproductids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "pagination": {
    },
  • "results": [
    ]
}

OXO: Get systems last collection

Get the OXO last collection date. Can be filtered for the given ccproductids separated by ;.

Authorizations:
bearerAuth
query Parameters
ccproductids
string

A list of valid ccproduct-id separated by ;

page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "pagination": {
    },
  • "results": [
    ]
}

OXO: List systems last collection

Get the OXO last collection date. Can be filtered for the given ccproductids.

Authorizations:
bearerAuth
query Parameters
page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Request Body schema: application/json
required
ccproductids
Array of strings

A list of valid ccproduct-id

Responses

Request samples

Content type
application/json
{
  • "ccproductids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "pagination": {
    },
  • "results": [
    ]
}

OXO: Get Trunks

Get trunks of the OXO systems. Can be filtered for the given cc_product_ids separated by ;.

Authorizations:
bearerAuth
query Parameters
cc_product_ids
string

A valid cc_product_id or a list of several cc_product_id separated with ;.

page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "pagination": {
    },
  • "results": [
    ]
}

OXO: List Trunks

Get trunks of the OXO systems. Can be filtered for the given cc_product_ids.

Authorizations:
bearerAuth
query Parameters
page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Request Body schema: application/json
required
cc_product_ids
Array of strings

A list of valid ccproduct-id

Responses

Request samples

Content type
application/json
{
  • "cc_product_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "pagination": {
    },
  • "results": [
    ]
}

OXO: Get Boards

Get boards of the OXO systems. Can be filtered for the given cc_product_ids separated by ;.

Authorizations:
bearerAuth
query Parameters
cc_product_ids
string

A valid cc_product_id or a list of several cc_product_id separated with ;.

page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "pagination": {
    },
  • "results": [
    ]
}

OXO: List Boards

Get boards of the OXO systems. Can be filtered for the given cc_product_ids.

Authorizations:
bearerAuth
query Parameters
page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Request Body schema: application/json
required
cc_product_ids
Array of strings

A list of valid ccproduct-id

Responses

Request samples

Content type
application/json
{
  • "cc_product_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "pagination": {
    },
  • "results": [
    ]
}

OXO: Get Terminals

Get terminals of the OXO systems. Can be filtered for the given cc_product_ids separated by ;.

Authorizations:
bearerAuth
query Parameters
cc_product_ids
string

A valid cc_product_id or a list of several cc_product_id separated with ;.

page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "pagination": {
    },
  • "results": [
    ]
}

OXO: List Terminals

Get terminals of the OXO systems. Can be filtered for the given cc_product_ids.

Authorizations:
bearerAuth
query Parameters
page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Request Body schema: application/json
required
cc_product_ids
Array of strings

A list of valid ccproduct-id

Responses

Request samples

Content type
application/json
{
  • "cc_product_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "pagination": {
    },
  • "results": [
    ]
}

OXO: Get Terminals Details

Get terminals details of the OXO systems. Can be filtered for the given cc_product_ids separated by ;.

Authorizations:
bearerAuth
query Parameters
cc_product_ids
string

A valid cc_product_id or a list of several cc_product_id separated with ;.

page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "pagination": {
    },
  • "results": [
    ]
}

OXO: List Terminals Details

Get terminals details of the OXO systems. Can be filtered for the given cc_product_ids.

Authorizations:
bearerAuth
query Parameters
page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Request Body schema: application/json
required
cc_product_ids
Array of strings

A list of valid ccproduct-id

Responses

Request samples

Content type
application/json
{
  • "cc_product_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "pagination": {
    },
  • "results": [
    ]
}

OXO: Get Licenses

Get licenses of OXO systems. Can be filtered for the given cc_product_ids separated by ;.

Authorizations:
bearerAuth
query Parameters
cc_product_ids
string

A valid cc_product_id or a list of several cc_product_id separated with ;.

page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

OXO: List Licenses

Get licenses of OXO systems. Can be filtered for the given cc_product_ids.

Authorizations:
bearerAuth
query Parameters
page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Request Body schema: application/json
required
cc_product_ids
Array of strings

A list of valid ccproduct-id

Responses

Request samples

Content type
application/json
{
  • "cc_product_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

OXE: Get Licenses

Get licenses of OXE systems. Can be filtered for the given cc_product_ids separated by ;.

Authorizations:
bearerAuth
query Parameters
cc_product_ids
string

A valid cc_product_id or a list of several cc_product_id separated with ;.

page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

OXE: List Licenses

Get licenses of OXE systems. Can be filtered for the given cc_product_ids.

Authorizations:
bearerAuth
query Parameters
page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Request Body schema: application/json
required
cc_product_ids
Array of strings

A list of valid ccproduct-id

Responses

Request samples

Content type
application/json
{
  • "cc_product_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "pagination": {
    },
  • "results": [
    ]
}

OXE: Get Trunks

Get trunks of OXE systems. Can be filtered for the given cc_product_ids separated by ;.

Authorizations:
bearerAuth
query Parameters
cc_product_ids
string

A valid cc_product_id or a list of several cc_product_id separated with ;.

page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "pagination": {
    },
  • "results": [
    ]
}

OXE: List Trunks

Get trunks of OXE systems. Can be filtered for the given cc_product_ids.

Authorizations:
bearerAuth
query Parameters
page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Request Body schema: application/json
required
cc_product_ids
Array of strings

A list of valid ccproduct-id

Responses

Request samples

Content type
application/json
{
  • "cc_product_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "pagination": {
    },
  • "results": [
    ]
}

OXE: Get SIP Gateways

Get SIP Gateways of OXE systems. Can be filtered for the given cc_product_ids separated by ;.

Authorizations:
bearerAuth
query Parameters
cc_product_ids
string

A valid cc_product_id or a list of several cc_product_id separated with ;.

page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "pagination": {
    },
  • "results": [
    ]
}

OXE: List SIP Gateways

Get SIP Gateways of OXE systems. Can be filtered for the given cc_product_ids.

Authorizations:
bearerAuth
query Parameters
page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Request Body schema: application/json
required
cc_product_ids
Array of strings

A list of valid ccproduct-id

Responses

Request samples

Content type
application/json
{
  • "cc_product_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "pagination": {
    },
  • "results": [
    ]
}

OXE: Get Boards

Get boards of OXE systems. Can be filtered for the given cc_product_ids separated by ;.

Authorizations:
bearerAuth
query Parameters
cc_product_ids
string

A valid cc_product_id or a list of several cc_product_id separated with ;.

page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "pagination": {
    },
  • "results": [
    ]
}

OXE: List Boards

Get boards of OXE systems. Can be filtered for the given cc_product_ids.

Authorizations:
bearerAuth
query Parameters
page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Request Body schema: application/json
required
cc_product_ids
Array of strings

A list of valid ccproduct-id

Responses

Request samples

Content type
application/json
{
  • "cc_product_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "pagination": {
    },
  • "results": [
    ]
}

OXE: Get Racks

Get racls of OXE systems. Can be filtered for the given cc_product_ids separated by ;.

Authorizations:
bearerAuth
query Parameters
cc_product_ids
string

A valid cc_product_id or a list of several cc_product_id separated with ;.

page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "pagination": {
    },
  • "results": [
    ]
}

OXE: List Racks

Get racks of OXE systems. Can be filtered for the given cc_product_ids.

Authorizations:
bearerAuth
query Parameters
page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Request Body schema: application/json
required
cc_product_ids
Array of strings

A list of valid ccproduct-id

Responses

Request samples

Content type
application/json
{
  • "cc_product_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "pagination": {
    },
  • "results": [
    ]
}

OXE: Get Terminals by ccproductids

Get terminals for the specified ccProductIds

Authorizations:
bearerAuth
query Parameters
cc_product_ids
string

A valid cc_product_id or a list of several cc_product_id separated with ;.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ]
}

OXE: List Terminals by ccproductids

Get terminals for the specified ccProductIds.

Authorizations:
bearerAuth
Request Body schema: application/json
required
cc_product_ids
Array of strings

A list of valid ccproduct-id

Responses

Request samples

Content type
application/json
{
  • "cc_product_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ]
}

Get Data Collector Analytics

Returns CloudConnect Data Collector Analytics over a 4-week time span. Can be filtered for the given ccproduct_ids.

Authorizations:
bearerAuth
query Parameters
ccproduct_ids
string

A valid cc_product_id or a list of several cc_product_id separated with ;.

page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "pagination": {
    },
  • "results": [
    ]
}

List Data Collector Analytics

Returns CloudConnect Data Collector Analytics over a 4-week time span. Can be filtered for the given ccproduct_ids.

Authorizations:
bearerAuth
query Parameters
page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Request Body schema: application/json
required
ccproduct_ids
Array of strings

A list of valid ccproduct-id

Responses

Request samples

Content type
application/json
{
  • "ccproduct_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "pagination": {
    },
  • "results": [
    ]
}

Get IR Delegation Status

Get IR Delegation Status. Can be filtered for the given cc_product_ids separated by ;.

Authorizations:
bearerAuth
query Parameters
ccproduct_ids
string

A valid cc_product_id or a list of several cc_product_id separated with ;.

page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "pagination": {
    },
  • "results": [
    ]
}

List IR Delegation Status

Get IR Delegation Status. Can be filtered for the given cc_product_ids.

Authorizations:
bearerAuth
query Parameters
page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Request Body schema: application/json
required
cc_product_ids
Array of strings

A list of valid ccproduct-id

Responses

Request samples

Content type
application/json
{
  • "cc_product_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "pagination": {
    },
  • "results": [
    ]
}

Get Systems Inventory Status

Returns the inventory status of the OXE or OXO systems.
It can be filtered with cc_product_id separated with ;

Authorizations:
bearerAuth
query Parameters
cc_product_ids
string

A valid cc_product_id or a list of several cc_product_id separated with ;.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "pagination": {
    },
  • "results": [
    ]
}

List Systems Inventory Status

Returns the inventory status of the OXE or OXO systems.
It can be filtered with cc_product_id.

Authorizations:
bearerAuth
Request Body schema: application/json
required
cc_product_ids
Array of strings

A list of valid ccproduct-id

Responses

Request samples

Content type
application/json
{
  • "cc_product_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "pagination": {
    },
  • "results": [
    ]
}

Get Ftr product by cc_product_ids, activation_date or product_type

Return Ftr product data Parameter allow a facility to get Ftr Product Data

Authorizations:
bearerAuth
query Parameters
cc_product_ids
string

A list of valid cc_product_ids separated by ;

activation_date
string

A valid activation_date format : YYYY-MM-DD

product_type
integer

A valid product_type_id (OXO=1, OXE=3)

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

Get FleetDashboard Feature History

Return the history of the feature specified by feature_name for the given company_id over the last 6 months.
A 404 Not Found status is returned if the specified company_id is not found in the DataLake.

Authorizations:
bearerAuth
path Parameters
company_id
string

A valid company id

feature_name
string

The name of the feature (as it is journalized by the FleetDashboard) to get the history for

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "pagination": {
    },
  • "results": [
    ]
}

CommonData

OXE: Get systems infos by cpu_id or for specified applicants or companies

Get systems infos matching the specified filters.
Systems can be filtered by cpu_id, applicant or company.
The POST request body must contain a list of cpus , applicants or companies.
A 400 Bad Request error is returned if the request isn't formatted correctly.

Authorizations:
bearerAuth
Request Body schema: application/json
required

OXE Systems Infos filters

applicants
Array of strings
companies
Array of integers
cpus
Array of strings
page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Request samples

Content type
application/json
{
  • "applicants": [
    ],
  • "companies": [
    ],
  • "cpus": [
    ],
  • "page": 1,
  • "page_count": 50
}

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

OXO: Get systems infos by cpu_id or for specified applicants or companies

Get systems infos matching the specified filters.
Systems can be filtered by cpu_id, applicant or company.
The POST request body must contain a list of cpus , applicants or companies.
A 400 Bad Request error is returned if the request isn't formatted correctly.

Authorizations:
bearerAuth
Request Body schema: application/json
required

OXO Systems Infos filters

applicants
Array of strings
companies
Array of integers
cpus
Array of strings
page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Request samples

Content type
application/json
{
  • "applicants": [
    ],
  • "companies": [
    ],
  • "cpus": [
    ],
  • "page": 1,
  • "page_count": 50
}

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

Get Applicants by applicants ids

Return all applicants for a given list of applicants_ids.

Authorizations:
bearerAuth
query Parameters
applicants_ids
string

A valid list of applicant_id separated by ;

page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

Get Applicants by Company

Return all applicants for a given company_id.
To get all existing applicants (irrespective of companies) simply specify all in the URL parameter instead of a company_id.
A 404 Not Found error is returned if the specified company_id does not exit in the Datalake.

Authorizations:
bearerAuth
path Parameters
company_id
string

A valid company Id
(specify all to get all applicants irrespective of companies)

query Parameters
is_archived
boolean

Whether we query for active or inactive applicants. If not specified, returns both (archived and active)

page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

Get Indirect Resellers by Company

Return all IR for a given VAD company_id.
A 404 Not Found error is returned if the specified company_id does not exit in the Datalake.

Authorizations:
bearerAuth
path Parameters
company_id
string

A valid company Id

query Parameters
is_archived
boolean

Whether we query for active or inactive companies

page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

Get Contact Infos by contact_id

Return contact infos for a given contact_id.
A 404 Not Found error is returned if the specified contact_id does not exit in the Datalake.

Authorizations:
bearerAuth
path Parameters
contact_id
string

A valid contact_id

query Parameters
page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

Get products catalog by product type

Get products catalog infos matching the specified product type.
Products can be filtered by product_type: "BD_OTHER", "Cloud Communications BD", "Communications", "IID", "Network", "Non ESD", "Undefined BD" A 400 Bad Request error is returned if the request isn't formatted correctly.

Authorizations:
bearerAuth
path Parameters
product_type
string

A valid product_type

query Parameters
page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

Get Companies by Type or Ids

Return all companies for a given company_id, company_type or company_ids list, with a default is_archived and include_archived set to False. A 404 Not Found error is returned if the specified company_type or company_id does not exit in the Datalake.

Authorizations:
bearerAuth
query Parameters
company_type
string

A valid company type

company_id
string

A valid company id

company_ids
string

A valid list of company id separated by ;

is_archived
boolean

Whether we query for active or inactive companies

include_archived
boolean

Whether we query for all active and inactive companies

page
integer (PageParam) >= 1
Default: 1

The number of items to skip before starting to collect the result set.

page_count
integer (PageCountParam) [ 1 .. 3000 ]
Default: 50

The number of items to return.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

Get Orders by Part Number and/or Applicant IDs

Return all orders filtered by part_number and/or applicant_ids, where their order_date is contained within a start_period and an end_period. At least one of part_numbers or applicant_ids must be provided. Start period and end period are mandatory and must be in ISO format (YYYY-MM-DD). Difference between 'start_period' and 'end_period' can't exceed 31 days.

Authorizations:
bearerAuth
Request Body schema: application/json
required
part_numbers
Array of arrays

Optional list of part numbers to filter by. At least one of part_numbers or applicant_ids must be provided.

start_period
string

Start date for filtering orders in ISO format (YYYY-MM-DD)

end_period
string

End date for filtering orders in ISO format (YYYY-MM-DD)

applicant_ids
Array of strings

Optional list of applicant IDs to filter by. At least one of part_numbers or applicant_ids must be provided.

Responses

Request samples

Content type
application/json
{
  • "part_numbers": [ ],
  • "start_period": "string",
  • "end_period": "string",
  • "applicant_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

Get Materials by Subscription and Applicant numbers, or by System ID

Return all materials for a given list of system_id or a single pair of subscription_number and applicant_number

Authorizations:
bearerAuth
Request Body schema: application/json
required
system_id
Array of arrays
subscription_number
string
applicant_number
string

Responses

Request samples

Content type
application/json
{
  • "system_id": [ ],
  • "subscription_number": "string",
  • "applicant_number": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ],
  • "pagination": {
    }
}

Get Hardware Support Serial Number Trail by Filters

Returns the hardware support serial number trail based on the provided filters. You must provide either: - A date range (creation_date_from and creation_date_to) - An order ID and order line combination - A HWS swap status Additional filters can be applied to narrow down the results.

Authorizations:
bearerAuth
Request Body schema: application/json
required
creation_date_from
string <date>

Start date for the search range (YYYY-MM-DD)

creation_date_to
string <date>

End date for the search range (YYYY-MM-DD)

order_id
string

Order ID to filter by

order_line
string

Order line to filter by

hws_swap_status
string

Hardware support swap status to filter by

status
Array of strings

Status(es) to filter by

sold_to
Array of strings

Sold to applicant ID(s) to filter by

business_partner
Array of strings

Business partner ID(s) to filter by

support_partner
Array of strings

Support partner ID(s) to filter by

end_customer_id
Array of strings

End customer ID(s) to filter by

bundle_reference
Array of strings

Bundle reference(s) to filter by

serial_number
Array of strings

Serial number(s) to filter by

only_hws_in
boolean
Default: false

If true, only returns records with non-empty serial_number_hws_in

Responses

Request samples

Content type
application/json
{
  • "creation_date_from": "2019-08-24",
  • "creation_date_to": "2019-08-24",
  • "order_id": "string",
  • "order_line": "string",
  • "hws_swap_status": "string",
  • "status": [
    ],
  • "sold_to": [
    ],
  • "business_partner": [
    ],
  • "support_partner": [
    ],
  • "end_customer_id": [
    ],
  • "bundle_reference": [
    ],
  • "serial_number": [
    ],
  • "only_hws_in": false
}

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ]
}

Get End Customers Company Info

Return end customer company info data for a given sfdc_id_18. A 404 Not Found error is returned if the specified sfdc_id_18 does not exist in the Datalake.

Authorizations:
bearerAuth
query Parameters
sfdc_id_18
required
string

Salesforce 18-character ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "results": [
    ]
}

Get serial number 360 view

This endpoint allows clients to retrieve and verify detailed information about an asset using its serial number.

Authorizations:
bearerAuth
query Parameters
serial_number
required
string
Example: serial_number=XYZ12345

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "results": { }
}

Utils

Get version

Get the current API version

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "version": "string"
}