Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

1NCE Device Inspector API

Inspect details of the devices

1NCE Device Inspector API is one of 22 APIs that 1NCE publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Device Inspector. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.

This API exposes 7 operations across 7 paths, and defines 17 schemas. It is described by OpenAPI 3.0.1, at version v2.1.1.

Requests are made against a single base URL, https://api.1nce.com/management-api.

7 operations 7 paths 17 schemas 7 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
v2.1.1
Server
https://api.1nce.com/management-api
Authentication
HTTP Basic
Contact
Resource Areas
1

Authentication & Security 1

1NCE Device Inspector API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuthentication).

  • BasicAuthentication — Basic authentication used for obtaining the Bearer Authentication Token. The Bearer Token can then be used to make any further API calls towards the 1NCE API.

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 7 GET. Each is listed below with its method, path, parameters, and response codes.

Device Inspector 7

Inspect details of the devices

GET
/v1/inspect/devices
Get All Devices
4 params → 200400401403500
GET
/v1/inspect/devices/{deviceId}
Get Single Device
1 param → 200401403404500
GET
/v1/inspect/devices/{deviceId}/telemetry
Get Device Telemetry
2 params → 200400401403500
GET
/v1/inspect/devices/{deviceId}/history
Get Device Historian Messages
6 params → 200400401403500
GET
/v1/inspect/devices/history
Get Historian Messages
7 params → 200400401403500
GET
/v1/inspect/devices/{deviceId}/history/insights
Get Device Historian Insights
5 params → 200400401403500
GET
/v1/inspect/devices/history/insights
Get Historian Insights
6 params → 200400401403500

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are getResponseschema_6_items_inner (6 properties), getResponseschema_4 (5 properties), getAllResponseschema_3_items_inner (5 properties), getAllResponseschema_2_items_inner (4 properties). Each schema is shown below with its type and property counts.

getResponseschema_7_items_inner
object
3 properties 3 required
getResponseschema_6
object
Get all device messages from the historian.
3 properties 1 required
getAllResponseschema_2_items_inner
object
4 properties 4 required
getAllResponseschema_3_items_inner
object
5 properties 5 required
unauthorizedRequestResponse
object
An API error response in case of an HTTP Unauthorized Request.
3 properties
notFoundResponse
object
An API error response when a resource is Not Found.
3 properties
getResponseschema_7
object
Get the devices history insights for a specific time range.
2 properties 2 required
getResponseschema_5
object
Get a device shadow state (telemetry data).
2 properties 2 required
getAllResponseschema_4
object
Get the history insights for a specific time range.
2 properties 2 required
getAllResponseschema_4_items_inner
object
3 properties 3 required
serverErrorResponse
object
An API error response in case of a Server Side Error.
2 properties
getAllResponseschema_2
object
Get all devices as a list.
3 properties 3 required
getResponseschema_4
object
Get a single device metadata.
5 properties 4 required
getResponseschema_6_items_inner
object
6 properties 5 required
badRequestResponse
object
An API error response in case of an HTTP Bad Request.
3 properties
forbiddenResponse
object
An API error response in case of an HTTP Forbidden Request.
3 properties
getAllResponseschema_3
object
Get all messages from the historian.
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

1nce-device-inspector-api-openapi.yml Raw ↑

Other APIs 1NCE publishes across the network.

1NCE Administration Logs API
1NCE Agreements API
1NCE Bearer Authorization API
1NCE Connectivity API
1NCE Device Locator API
1NCE Devices API
1NCE General SIMs API
1NCE IoT Integrator API
1NCE Optimizer API
1NCE Orders API
1NCE Plugin system API
1NCE Products API