",
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/postschema_3"
}
}
},
"description": "The Body for posting new UDP action to device.",
"required": true
},
"responses": {
"202": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/postResponseschema"
}
}
},
"description": "Message describing the result of operation"
},
"400": {
"$ref": "#/components/responses/BadRequestError"
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"404": {
"$ref": "#/components/responses/NotFoundError"
},
"409": {
"$ref": "#/components/responses/ConflictError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Create Action Request On Specific UDP Device.",
"tags": [
"IoT Integrator"
]
}
},
"/v1/integrate/devices/actions/UDP": {
"post": {
"description": "Initiate UDP action on devices.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/bulkPostschema_2"
}
}
},
"description": "The Body for posting new UDP action to the devices.",
"required": true
},
"responses": {
"202": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/bulkPostResponseschema"
}
}
},
"description": "Message describing the result of operation"
},
"400": {
"$ref": "#/components/responses/BadRequestError"
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Create Action Requests for UDP Devices.",
"tags": [
"IoT Integrator"
]
}
},
"/v1/optimize/messages/test": {
"post": {
"description": "Test a template with a sample input message.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/postschema_4"
}
}
},
"description": "The Body of the template tester post request."
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/postResponseschema_1"
}
}
},
"description": "OK"
},
"400": {
"$ref": "#/components/responses/BadRequestError"
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Test template",
"tags": [
"Optimizer"
]
}
},
"/v1/optimize/savings": {
"get": {
"description": "Get statistics about the savings by using the optimizer.",
"parameters": [
{
"description": "Specify the range in days to receive data about.",
"explode": true,
"in": "query",
"name": "range",
"required": false,
"schema": {
"default": "1",
"enum": [
"1",
"7",
"30"
],
"example": "1",
"type": "string"
},
"style": "form"
},
{
"description": "Filter out by specific protocols: ",
"explode": true,
"in": "query",
"name": "protocol",
"required": false,
"schema": {
"enum": [
"UDP",
"COAP"
],
"example": "COAP",
"type": "string"
},
"style": "form"
},
{
"description": "ICCID of a SIM device, used to identifiy each 1NCE SIM.",
"explode": true,
"in": "query",
"name": "iccid",
"required": false,
"schema": {
"example": "8988280666000000000",
"type": "string"
},
"style": "form"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getResponseschema_3"
}
}
},
"description": "OK"
},
"400": {
"$ref": "#/components/responses/BadRequestError"
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Get savings",
"tags": [
"Optimizer"
]
}
},
"/v1/agreements/1nceos": {
"post": {
"description": "Post request to accept the 1NCE OS Terms of Use and Data Processing agreements. Please note that with this request the agreements can only be accepted.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/postAgreementsRequestschema"
}
}
},
"description": "The Body of the agreements post contains the accept flag as JSON."
},
"responses": {
"201": {
"description": "Created"
},
"400": {
"$ref": "#/components/responses/BadRequestError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Accept 1NCE OS Agreements",
"tags": [
"Agreements"
]
}
},
"/v1/integrate/clouds/aws/parameters": {
"get": {
"description": "Get the URLs to download/rollout the customer CloudFormation stack templates.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getCloudFormationParameters"
}
}
},
"description": "OK"
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Get CloudFormation Parameters",
"tags": [
"IoT Integrator"
]
}
},
"/v1/integrate/clouds/aws/{integrationId}/restart": {
"post": {
"description": "Restart AWS integration by forwarding test message to the integration.",
"parameters": [
{
"description": "unique integration ID",
"explode": false,
"in": "path",
"name": "integrationId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/postResponseschema_2"
}
}
},
"description": "OK"
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"404": {
"$ref": "#/components/responses/NotFoundError"
},
"409": {
"$ref": "#/components/responses/ConflictError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Restart AWS Integration",
"tags": [
"IoT Integrator"
]
}
},
"/v1/integrate/clouds/aws/{integrationId}/test": {
"post": {
"description": "Test AWS integration by forwarding test message to the integration.",
"parameters": [
{
"description": "unique integration ID",
"explode": false,
"in": "path",
"name": "integrationId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/postResponseschema_3"
}
}
},
"description": "OK"
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"404": {
"$ref": "#/components/responses/NotFoundError"
},
"409": {
"$ref": "#/components/responses/ConflictError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Test AWS Integration",
"tags": [
"IoT Integrator"
]
}
},
"/v1/administrationLogs": {
"get": {
"description": "Get a list of the administration logs regarding the organization.",
"parameters": [
{
"description": "Number of the requested page. Use this parameter to iterate through all items on the different pages. The total amount of pages is listed in the response body (pageAmount).",
"explode": true,
"in": "query",
"name": "page",
"required": false,
"schema": {
"default": 1,
"maximum": 50,
"minimum": 1,
"type": "integer"
},
"style": "form"
},
{
"description": "Parameter for specifying the queried items per page.",
"explode": true,
"in": "query",
"name": "pageSize",
"required": false,
"schema": {
"default": 10,
"example": 10,
"minimum": 1,
"type": "integer"
},
"style": "form"
},
{
"description": "Filter parameter in {filter}:{value} format. Expects comma separated list of filtering criteria out of the following fields: - geofenceId
- category
- iccid
- type
- startDateTime (UTC)
- endDateTime (UTC)
Example: \"type:device,iccid:ICCID,startDateTime:2022-11-14T16:04:38.000Z\"
",
"explode": true,
"in": "query",
"name": "q",
"required": false,
"schema": {
"example": "type:device,iccid:;startDateTime:",
"type": "string"
},
"style": "form"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getAdministrationLogsResponseschema"
}
}
},
"description": "OK"
},
"400": {
"$ref": "#/components/responses/BadRequestError"
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Get Administration Logs",
"tags": [
"Administration Logs"
]
}
},
"/v1/administrationLogs/stats": {
"get": {
"description": "Get the administration logs statistics for the current organization.",
"parameters": [
{
"description": "Specify the needed timezone as string parameter (e.g., Europe/Amsterdam) for the resulting query output.",
"explode": true,
"in": "query",
"name": "timezone",
"required": true,
"schema": {
"default": "Europe/Amsterdam",
"example": "Europe/Amsterdam",
"type": "string"
},
"style": "form"
},
{
"description": "Specify the category as string parameter for the resulting query output.",
"explode": true,
"in": "query",
"name": "category",
"required": false,
"schema": {
"enum": [
"info",
"error"
],
"example": "info",
"type": "string"
},
"style": "form"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getAdministrationLogsStatisticsResponseschema"
}
}
},
"description": "OK"
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Get Administration Logs Statistics",
"tags": [
"Administration Logs"
]
}
},
"/v1/administrationLogs/{adminLogId}/payload": {
"get": {
"description": "Get a URL pointing to a single administration log payload. The received URL will trigger a download.",
"parameters": [
{
"description": "Unique Id of the administration log for which the payload should be queried.",
"explode": false,
"in": "path",
"name": "adminLogId",
"required": true,
"schema": {
"example": "",
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"content": {
"text/x-uri": {
"schema": {
"description": "URL to the payload of the requested administration log.",
"example": "",
"type": "string"
}
}
},
"description": "OK"
},
"400": {
"$ref": "#/components/responses/BadRequestError"
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Get Administration Log Payload",
"tags": [
"Administration Logs"
]
}
},
"/v1/optimize/templates": {
"get": {
"description": "Get all Translation Service Templates for the current organization.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getTranslationTemplatesResponseschema"
}
}
},
"description": "OK"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Get Optimizer Templates",
"tags": [
"Optimizer"
]
},
"post": {
"description": "Create a new Translation Service Template.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/createTranslationTemplateRequestschema"
}
}
},
"description": "The Body for the creation of a new Optimizer Template needs to contain the name, template in JSON format and protocol filter.",
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/postPatchTranslationTemplatesResponseschema"
}
}
},
"description": "Created"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"409": {
"$ref": "#/components/responses/ConflictError"
},
"422": {
"$ref": "#/components/responses/UnprocessableEntityError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Create Optimizer Template",
"tags": [
"Optimizer"
]
}
},
"/v1/optimize/templates/{templateId}": {
"delete": {
"description": "Delete a specific Optimizer Template.",
"parameters": [
{
"description": "Unique Id of the Optimizer Template which should be deleted.",
"explode": false,
"in": "path",
"name": "templateId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"204": {
"description": "No Content"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"404": {
"$ref": "#/components/responses/NotFoundError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Delete Optimizer Template",
"tags": [
"Optimizer"
]
},
"patch": {
"description": "Update a specific Optimizer Template.",
"parameters": [
{
"description": "Unique Id of the Optimizer Template for which the update should be applied.",
"explode": false,
"in": "path",
"name": "templateId",
"required": true,
"schema": {
"example": "",
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/patchTranslationTemplateRequestschema"
}
}
},
"description": "The Body of the update contains the name, template in JSON format and the protocol filter parameter.",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/postPatchTranslationTemplatesResponseschema"
}
}
},
"description": "OK"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"404": {
"$ref": "#/components/responses/NotFoundError"
},
"409": {
"$ref": "#/components/responses/ConflictError"
},
"422": {
"$ref": "#/components/responses/UnprocessableEntityError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Update Optimizer Template",
"tags": [
"Optimizer"
]
}
},
"/v1/inspect/devices": {
"get": {
"description": "Get a list of all the Customer SIMs/Devices for the current organisation in the 1NCE OS.",
"parameters": [
{
"description": "Number of the requested devices page. Use this parameter to iterate through all devices on the different pages. The total amount of pages is listed in the response body (pageAmount).",
"explode": true,
"in": "query",
"name": "page",
"required": false,
"schema": {
"default": 1,
"example": 1,
"maximum": 50,
"minimum": 1,
"type": "integer"
},
"style": "form"
},
{
"description": "Parameter for specifying the queried items per page.",
"explode": true,
"in": "query",
"name": "pageSize",
"required": false,
"schema": {
"default": 10,
"example": 10,
"maximum": 50,
"minimum": 1,
"type": "integer"
},
"style": "form"
},
{
"description": "Sort values based on keys that are listed as a comma seperated list, prepend \"-\" for descending order.",
"explode": true,
"in": "query",
"name": "sort",
"required": false,
"schema": {
"example": "iccid,-ip",
"type": "string"
},
"style": "form"
},
{
"description": "Filter parameter in {filter}:{value} format. Comma separated list of filtering criteria out of the following fields: Example: \"iccid:8988280666000000000\"
",
"explode": true,
"in": "query",
"name": "q",
"required": false,
"schema": {
"example": "iccid:8988280666000000000",
"type": "string"
},
"style": "form"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getAllResponseschema_2"
}
}
},
"description": "OK"
},
"400": {
"$ref": "#/components/responses/BadRequestError"
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Get All Devices",
"tags": [
"Device Inspector"
]
}
},
"/v1/inspect/devices/{deviceId}": {
"get": {
"description": "Get detailed metadata from one specific Device.",
"parameters": [
{
"description": "The unique device ID which identifies each 1NCE SIM. Can be obtained from the Get All Devices API query. For 1NCE SIMS the device ID is equal to its iccid.",
"explode": false,
"in": "path",
"name": "deviceId",
"required": true,
"schema": {
"example": "",
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getResponseschema_4"
}
}
},
"description": "OK"
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"404": {
"$ref": "#/components/responses/NotFoundError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Get Single Device",
"tags": [
"Device Inspector"
]
}
},
"/v1/devices/{deviceId}/actions": {
"post": {
"description": "Initiate LwM2M action like read, write, execute on specific device. It has to be connected to 1NCE LwM2M endpoint to invoke this event.",
"parameters": [
{
"description": "The unique device ID which identifies each 1NCE SIM. Can be obtained from the Get All Devices API query. For 1NCE SIMS the device ID is equal to its iccid.",
"explode": false,
"in": "path",
"name": "deviceId",
"required": true,
"schema": {
"example": "",
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/postschema_1"
}
}
},
"description": "The Body for posting new LWM2M action to device.",
"required": true
},
"responses": {
"202": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/postResponseschema"
}
}
},
"description": "Message describing the result of operation"
},
"400": {
"$ref": "#/components/responses/BadRequestError"
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"404": {
"$ref": "#/components/responses/NotFoundError"
},
"409": {
"$ref": "#/components/responses/ConflictError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Create Action Request On Specific LwM2M Device.",
"tags": [
"Devices"
]
}
},
"/v1/inspect/devices/{deviceId}/telemetry": {
"get": {
"description": "Get the current/last repored Shadow State (telemetry) Data for a specific Device.",
"parameters": [
{
"description": "The unique device ID which identifies each 1NCE SIM. Can be obtained from the Get All Devices API query. For 1NCE SIMS the device ID is equal to its iccid.",
"explode": false,
"in": "path",
"name": "deviceId",
"required": true,
"schema": {
"example": "",
"type": "string"
},
"style": "simple"
},
{
"description": "Filter out shadow state data for specific protocol: ",
"explode": true,
"in": "query",
"name": "protocol",
"required": false,
"schema": {
"example": "COAP",
"type": "string"
},
"style": "form"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getResponseschema_5"
}
}
},
"description": "OK"
},
"400": {
"$ref": "#/components/responses/BadRequestError"
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Get Device Telemetry",
"tags": [
"Device Inspector"
]
}
},
"/v1/inspect/devices/{deviceId}/history": {
"get": {
"description": "Get historic message data for a specific SIM device.",
"parameters": [
{
"description": "The unique device ID which identifies each 1NCE SIM. Can be obtained from the Get All Devices API query. For 1NCE SIMS the device ID is equal to its iccid.",
"explode": false,
"in": "path",
"name": "deviceId",
"required": true,
"schema": {
"example": "",
"type": "string"
},
"style": "simple"
},
{
"description": "Timestamp from where onwards the historic data messages should be queried.",
"explode": true,
"in": "query",
"name": "startDateTime",
"required": false,
"schema": {
"example": "2022-03-07T08:51:29.015Z",
"type": "string"
},
"style": "form"
},
{
"description": "Timestamp until when the historic data messages should be queried.",
"explode": true,
"in": "query",
"name": "endDateTime",
"required": false,
"schema": {
"example": "2022-03-07T09:51:29.015Z",
"type": "string"
},
"style": "form"
},
{
"description": "Parameter for specifying the queried items per page.",
"explode": true,
"in": "query",
"name": "pageSize",
"required": false,
"schema": {
"default": 10,
"example": 10,
"minimum": 1,
"type": "integer"
},
"style": "form"
},
{
"description": "Filter out data for specific protocols: ",
"explode": true,
"in": "query",
"name": "protocol",
"required": false,
"schema": {
"example": "COAP",
"type": "string"
},
"style": "form"
},
{
"description": "This API query uses token-based pagination. Each queried page will include a nextToken for accessing the next page for pagination. Please use the returned token in the nextToken query parameters to obtain the next page.",
"explode": true,
"in": "query",
"name": "nextToken",
"required": false,
"schema": {
"example": "",
"type": "string"
},
"style": "form"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getResponseschema_6"
}
}
},
"description": "OK"
},
"400": {
"$ref": "#/components/responses/BadRequestError"
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Get Device Historian Messages",
"tags": [
"Device Inspector"
]
}
},
"/v1/inspect/devices/history": {
"get": {
"description": "Get a list of historic messages for devices based on the optional filter parameters.",
"parameters": [
{
"description": "The unique device ID which identifies each 1NCE SIM. Can be obtained from the Get All Devices API query. For 1NCE SIMS the device ID is equal to its iccid.",
"explode": true,
"in": "query",
"name": "deviceId",
"required": false,
"schema": {
"example": "",
"type": "string"
},
"style": "form"
},
{
"description": "ICCID of a SIM device, used to identifiy each 1NCE SIM.",
"explode": true,
"in": "query",
"name": "iccid",
"required": false,
"schema": {
"example": "8988280666000000000",
"type": "string"
},
"style": "form"
},
{
"description": "Timestamp from where onwards the historic data messages should be queried.",
"explode": true,
"in": "query",
"name": "startDateTime",
"required": false,
"schema": {
"example": "2022-03-07T08:51:29.015Z",
"type": "string"
},
"style": "form"
},
{
"description": "Timestamp until when the historic data messages should be queried.",
"explode": true,
"in": "query",
"name": "endDateTime",
"required": false,
"schema": {
"example": "2022-03-07T09:51:29.015Z",
"type": "string"
},
"style": "form"
},
{
"description": "Parameter for specifying the queried items per page.",
"explode": true,
"in": "query",
"name": "pageSize",
"required": false,
"schema": {
"default": 10,
"example": 10,
"minimum": 1,
"type": "integer"
},
"style": "form"
},
{
"description": "Filter out data for specific protocols: ",
"explode": true,
"in": "query",
"name": "protocol",
"required": false,
"schema": {
"example": "COAP",
"type": "string"
},
"style": "form"
},
{
"description": "This API query uses token-based pagination. Each queried page will include a nextToken for accessing the next page for pagination. Please use the returned token in the nextToken query parameters to obtain the next page.",
"explode": true,
"in": "query",
"name": "nextToken",
"required": false,
"schema": {
"example": "",
"type": "string"
},
"style": "form"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getAllResponseschema_3"
}
}
},
"description": "OK"
},
"400": {
"$ref": "#/components/responses/BadRequestError"
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Get Historian Messages",
"tags": [
"Device Inspector"
]
}
},
"/v1/inspect/devices/{deviceId}/history/insights": {
"get": {
"description": "Get insights of a unique SIM device for the Historian.",
"parameters": [
{
"description": "The unique device ID which identifies each 1NCE SIM. Can be obtained from the Get All Devices API query. For 1NCE SIMS the device ID is equal to its iccid.",
"explode": false,
"in": "path",
"name": "deviceId",
"required": true,
"schema": {
"example": "",
"type": "string"
},
"style": "simple"
},
{
"description": "Timestamp from where onwards the historic data messages should be queried.",
"explode": true,
"in": "query",
"name": "startDateTime",
"required": false,
"schema": {
"example": "2022-03-07T08:51:29.015Z",
"type": "string"
},
"style": "form"
},
{
"description": "Timestamp until when the historic data messages should be queried.",
"explode": true,
"in": "query",
"name": "endDateTime",
"required": false,
"schema": {
"example": "2022-03-07T09:51:29.015Z",
"type": "string"
},
"style": "form"
},
{
"description": "Filter out data for specific protocols: ",
"explode": true,
"in": "query",
"name": "protocol",
"required": false,
"schema": {
"example": "COAP",
"type": "string"
},
"style": "form"
},
{
"description": "The interval for which grouping of statistics should occur.",
"explode": true,
"in": "query",
"name": "interval",
"required": false,
"schema": {
"example": "1d",
"type": "string"
},
"style": "form"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getResponseschema_7"
}
}
},
"description": "OK"
},
"400": {
"$ref": "#/components/responses/BadRequestError"
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Get Device Historian Insights",
"tags": [
"Device Inspector"
]
}
},
"/v1/inspect/devices/history/insights": {
"get": {
"description": "Get insights for all devices from the Historian based on the optional filters.",
"parameters": [
{
"description": "The unique device ID which identifies each 1NCE SIM. Can be obtained from the Get All Devices API query. For 1NCE SIMS the device ID is equal to its iccid.",
"explode": true,
"in": "query",
"name": "deviceId",
"required": false,
"schema": {
"example": "",
"type": "string"
},
"style": "form"
},
{
"description": "ICCID of a SIM device, used to identifiy each 1NCE SIM.",
"explode": true,
"in": "query",
"name": "iccid",
"required": false,
"schema": {
"example": "8988280666000000000",
"type": "string"
},
"style": "form"
},
{
"description": "Timestamp from where onwards the historic data messages should be queried.",
"explode": true,
"in": "query",
"name": "startDateTime",
"required": false,
"schema": {
"example": "2022-03-07T08:51:29.015Z",
"type": "string"
},
"style": "form"
},
{
"description": "Timestamp until when the historic data messages should be queried.",
"explode": true,
"in": "query",
"name": "endDateTime",
"required": false,
"schema": {
"example": "2022-03-07T09:51:29.015Z",
"type": "string"
},
"style": "form"
},
{
"description": "Filter out data for specific protocols: ",
"explode": true,
"in": "query",
"name": "protocol",
"required": false,
"schema": {
"example": "COAP",
"type": "string"
},
"style": "form"
},
{
"description": "The interval for which grouping of statistics should occur.",
"explode": true,
"in": "query",
"name": "interval",
"required": false,
"schema": {
"example": "1d",
"type": "string"
},
"style": "form"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getAllResponseschema_4"
}
}
},
"description": "OK"
},
"400": {
"$ref": "#/components/responses/BadRequestError"
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Get Historian Insights",
"tags": [
"Device Inspector"
]
}
},
"/v1/locate/devices/{deviceId}/positions": {
"get": {
"description": "Get positions of a specific device (maximum of last 7 days).\n [OpenCelliD Project](https://opencellid.org/) is licensed under a [Creative Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/)\n",
"parameters": [
{
"description": "The unique device ID which identifies each 1NCE SIM. Can be obtained from the Get All Devices API query. For 1NCE SIMS the device ID is equal to its iccid.",
"explode": false,
"in": "path",
"name": "deviceId",
"required": true,
"schema": {
"example": "",
"type": "string"
},
"style": "simple"
},
{
"description": "Number of the requested page. Use this parameter to iterate through all items on the different pages. The total amount of pages is listed in the response body (pageAmount).",
"explode": true,
"in": "query",
"name": "page",
"required": false,
"schema": {
"default": 1,
"maximum": 50,
"minimum": 1,
"type": "integer"
},
"style": "form"
},
{
"description": "Comma seperated list of device property keys in order. Prefix key with `-` to sort descending.",
"explode": false,
"in": "query",
"name": "sort",
"required": false,
"schema": {
"items": {
"default": "-sampleTime",
"type": "string"
},
"type": "array"
},
"style": "form"
},
{
"description": "Source of the position.",
"explode": true,
"in": "query",
"name": "source",
"required": false,
"schema": {
"enum": [
"GPS",
"CellTower"
],
"type": "string"
},
"style": "form"
},
{
"explode": true,
"in": "query",
"name": "startDateTime",
"required": false,
"schema": {
"example": "2022-01-01T01:01:01.000Z",
"type": "string"
},
"style": "form"
},
{
"explode": true,
"in": "query",
"name": "endDateTime",
"required": false,
"schema": {
"example": "2022-01-01T01:01:02Z",
"type": "string"
},
"style": "form"
},
{
"description": "Parameter for specifying the queried items per page.",
"explode": true,
"in": "query",
"name": "pageSize",
"required": false,
"schema": {
"default": 100,
"example": 10,
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"style": "form"
},
{
"description": "Use ALL for a paginated list of all positions and SUMMARY to get the first, last and some positions inbetween.",
"explode": true,
"in": "query",
"name": "mode",
"required": false,
"schema": {
"default": "ALL",
"enum": [
"ALL",
"SUMMARY"
],
"type": "string"
},
"style": "form"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getResponseschema_8"
}
}
},
"description": "OK"
},
"400": {
"$ref": "#/components/responses/BadRequestError"
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Get Device Positions",
"tags": [
"Device Locator"
]
}
},
"/v1/locate/positions/latest": {
"get": {
"description": "Get latest positions of customer devices (maximum of last 7 days). Only one latest position is possible for a single device independent of source: either Celltower or GPS. This means that `source` query parameter selection can lead to no latest position returned for some devices.\n [OpenCelliD Project](https://opencellid.org/) is licensed under a [Creative Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/)\n",
"parameters": [
{
"description": "The unique device ID which identifies each 1NCE SIM. Can be obtained from the Get All Devices API query. For 1NCE SIMS the device ID is equal to its iccid.",
"explode": true,
"in": "query",
"name": "deviceId",
"required": false,
"schema": {
"example": "",
"type": "string"
},
"style": "form"
},
{
"description": "Number of the requested page. Use this parameter to iterate through all items on the different pages. The total amount of pages is listed in the response body (pageAmount).",
"explode": true,
"in": "query",
"name": "page",
"required": false,
"schema": {
"default": 1,
"maximum": 50,
"minimum": 1,
"type": "integer"
},
"style": "form"
},
{
"description": "Comma seperated list of device property keys in order. Prefix key with `-` to sort descending.",
"explode": false,
"in": "query",
"name": "sort",
"required": false,
"schema": {
"items": {
"default": "-sampleTime",
"type": "string"
},
"type": "array"
},
"style": "form"
},
{
"description": "Source of the position.",
"explode": true,
"in": "query",
"name": "source",
"required": false,
"schema": {
"enum": [
"GPS",
"CellTower"
],
"type": "string"
},
"style": "form"
},
{
"explode": true,
"in": "query",
"name": "startDateTime",
"required": false,
"schema": {
"example": "2022-01-01T01:01:01.000Z",
"type": "string"
},
"style": "form"
},
{
"explode": true,
"in": "query",
"name": "endDateTime",
"required": false,
"schema": {
"example": "2022-01-01T01:01:02Z",
"type": "string"
},
"style": "form"
},
{
"explode": true,
"in": "query",
"name": "longitudeFrom",
"required": false,
"schema": {
"example": -10,
"maximum": 180,
"minimum": -180,
"type": "number"
},
"style": "form"
},
{
"explode": true,
"in": "query",
"name": "longitudeTo",
"required": false,
"schema": {
"example": 10,
"maximum": 180,
"minimum": -180,
"type": "number"
},
"style": "form"
},
{
"explode": true,
"in": "query",
"name": "latitudeFrom",
"required": false,
"schema": {
"example": -10,
"maximum": 90,
"minimum": -90,
"type": "number"
},
"style": "form"
},
{
"explode": true,
"in": "query",
"name": "latitudeTo",
"required": false,
"schema": {
"example": 10,
"maximum": 90,
"minimum": -90,
"type": "number"
},
"style": "form"
},
{
"description": "Parameter for specifying the queried items per page.",
"explode": true,
"in": "query",
"name": "pageSize",
"required": false,
"schema": {
"default": 100,
"example": 10,
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"style": "form"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getLatestResponseschema"
}
}
},
"description": "OK"
},
"400": {
"$ref": "#/components/responses/BadRequestError"
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Get Latest Devices Positions",
"tags": [
"Device Locator"
]
}
},
"/v1/locate/devices/{deviceId}/activity": {
"get": {
"description": "Get Cell location resolutions for one device (maximum of last 7 days).\n [OpenCelliD Project](https://opencellid.org/) is licensed under a [Creative Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/)\n",
"parameters": [
{
"description": "The unique device ID which identifies each 1NCE SIM. Can be obtained from the Get All Devices API query. For 1NCE SIMS the device ID is equal to its iccid.",
"explode": false,
"in": "path",
"name": "deviceId",
"required": true,
"schema": {
"example": "",
"type": "string"
},
"style": "simple"
},
{
"description": "Timestamp from where onwards the historic data should be queried. If not provided while \"endDateTime\" is provided defaults to 1 day before \"endDateTime\" timestamp, otherwise defaults to 1 day from now",
"explode": true,
"in": "query",
"name": "startDateTime",
"required": false,
"schema": {
"example": "2022-01-01T01:01:01.000Z",
"type": "string"
},
"style": "form"
},
{
"description": "Timestamp up to where the historic data should be queried. If not provided while \"startDateTime\" is provided defaults to 1 day after \"startDateTime\" timestamp, otherwise defaults to now",
"explode": true,
"in": "query",
"name": "endDateTime",
"required": false,
"schema": {
"example": "2022-01-01T01:01:02.000Z",
"type": "string"
},
"style": "form"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getResponseschema_9"
}
}
},
"description": "OK"
},
"400": {
"$ref": "#/components/responses/BadRequestError"
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Get Device Celltower location resolutions",
"tags": [
"Device Locator"
]
}
},
"/v1/devices/stats": {
"get": {
"description": "Get general statistics related to customer devices",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/statisticsschema"
}
}
},
"description": "OK"
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Get Devices Statistics",
"tags": [
"Devices"
]
}
},
"/v1/locate/geofences": {
"get": {
"description": "Get an overview of all geofences.\nRate limits apply for this endpoint. See [Rate Limit Policy](https://help.1nce.com/api/api-rate-limits/).\n",
"parameters": [
{
"description": "Parameter for specifying the queried items per page.",
"explode": true,
"in": "query",
"name": "pageSize",
"required": false,
"schema": {
"default": 10,
"example": 10,
"minimum": 1,
"type": "integer"
},
"style": "form"
},
{
"description": "Number of the requested page. Use this parameter to iterate through all items on the different pages. The total amount of pages is listed in the response body (pageAmount).",
"explode": true,
"in": "query",
"name": "page",
"required": false,
"schema": {
"default": 1,
"maximum": 50,
"minimum": 1,
"type": "integer"
},
"style": "form"
},
{
"description": "Name or Prefix of Geofence",
"explode": true,
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
},
"style": "form"
},
{
"description": "The unique device ID which identifies each 1NCE SIM. Can be obtained from the Get All Devices API query. For 1NCE SIMS the device ID is equal to its iccid.",
"explode": true,
"in": "query",
"name": "deviceId",
"required": false,
"schema": {
"example": "",
"type": "string"
},
"style": "form"
},
{
"description": "scope of geofences",
"explode": true,
"in": "query",
"name": "scope",
"required": false,
"schema": {
"enum": [
"global",
"device"
],
"type": "string"
},
"style": "form"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getAllGeofenceResponseschema"
}
}
},
"description": "OK"
},
"400": {
"$ref": "#/components/responses/BadRequestError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Get all geofences",
"tags": [
"Device Locator"
]
},
"post": {
"description": "Create a new geofence.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/postschema_5"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/postGeofenceResponseschema"
}
}
},
"description": "Created"
},
"400": {
"$ref": "#/components/responses/BadRequestError"
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Create geofence",
"tags": [
"Device Locator"
]
}
},
"/v1/locate/geofences/{geofenceId}": {
"delete": {
"description": "Delete a geofence.",
"parameters": [
{
"description": "unique geofence ID",
"explode": false,
"in": "path",
"name": "geofenceId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"204": {
"description": "Deleted"
},
"404": {
"$ref": "#/components/responses/NotFoundError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Delete geofence",
"tags": [
"Device Locator"
]
},
"get": {
"description": "Get details of a geofence.",
"parameters": [
{
"description": "unique geofence ID",
"explode": false,
"in": "path",
"name": "geofenceId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getGeofenceResponseschema"
}
}
},
"description": "OK"
},
"404": {
"$ref": "#/components/responses/NotFoundError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Get a geofence",
"tags": [
"Device Locator"
]
},
"patch": {
"description": "Update an existing geofence",
"parameters": [
{
"description": "unique geofence ID",
"explode": false,
"in": "path",
"name": "geofenceId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/patchschema_1"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/patchGeofenceResponseschema"
}
}
},
"description": "OK"
},
"400": {
"$ref": "#/components/responses/BadRequestError"
},
"404": {
"$ref": "#/components/responses/NotFoundError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Patch a geofence",
"tags": [
"Device Locator"
]
}
},
"/v1/settings/1nceos/{name}": {
"patch": {
"description": "Enables or disables different settings for the 1NCE OS integration of a customer.\n\nDisclaimer: I acknowledge that activating the location feature involves processing nearby Cell Tower data by 1NCE. 1NCE processing of data is done anonymously. I understand that if the use of the service by me makes it linkable to individuals, additional data related responsibilities may apply. As per 1NCE General Terms and Conditions (GTC), I am solely responsible for complying with Data Protection laws and regulations and obtaining necessary consents.\n",
"parameters": [
{
"description": "Key name parameter of the setting to update.",
"explode": false,
"in": "path",
"name": "name",
"required": true,
"schema": {
"example": "LWM2M_PASSIVE_REPORTING",
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/patchschema_2"
}
}
},
"description": "The Body for the updating of customer settings. Must contain state which can be either ENABLED or DISABLED.",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/patchSettingResponseschema"
}
}
},
"description": "An object describing a setting"
},
"400": {
"$ref": "#/components/responses/BadRequestError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Patch Settings",
"tags": [
"Settings"
]
}
},
"/v1/settings/1nceos": {
"get": {
"description": "Gets customer settings related to 1NCE OS.",
"parameters": [
{
"description": "Parameter for specifying the queried items per page.",
"explode": true,
"in": "query",
"name": "pageSize",
"required": false,
"schema": {
"default": 10,
"example": 10,
"minimum": 1,
"type": "integer"
},
"style": "form"
},
{
"description": "Number of the requested page. Use this parameter to iterate through all items on the different pages. The total amount of pages is listed in the response body (pageAmount).",
"explode": true,
"in": "query",
"name": "page",
"required": false,
"schema": {
"default": 1,
"maximum": 50,
"minimum": 1,
"type": "integer"
},
"style": "form"
},
{
"description": "Identifies in what language the description should be returned.",
"explode": true,
"in": "query",
"name": "language",
"required": false,
"schema": {
"enum": [
"en",
"de"
],
"example": "en",
"type": "string"
},
"style": "form"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getResponseschema_10"
}
}
},
"description": "OK"
},
"400": {
"$ref": "#/components/responses/BadRequestError"
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Get customer settings",
"tags": [
"Settings"
]
}
},
"/v1/integrate/clouds/aws": {
"post": {
"description": "Creates AWS Integration, which becomes active only after customer Cloudformation stack is rolled out.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/postschema_6"
}
}
},
"description": "The Body of the bridge creation post contains the ID and the JSON payload converting flag.",
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/postResponseschema_4"
}
}
},
"description": "Created AWS Integration Details."
},
"400": {
"$ref": "#/components/responses/BadRequestError"
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"409": {
"$ref": "#/components/responses/ConflictError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Create AWS Integration",
"tags": [
"IoT Integrator"
]
}
},
"/v1/integrate/clouds/{integrationId}": {
"delete": {
"description": "Delete Integration for a specific customer.",
"parameters": [
{
"description": "unique integration ID",
"explode": false,
"in": "path",
"name": "integrationId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"204": {
"description": "No Content"
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"404": {
"$ref": "#/components/responses/NotFoundError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Delete Integration",
"tags": [
"IoT Integrator"
]
},
"get": {
"description": "Get Customer Integration details",
"parameters": [
{
"description": "unique integration ID",
"explode": false,
"in": "path",
"name": "integrationId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getResponseschema_11"
}
}
},
"description": "Customer Integration Details."
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"404": {
"$ref": "#/components/responses/NotFoundError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Get Customer Integration",
"tags": [
"IoT Integrator"
]
},
"patch": {
"description": "Patch Customer Integration",
"parameters": [
{
"description": "unique integration ID",
"explode": false,
"in": "path",
"name": "integrationId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/patchschema_3"
}
}
},
"description": "The Body for testing the patch integration.",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/patchResponseschema_1"
}
}
},
"description": "Customer Integration Details."
},
"400": {
"$ref": "#/components/responses/BadRequestError"
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"404": {
"$ref": "#/components/responses/NotFoundError"
},
"409": {
"$ref": "#/components/responses/ConflictError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Patch Customer Integration",
"tags": [
"IoT Integrator"
]
}
},
"/v1/integrate/clouds": {
"get": {
"description": "Get All Customer Integrations details",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getAllResponseschema_5"
}
}
},
"description": "All Customer Integration Details."
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Get All Customer Integrations",
"tags": [
"IoT Integrator"
]
}
},
"/v1/integrate/clouds/eventTypes": {
"get": {
"description": "Get Available Integration Event Types.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getEventTypesResponseschema"
}
}
},
"description": "OK"
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Get Integration Event Types",
"tags": [
"IoT Integrator"
]
}
},
"/v1/integrate/clouds/webhooks": {
"post": {
"description": "Creates Webhook Integration.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/postschema_7"
}
}
},
"description": "The Body of the bridge creation post contains the ID and the JSON payload converting flag.",
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/postResponseschema_5"
}
}
},
"description": "Created Webhook Integration Details."
},
"400": {
"$ref": "#/components/responses/BadRequestError"
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"409": {
"$ref": "#/components/responses/ConflictError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Create Webhook Integration",
"tags": [
"IoT Integrator"
]
}
},
"/v1/integrate/clouds/webhooks/{integrationId}": {
"patch": {
"description": "Patch Customer Webhook Integration",
"parameters": [
{
"description": "unique integration ID",
"explode": false,
"in": "path",
"name": "integrationId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/patchschema_4"
}
}
},
"description": "The Body for updating Webhook integration.",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/patchResponseschema_2"
}
}
},
"description": "Customer Webhook Integration Details."
},
"400": {
"$ref": "#/components/responses/BadRequestError"
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"404": {
"$ref": "#/components/responses/NotFoundError"
},
"409": {
"$ref": "#/components/responses/ConflictError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Patch Customer Webhook Integration",
"tags": [
"IoT Integrator"
]
}
},
"/v1/integrate/clouds/webhooks/{integrationId}/restart": {
"post": {
"description": "Restart Webhook integration by forwarding test message to the integration.",
"parameters": [
{
"description": "unique integration ID",
"explode": false,
"in": "path",
"name": "integrationId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/postResponseschema_6"
}
}
},
"description": "OK"
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"404": {
"$ref": "#/components/responses/NotFoundError"
},
"409": {
"$ref": "#/components/responses/ConflictError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Restart Webhook Integration",
"tags": [
"IoT Integrator"
]
}
},
"/v1/integrate/clouds/webhooks/{integrationId}/test": {
"post": {
"description": "Test Webhook integration by forwarding test message to the integration.",
"parameters": [
{
"description": "unique integration ID",
"explode": false,
"in": "path",
"name": "integrationId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/postResponseschema_7"
}
}
},
"description": "OK"
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"404": {
"$ref": "#/components/responses/NotFoundError"
},
"409": {
"$ref": "#/components/responses/ConflictError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Test Webhook Integration",
"tags": [
"IoT Integrator"
]
}
},
"/v1/partners/DATACAKE/plugins": {
"post": {
"description": "Allows setting up an integration with Datacake workspace to allow data transfer from 1NCE OS.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/postschema_8"
}
}
},
"description": "The request body to setup the Datacake plugin.",
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/postResponseschema_8"
}
}
},
"description": "Successful Datacake plugin installation response details."
},
"400": {
"$ref": "#/components/responses/BadRequestError"
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"409": {
"$ref": "#/components/responses/ConflictError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Install Datacake plugin for 1NCE OS",
"tags": [
"Plugin system"
]
}
},
"/v1/partners/MENDER/plugins": {
"post": {
"description": "Allows setting up an integration with Mender to allow seamless firmware update management via 1NCE OS CoAP proxy. Public and private keys are optional fields, but if they are used, both must be provided",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/postschema_9"
}
}
},
"description": "The request body to setup the Mender plugin.",
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/postResponseschema_9"
}
}
},
"description": "Successful Mender plugin installation response details."
},
"400": {
"$ref": "#/components/responses/BadRequestError"
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"409": {
"$ref": "#/components/responses/ConflictError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Install Mender plugin for 1NCE OS",
"tags": [
"Plugin system"
]
}
},
"/v1/partners/TARTABIT/plugins": {
"post": {
"description": "Allows setting up an integration with Tartabit to integrate with Azure, Oracle Cloud Infrastructure, Google Cloud and other cloud services via 1NCE OS.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/postschema_10"
}
}
},
"description": "The request body to setup the Tartabit plugin.",
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/postResponseschema_10"
}
}
},
"description": "Successful Tartabit plugin installation response details."
},
"400": {
"$ref": "#/components/responses/BadRequestError"
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"409": {
"$ref": "#/components/responses/ConflictError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Install Tartabit plugin for 1NCE OS",
"tags": [
"Plugin system"
]
}
},
"/v1/partners/MEMFAULT/plugins": {
"post": {
"description": "Allows setting up an integration with Memfault to allow seamless device debugging via 1NCE OS CoAP proxy.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/postschema_11"
}
}
},
"description": "The request body to setup the Memfault plugin.",
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/postResponseschema_11"
}
}
},
"description": "Successful Memfault plugin installation response details."
},
"400": {
"$ref": "#/components/responses/BadRequestError"
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"409": {
"$ref": "#/components/responses/ConflictError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Install Memfault plugin for 1NCE OS",
"tags": [
"Plugin system"
]
}
},
"/v1/partners/plugins/{pluginId}": {
"delete": {
"description": "Uninstall a specific plugin by ID to remove the functionality provided by the plugin.",
"parameters": [
{
"description": "Unique identifier of the plugin installation.",
"explode": false,
"in": "path",
"name": "pluginId",
"required": true,
"schema": {
"example": "mo3--1DzmAgO-X777AY9h",
"type": "string"
},
"style": "simple"
}
],
"responses": {
"204": {
"description": "NoContent"
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"404": {
"$ref": "#/components/responses/NotFoundError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Uninstall a specific plugin by ID",
"tags": [
"Plugin system"
]
},
"get": {
"description": "Retrieve details about a specific 1NCE OS plugin by it's installation ID.",
"parameters": [
{
"description": "Unique identifier of the plugin installation.",
"explode": false,
"in": "path",
"name": "pluginId",
"required": true,
"schema": {
"example": "mo3--1DzmAgO-X777AY9h",
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_v1_partners_plugins__pluginId__get_200_response"
}
}
},
"description": "OK"
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"404": {
"$ref": "#/components/responses/NotFoundError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Get details about a specific plugin installation",
"tags": [
"Plugin system"
]
}
},
"/v1/partners/plugins/{pluginId}/restart": {
"post": {
"description": "Attempt to restart a plugin that is in a failed state.",
"parameters": [
{
"description": "Unique identifier of the plugin installation.",
"explode": false,
"in": "path",
"name": "pluginId",
"required": true,
"schema": {
"example": "mo3--1DzmAgO-X777AY9h",
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/restartResponseschema"
}
}
},
"description": "OK"
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"404": {
"$ref": "#/components/responses/NotFoundError"
},
"409": {
"$ref": "#/components/responses/ConflictError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Restart a failed plugin by installation ID",
"tags": [
"Plugin system"
]
}
},
"/v1/partners/plugins": {
"get": {
"description": "Retrieve a list of all installed plugins.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getAllResponseschema_6"
}
}
},
"description": "OK"
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"403": {
"$ref": "#/components/responses/ForbiddenError"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"BearerAuthentication": []
}
],
"summary": "Get a list of plugin installations",
"tags": [
"Plugin system"
]
}
}
},
"components": {
"parameters": {
"namePrefixGeofences": {
"description": "Name or Prefix of Geofence",
"explode": true,
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
},
"style": "form"
},
"scope": {
"description": "scope of geofences",
"explode": true,
"in": "query",
"name": "scope",
"required": false,
"schema": {
"enum": [
"global",
"device"
],
"type": "string"
},
"style": "form"
},
"geofenceId": {
"description": "unique geofence ID",
"explode": false,
"in": "path",
"name": "geofenceId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
"page": {
"description": "Number of the requested page. Use this parameter to iterate through all items on the different pages. The total amount of pages is listed in the response body (pageAmount).",
"explode": true,
"in": "query",
"name": "page",
"required": false,
"schema": {
"default": 1,
"maximum": 50,
"minimum": 1,
"type": "integer"
},
"style": "form"
},
"pageSize": {
"description": "Parameter for specifying the queried items per page.",
"explode": true,
"in": "query",
"name": "pageSize",
"required": false,
"schema": {
"default": 10,
"example": 10,
"minimum": 1,
"type": "integer"
},
"style": "form"
},
"sort": {
"description": "Sort values based on keys that are listed as a comma seperated list, prepend \"-\" for descending order.",
"explode": true,
"in": "query",
"name": "sort",
"required": false,
"schema": {
"example": "iccid,-ip",
"type": "string"
},
"style": "form"
},
"deviceId": {
"description": "The unique device ID which identifies each 1NCE SIM. Can be obtained from the Get All Devices API query. For 1NCE SIMS the device ID is equal to its iccid.",
"explode": false,
"in": "path",
"name": "deviceId",
"required": true,
"schema": {
"example": "",
"type": "string"
},
"style": "simple"
},
"requestId": {
"description": "ID of device action request",
"explode": false,
"in": "path",
"name": "requestId",
"required": true,
"schema": {
"example": "",
"type": "string"
},
"style": "simple"
},
"deviceIdQuery": {
"description": "The unique device ID which identifies each 1NCE SIM. Can be obtained from the Get All Devices API query. For 1NCE SIMS the device ID is equal to its iccid.",
"explode": true,
"in": "query",
"name": "deviceId",
"required": false,
"schema": {
"example": "",
"type": "string"
},
"style": "form"
},
"iccidQuery": {
"description": "ICCID of a SIM device, used to identifiy each 1NCE SIM.",
"explode": true,
"in": "query",
"name": "iccid",
"required": false,
"schema": {
"example": "8988280666000000000",
"type": "string"
},
"style": "form"
},
"startDateTime": {
"description": "Timestamp from where onwards the historic data messages should be queried.",
"explode": true,
"in": "query",
"name": "startDateTime",
"required": false,
"schema": {
"example": "2022-03-07T08:51:29.015Z",
"type": "string"
},
"style": "form"
},
"endDateTime": {
"description": "Timestamp until when the historic data messages should be queried.",
"explode": true,
"in": "query",
"name": "endDateTime",
"required": false,
"schema": {
"example": "2022-03-07T09:51:29.015Z",
"type": "string"
},
"style": "form"
},
"protocol": {
"description": "Filter out data for specific protocols: ",
"explode": true,
"in": "query",
"name": "protocol",
"required": false,
"schema": {
"example": "COAP",
"type": "string"
},
"style": "form"
},
"protocolLimited": {
"description": "Filter out by specific protocols: ",
"explode": true,
"in": "query",
"name": "protocol",
"required": false,
"schema": {
"enum": [
"UDP",
"COAP"
],
"example": "COAP",
"type": "string"
},
"style": "form"
},
"nextToken": {
"description": "This API query uses token-based pagination. Each queried page will include a nextToken for accessing the next page for pagination. Please use the returned token in the nextToken query parameters to obtain the next page.",
"explode": true,
"in": "query",
"name": "nextToken",
"required": false,
"schema": {
"example": "",
"type": "string"
},
"style": "form"
},
"interval": {
"description": "The interval for which grouping of statistics should occur.",
"explode": true,
"in": "query",
"name": "interval",
"required": false,
"schema": {
"example": "1d",
"type": "string"
},
"style": "form"
},
"language": {
"description": "Identifies in what language the description should be returned.",
"explode": true,
"in": "query",
"name": "language",
"required": false,
"schema": {
"enum": [
"en",
"de"
],
"example": "en",
"type": "string"
},
"style": "form"
},
"protocolPath": {
"description": "Available protocols: ",
"explode": false,
"in": "path",
"name": "protocol",
"required": true,
"schema": {
"example": "COAP",
"type": "string"
},
"style": "simple"
},
"integrationIdPath": {
"description": "unique integration ID",
"explode": false,
"in": "path",
"name": "integrationId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
"rangeQuery": {
"description": "Specify the range in days to receive data about.",
"explode": true,
"in": "query",
"name": "range",
"required": false,
"schema": {
"default": "1",
"enum": [
"1",
"7",
"30"
],
"example": "1",
"type": "string"
},
"style": "form"
},
"adminLogId": {
"description": "Unique Id of the administration log for which the payload should be queried.",
"explode": false,
"in": "path",
"name": "adminLogId",
"required": true,
"schema": {
"example": "",
"type": "string"
},
"style": "simple"
},
"qQuery": {
"description": "Filter parameter in {filter}:{value} format. Expects comma separated list of filtering criteria out of the following fields: - geofenceId
- category
- iccid
- type
- startDateTime (UTC)
- endDateTime (UTC)
Example: \"type:device,iccid:ICCID,startDateTime:2022-11-14T16:04:38.000Z\"
",
"explode": true,
"in": "query",
"name": "q",
"required": false,
"schema": {
"example": "type:device,iccid:;startDateTime:",
"type": "string"
},
"style": "form"
},
"timezone": {
"description": "Specify the needed timezone as string parameter (e.g., Europe/Amsterdam) for the resulting query output.",
"explode": true,
"in": "query",
"name": "timezone",
"required": true,
"schema": {
"default": "Europe/Amsterdam",
"example": "Europe/Amsterdam",
"type": "string"
},
"style": "form"
},
"adminLogCategoryQuery": {
"description": "Specify the category as string parameter for the resulting query output.",
"explode": true,
"in": "query",
"name": "category",
"required": false,
"schema": {
"enum": [
"info",
"error"
],
"example": "info",
"type": "string"
},
"style": "form"
},
"sortArraySampleTime": {
"description": "Comma seperated list of device property keys in order. Prefix key with `-` to sort descending.",
"explode": false,
"in": "query",
"name": "sort",
"required": false,
"schema": {
"items": {
"default": "-sampleTime",
"type": "string"
},
"type": "array"
},
"style": "form"
},
"source": {
"description": "Source of the position.",
"explode": true,
"in": "query",
"name": "source",
"required": false,
"schema": {
"enum": [
"GPS",
"CellTower"
],
"type": "string"
},
"style": "form"
},
"startDateTimeCommon": {
"explode": true,
"in": "query",
"name": "startDateTime",
"required": false,
"schema": {
"example": "2022-01-01T01:01:01.000Z",
"type": "string"
},
"style": "form"
},
"endDateTimeCommon": {
"explode": true,
"in": "query",
"name": "endDateTime",
"required": false,
"schema": {
"example": "2022-01-01T01:01:02Z",
"type": "string"
},
"style": "form"
},
"startDateTimeActivity": {
"description": "Timestamp from where onwards the historic data should be queried. If not provided while \"endDateTime\" is provided defaults to 1 day before \"endDateTime\" timestamp, otherwise defaults to 1 day from now",
"explode": true,
"in": "query",
"name": "startDateTime",
"required": false,
"schema": {
"example": "2022-01-01T01:01:01.000Z",
"type": "string"
},
"style": "form"
},
"endDateTimeActivity": {
"description": "Timestamp up to where the historic data should be queried. If not provided while \"startDateTime\" is provided defaults to 1 day after \"startDateTime\" timestamp, otherwise defaults to now",
"explode": true,
"in": "query",
"name": "endDateTime",
"required": false,
"schema": {
"example": "2022-01-01T01:01:02.000Z",
"type": "string"
},
"style": "form"
},
"longitudeFrom": {
"explode": true,
"in": "query",
"name": "longitudeFrom",
"required": false,
"schema": {
"example": -10,
"maximum": 180,
"minimum": -180,
"type": "number"
},
"style": "form"
},
"longitudeTo": {
"explode": true,
"in": "query",
"name": "longitudeTo",
"required": false,
"schema": {
"example": 10,
"maximum": 180,
"minimum": -180,
"type": "number"
},
"style": "form"
},
"latitudeFrom": {
"explode": true,
"in": "query",
"name": "latitudeFrom",
"required": false,
"schema": {
"example": -10,
"maximum": 90,
"minimum": -90,
"type": "number"
},
"style": "form"
},
"latitudeTo": {
"explode": true,
"in": "query",
"name": "latitudeTo",
"required": false,
"schema": {
"example": 10,
"maximum": 90,
"minimum": -90,
"type": "number"
},
"style": "form"
},
"pageSize100": {
"description": "Parameter for specifying the queried items per page.",
"explode": true,
"in": "query",
"name": "pageSize",
"required": false,
"schema": {
"default": 100,
"example": 10,
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"style": "form"
},
"pluginIdPath": {
"description": "Unique identifier of the plugin installation.",
"explode": false,
"in": "path",
"name": "pluginId",
"required": true,
"schema": {
"example": "mo3--1DzmAgO-X777AY9h",
"type": "string"
},
"style": "simple"
}
},
"responses": {
"BadRequestError": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/badRequestResponse"
}
}
},
"description": "Bad Request"
},
"NotFoundError": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/notFoundResponse"
}
}
},
"description": "Not Found Error"
},
"InternalServerError": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/serverErrorResponse"
}
}
},
"description": "Internal Server Error"
},
"ForbiddenError": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/forbiddenResponse"
}
}
},
"description": "Forbidden"
},
"UnauthorizedError": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/unauthorizedRequestResponse"
}
}
},
"description": "Unauthorized"
},
"UnprocessableEntityError": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/unprocessableEntityResponse"
}
}
},
"description": "Unprocessable Entity"
},
"ConflictError": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/conflictResponse"
}
}
},
"description": "Conflict"
}
},
"schemas": {
"getAllResponseschema": {
"additionalProperties": false,
"description": "Response to the get device endpoints request.",
"properties": {
"items": {
"description": "An array of endpoint items.",
"items": {
"$ref": "#/components/schemas/getAllResponseschema_items_inner"
},
"type": "array"
},
"page": {
"description": "The current page number of the endpoints.",
"example": 1,
"type": "number"
},
"pageAmount": {
"description": "The total amount of pages needed to show all endpoints.",
"example": 10,
"type": "number"
}
},
"required": [
"items",
"page",
"pageAmount"
],
"title": "Get Device Endpoints Response",
"type": "object"
},
"getResponseschema": {
"additionalProperties": false,
"description": "Response to the get device endpoints request.",
"properties": {
"protocol": {
"description": "The protocol of the endpoint.",
"example": "COAP",
"type": "string"
},
"active": {
"description": "The current status of the endpoint.",
"example": true,
"type": "boolean"
},
"domain": {
"description": "The domain of the endpoint.",
"example": "coap.os.1nce.com",
"type": "string"
},
"ipAddresses": {
"items": {
"description": "The public IP addresses of the endpoint.",
"example": "127.0.0.1",
"type": "string"
},
"type": "array"
},
"port": {
"description": "The port of the endpoint.",
"example": 5683,
"type": "number"
},
"securePort": {
"description": "The port of the endpoint.",
"example": 5684,
"type": "number"
},
"settings": {
"items": {
"$ref": "#/components/schemas/getResponseschema_settings_inner"
},
"type": "array"
}
},
"required": [
"active",
"domain",
"ipAddresses",
"port",
"protocol"
],
"title": "Get Device Endpoints Response",
"type": "object"
},
"patchschema": {
"additionalProperties": false,
"description": "Patch status for device endpoint request.",
"properties": {
"active": {
"deprecated": true,
"description": "Not used.",
"example": true,
"type": "boolean"
},
"settings": {
"items": {
"$ref": "#/components/schemas/patchschema_settings_inner"
},
"type": "array"
}
},
"required": [
"settings"
],
"title": "Device Endpoint Patch Request",
"type": "object"
},
"patchResponseschema": {
"additionalProperties": false,
"description": "Response to the patch device endpoints request.",
"properties": {
"protocol": {
"description": "The protocol of the endpoint.",
"example": "COAP",
"type": "string"
},
"active": {
"description": "The current status of the endpoint.",
"example": true,
"type": "boolean"
},
"domain": {
"description": "The domain of the endpoint.",
"example": "coap.os.1nce.com",
"type": "string"
},
"ipAddresses": {
"items": {
"description": "The public IP addresses of the endpoint.",
"example": "127.0.0.1",
"type": "string"
},
"type": "array"
},
"port": {
"description": "The port of the endpoint.",
"example": 5683,
"type": "number"
},
"securePort": {
"description": "The port of the endpoint.",
"example": 5684,
"type": "number"
},
"settings": {
"items": {
"$ref": "#/components/schemas/getResponseschema_settings_inner"
},
"type": "array"
}
},
"required": [
"active",
"domain",
"ipAddresses",
"port",
"protocol",
"settings"
],
"title": "Patch Device Endpoints Response",
"type": "object"
},
"getAllResponseschema_1": {
"additionalProperties": false,
"description": "Response to the request to get device action requests.",
"properties": {
"items": {
"description": "An array of request items.",
"items": {
"$ref": "#/components/schemas/getAllResponseschema_1_items_inner"
},
"type": "array"
},
"page": {
"description": "The current page number of the requests.",
"example": 1,
"type": "number"
},
"pageAmount": {
"description": "The total amount of pages needed to show all requests.",
"example": 10,
"type": "number"
}
},
"required": [
"items",
"page",
"pageAmount"
],
"title": "Get Device Action Requests Response",
"type": "object"
},
"getActiveResponseschema": {
"additionalProperties": false,
"description": "Response to the request to get active device action requests.",
"properties": {
"items": {
"description": "An array of request items.",
"items": {
"$ref": "#/components/schemas/getActiveResponseschema_items_inner"
},
"type": "array"
},
"page": {
"description": "The current page number of the requests.",
"example": 1,
"type": "number"
},
"pageAmount": {
"description": "The total amount of pages needed to show all requests.",
"example": 10,
"type": "number"
}
},
"required": [
"items",
"page",
"pageAmount"
],
"title": "Get Active Device Action Requests Response",
"type": "object"
},
"getArchivedResponseschema": {
"additionalProperties": false,
"description": "Response to the request to get archived device action requests.",
"properties": {
"items": {
"description": "An array of request items.",
"items": {
"$ref": "#/components/schemas/getArchivedResponseschema_items_inner"
},
"type": "array"
},
"page": {
"description": "The current page number of the requests.",
"example": 1,
"type": "number"
},
"pageAmount": {
"description": "The total amount of pages needed to show all requests.",
"example": 10,
"type": "number"
}
},
"required": [
"items",
"page",
"pageAmount"
],
"title": "Get Archived Device Action Requests Response",
"type": "object"
},
"deleteAllResponseschema": {
"description": "Response to the request to cancel all device action requests.",
"items": {
"$ref": "#/components/schemas/deleteAllResponseschema_inner"
},
"title": "Cancel All Device Action Requests Response",
"type": "array"
},
"getResponseschema_1": {
"additionalProperties": false,
"description": "Response to the request to get device action request.",
"properties": {
"id": {
"description": "The ID of the request.",
"example": "",
"type": "string"
},
"status": {
"description": "The status of the request.",
"enum": [
"SCHEDULED",
"IN_PROGRESS",
"FAILED",
"SUCCEEDED",
"CANCELLED"
],
"example": "IN_PROGRESS",
"type": "string"
},
"deviceId": {
"description": "The unique ID of the device.",
"example": "",
"type": "string"
},
"ip": {
"description": "The IP address of the device.",
"example": "x.x.x.x",
"type": "string"
},
"protocol": {
"description": "The protocol of the request.",
"example": "LWM2M",
"type": "string"
},
"created": {
"description": "The timestamp at which the request was created.",
"format": "date-time",
"type": "string"
},
"updated": {
"description": "The timestamp at which the request was updated.",
"format": "date-time",
"type": "string"
},
"mode": {
"description": "The mode of the request.",
"enum": [
"SEND_NOW",
"SEND_WHEN_ACTIVE"
],
"example": "SEND_NOW",
"type": "string"
},
"resultData": {
"description": "Result data (can include response from device etc.).",
"type": "object"
},
"requestData": {
"description": "Protocol specific request data.",
"type": "object"
},
"sendAttemptsLeft": {
"description": "How many attempts are left to send data to the device",
"example": 1,
"maximum": 5,
"minimum": 0,
"type": "number"
},
"sendAttempts": {
"description": "The maximum number of attempts to send data to a device",
"example": 3,
"maximum": 5,
"minimum": 1,
"type": "number"
}
},
"required": [
"created",
"deviceId",
"id",
"ip",
"mode",
"protocol",
"status",
"updated"
],
"title": "Get Device Action Request Response",
"type": "object"
},
"deleteResponseschema": {
"additionalProperties": false,
"description": "Response to the request to cancel device action request.",
"properties": {
"id": {
"description": "The ID of the request.",
"example": "",
"type": "string"
},
"status": {
"description": "The status of the request.",
"enum": [
"CANCELLED"
],
"example": "CANCELLED",
"type": "string"
}
},
"required": [
"id",
"status"
],
"title": "Cancel Device Action Request Response",
"type": "object"
},
"postPreSharedKeyschema": {
"additionalProperties": false,
"description": "Post a pre-shared key for a specific device.",
"properties": {
"secretKey": {
"description": "Pre-shared secret key for a device.",
"example": "",
"maxLength": 256,
"minLength": 8,
"type": "string"
},
"protocol": {
"description": "Protocol PSK is applied for",
"enum": [
"COAP",
"LWM2M"
],
"type": "string"
},
"format": {
"description": "The format in which the secret key was provided.",
"enum": [
"STRING",
"HEX"
],
"type": "string"
}
},
"required": [
"protocol",
"secretKey"
],
"title": "Pre-shared key post request.",
"type": "object"
},
"postPreSharedKeyResponseschema": {
"additionalProperties": false,
"description": "Post pre-shared key response.",
"properties": {
"deviceId": {
"description": "Identifier of the device.",
"example": "",
"minLength": 1,
"type": "string"
},
"identity": {
"description": "Client identity of the pre-shared key.",
"example": "",
"minLength": 1,
"type": "string"
},
"secretKey": {
"description": "Secret key of the pre-shared key.",
"example": "",
"maxLength": 256,
"minLength": 8,
"type": "string"
},
"createdAt": {
"description": "Created timestamp of the pre-shared key.",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"updatedAt": {
"description": "Updated timestamp of the pre-shared key.",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"protocol": {
"description": "Protocol PSK is applied for",
"enum": [
"COAP",
"LWM2M"
],
"type": "string"
},
"format": {
"description": "The format in which the secret key was provided.",
"enum": [
"STRING",
"HEX"
],
"type": "string"
}
},
"required": [
"createdAt",
"deviceId",
"format",
"identity",
"protocol",
"secretKey",
"updatedAt"
],
"title": "Pre-shared key response.",
"type": "object"
},
"getResponseschema_2": {
"description": "Get status of device PreSharedKey import job.",
"properties": {
"items": {
"description": "Customer import jobs data",
"items": {
"$ref": "#/components/schemas/getResponseschema_2_items_inner"
},
"type": "array"
},
"page": {
"description": "Current page number.",
"example": 1,
"minimum": 1,
"type": "number"
},
"pageAmount": {
"description": "Total number of pages.",
"example": 2,
"minimum": 1,
"type": "number"
}
},
"required": [
"items",
"page",
"pageAmount"
],
"title": "PSK import status Request",
"type": "object"
},
"postschema": {
"description": "Import of Pre-Shared Keys for multiple devices.",
"items": {
"$ref": "#/components/schemas/postschema_inner"
},
"maxItems": 5000,
"minItems": 1,
"title": "Pre-Shared Keys import request.",
"type": "array"
},
"postschema_1": {
"additionalProperties": false,
"description": "Post LwM2M device action.",
"properties": {
"action": {
"default": "read",
"description": "LwM2M action name to send to device.",
"enum": [
"read",
"write",
"execute",
"observe-start",
"observe-end"
],
"example": "read",
"type": "string"
},
"resourceAddress": {
"description": "LwM2M OMA object resource address.",
"example": "/3/45/22",
"type": "string"
},
"data": {
"description": "Data which should be written to some resource, should be passed only in write operation.",
"example": "enable_sensor",
"type": "string"
},
"requestMode": {
"default": "SEND_NOW",
"description": "Action request execution mode",
"enum": [
"SEND_NOW",
"SEND_WHEN_ACTIVE"
],
"type": "string"
},
"sendAttempts": {
"default": 1,
"description": "The maximum number of attempts to send data to a device",
"maximum": 5,
"minimum": 1,
"type": "number"
}
},
"required": [
"action",
"resourceAddress"
],
"title": "Device action request",
"type": "object"
},
"postResponseschema": {
"additionalProperties": false,
"description": "Post device action response.",
"properties": {
"id": {
"description": "Id of the created action request",
"example": "trxHeBL0d234fsfds",
"type": "string"
},
"message": {
"description": "Message describing the result of operation.",
"example": "Action write for resource /3/45/22 successfuly scheduled for device _vGxHeBL0dE9LG9EB2GHj.",
"type": "string"
}
},
"required": [
"id",
"message"
],
"title": "Device action response",
"type": "object"
},
"bulkPostschema": {
"additionalProperties": false,
"description": "Bulk Post LwM2M device action.",
"properties": {
"deviceIds": {
"description": "Devices that should receive the data",
"items": {
"example": "",
"pattern": "^[a-zA-Z0-9_-]{1,}$",
"type": "string"
},
"maxItems": 100,
"minItems": 1,
"type": "array"
},
"action": {
"default": "read",
"description": "LwM2M action name to send to the devices.",
"enum": [
"read",
"write",
"execute",
"observe-start",
"observe-end"
],
"example": "read",
"type": "string"
},
"resourceAddress": {
"description": "LwM2M OMA object resource address.",
"example": "/3/45/22",
"type": "string"
},
"data": {
"description": "Data which should be written to some resource, should be passed only in write operation.",
"example": "enable_sensor",
"type": "string"
},
"requestMode": {
"default": "SEND_NOW",
"description": "Action request execution mode",
"enum": [
"SEND_NOW",
"SEND_WHEN_ACTIVE"
],
"type": "string"
},
"sendAttempts": {
"default": 1,
"description": "The maximum number of attempts to send data to the devices",
"maximum": 5,
"minimum": 1,
"type": "number"
}
},
"required": [
"action",
"deviceIds",
"resourceAddress"
],
"title": "Device action request",
"type": "object"
},
"bulkPostResponseschema": {
"additionalProperties": false,
"description": "Post device action response.",
"properties": {
"acceptedRequests": {
"description": "successfully created action requests",
"items": {
"$ref": "#/components/schemas/bulkPostResponseschema_acceptedRequests_inner"
},
"type": "array"
},
"rejectedDevices": {
"description": "A list of devices for which it was not possible to send data.",
"items": {
"description": "Id of the device.",
"example": "",
"type": "string"
},
"type": "array"
},
"message": {
"description": "Message describing the result of operation.",
"example": "Action write for resource /3/45/22 successfuly scheduled for device _vGxHeBL0dE9LG9EB2GHj.",
"type": "string"
}
},
"required": [
"acceptedRequests",
"message",
"rejectedDevices"
],
"title": "Device action response",
"type": "object"
},
"postschema_2": {
"additionalProperties": false,
"description": "Post CoAP device action.",
"properties": {
"payload": {
"description": "Data that should be sent to a device",
"example": "enable_sensor",
"type": "string"
},
"payloadType": {
"description": "Type of the payload",
"enum": [
"STRING",
"BASE64"
],
"type": "string"
},
"port": {
"description": "Communication port number of a device",
"example": 3000,
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"path": {
"description": "Absolute path to the resource",
"example": "example?param1=query_param_example",
"pattern": "^[a-zA-Z0-9\\-._~%:/?#@!$&'()*+,;=]{0,255}$",
"type": "string"
},
"requestType": {
"description": "CoAP request type that should be sent",
"enum": [
"GET",
"POST",
"PUT",
"DELETE",
"PATCH"
],
"type": "string"
},
"requestMode": {
"default": "SEND_NOW",
"description": "Action request execution mode",
"enum": [
"SEND_NOW",
"SEND_WHEN_ACTIVE"
],
"type": "string"
},
"sendAttempts": {
"default": 1,
"description": "The maximum number of attempts to send data to a device",
"maximum": 5,
"minimum": 1,
"type": "number"
}
},
"required": [
"path",
"port",
"requestType"
],
"title": "Device action request",
"type": "object"
},
"bulkPostschema_1": {
"additionalProperties": false,
"description": "Bulk Post CoAP device action.",
"properties": {
"deviceIds": {
"description": "Devices that should receive the data",
"items": {
"example": "",
"pattern": "^[a-zA-Z0-9_-]{1,}$",
"type": "string"
},
"maxItems": 100,
"minItems": 1,
"type": "array"
},
"payload": {
"description": "Data that should be sent to the devices",
"example": "enable_sensor",
"type": "string"
},
"payloadType": {
"description": "Type of the payload",
"enum": [
"STRING",
"BASE64"
],
"type": "string"
},
"port": {
"description": "Communication port number of the devices",
"example": 3000,
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"path": {
"description": "Absolute path to the resource",
"example": "example?param1=query_param_example",
"pattern": "^[a-zA-Z0-9\\-._~%:/?#@!$&'()*+,;=]{0,255}$",
"type": "string"
},
"requestType": {
"description": "CoAP request type that should be sent",
"enum": [
"GET",
"POST",
"PUT",
"DELETE",
"PATCH"
],
"type": "string"
},
"requestMode": {
"default": "SEND_NOW",
"description": "Action request execution mode",
"enum": [
"SEND_NOW",
"SEND_WHEN_ACTIVE"
],
"type": "string"
},
"sendAttempts": {
"default": 1,
"description": "The maximum number of attempts to send data to the devices",
"maximum": 5,
"minimum": 1,
"type": "number"
}
},
"required": [
"deviceIds",
"path",
"port",
"requestType"
],
"title": "Device action request",
"type": "object"
},
"postschema_3": {
"additionalProperties": false,
"description": "Post UDP device action.",
"properties": {
"payload": {
"description": "Data that should be sent to a device",
"example": "enable_sensor",
"type": "string"
},
"payloadType": {
"description": "Type of the payload",
"enum": [
"STRING",
"BASE64"
],
"type": "string"
},
"port": {
"description": "Communication port number of a device",
"example": 3000,
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"requestMode": {
"default": "SEND_NOW",
"description": "Action request execution mode",
"enum": [
"SEND_NOW",
"SEND_WHEN_ACTIVE"
],
"type": "string"
}
},
"required": [
"payload",
"payloadType",
"port"
],
"title": "Device action request",
"type": "object"
},
"bulkPostschema_2": {
"additionalProperties": false,
"description": "Bulk Post UDP device action.",
"properties": {
"deviceIds": {
"description": "Devices that should receive the data",
"items": {
"example": "",
"pattern": "^[a-zA-Z0-9_-]{1,}$",
"type": "string"
},
"maxItems": 100,
"minItems": 1,
"type": "array"
},
"payload": {
"description": "Data that should be sent to the devices",
"example": "enable_sensor",
"type": "string"
},
"payloadType": {
"description": "Type of the payload",
"enum": [
"STRING",
"BASE64"
],
"type": "string"
},
"port": {
"description": "Communication port number of the devices",
"example": 3000,
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"requestMode": {
"default": "SEND_NOW",
"description": "Action request execution mode",
"enum": [
"SEND_NOW",
"SEND_WHEN_ACTIVE"
],
"type": "string"
}
},
"required": [
"deviceIds",
"payload",
"payloadType",
"port"
],
"title": "Device action request",
"type": "object"
},
"postschema_4": {
"additionalProperties": false,
"description": "Test a translation template with a sample input message request.",
"properties": {
"template": {
"description": "A stringified JSON template.",
"example": "",
"minLength": 1,
"type": "string"
},
"payload": {
"description": "Sample input used to test the template (base64).",
"example": "",
"minLength": 1,
"type": "string"
}
},
"required": [
"payload",
"template"
],
"title": "Test translation template request",
"type": "object"
},
"postResponseschema_1": {
"additionalProperties": false,
"description": "Response to the test a translation template with a sample input message request.",
"properties": {
"translatedPayload": {
"description": "A stringified JSON message (result from applying template to the sample input).",
"example": "",
"type": "string"
},
"reducedBytes": {
"description": "The number of bytes that the device didn't have to send over the network by using the translation template.",
"example": 1,
"type": "number"
},
"energyUsageReduction": {
"description": "The energy saved on data transfer using provided template in percent.",
"example": 10.0,
"type": "number"
}
},
"required": [
"energyUsageReduction",
"reducedBytes",
"translatedPayload"
],
"title": "Test translation template response",
"type": "object"
},
"getResponseschema_3": {
"additionalProperties": false,
"description": "Response to the get optimizer savings request.",
"properties": {
"messagesTranslated": {
"$ref": "#/components/schemas/getResponseschema_3_messagesTranslated"
},
"averageBytesReducedPerMessage": {
"$ref": "#/components/schemas/getResponseschema_3_averageBytesReducedPerMessage"
},
"bytesSaved": {
"$ref": "#/components/schemas/getResponseschema_3_bytesSaved"
}
},
"required": [
"averageBytesReducedPerMessage",
"bytesSaved",
"messagesTranslated"
],
"title": "Get optimizer savings response",
"type": "object"
},
"postAgreementsRequestschema": {
"description": "The agreements acceptance request model.",
"properties": {
"accepted": {
"default": true,
"description": "Flag indicating that the Terms of Use and Data Processing agreeements are accepted. Please note that only true is accepted.",
"type": "boolean"
}
},
"required": [
"accepted"
],
"title": "Post Agreements Accepted",
"type": "object"
},
"getCloudFormationParameters": {
"additionalProperties": false,
"description": "Get the CloudFormation parameters currently configured.",
"properties": {
"awsIntegration": {
"description": "A list of all aws cloud connection integration templates and their respective versions.",
"items": {
"$ref": "#/components/schemas/getCloudFormationParameters_awsIntegration_inner"
},
"type": "array"
}
},
"required": [
"awsIntegration"
],
"title": "Get CloudFormation Parameters Response",
"type": "object"
},
"postResponseschema_2": {
"additionalProperties": false,
"description": "Post AWS integration restart response",
"properties": {
"integration": {
"$ref": "#/components/schemas/postResponseschema_2_integration"
},
"restartStatus": {
"description": "AWS integration restart status.",
"enum": [
"SUCCESS",
"FAILURE"
],
"example": "SUCCESS",
"type": "string"
},
"message": {
"description": "AWS integration restart message.",
"example": "Restart was successful",
"minLength": 1,
"type": "string"
}
},
"required": [
"integration",
"message",
"restartStatus"
],
"title": "AWS Integration restart response",
"type": "object"
},
"postResponseschema_3": {
"additionalProperties": false,
"description": "Post AWS integration test response",
"properties": {
"testStatus": {
"description": "AWS integration test status.",
"enum": [
"SUCCESS",
"FAILURE"
],
"example": "SUCCESS",
"type": "string"
},
"message": {
"description": "AWS integration test message.",
"example": "Test was successful",
"minLength": 1,
"type": "string"
}
},
"required": [
"message",
"testStatus"
],
"title": "AWS Integration test response",
"type": "object"
},
"getAdministrationLogsResponseschema": {
"additionalProperties": false,
"description": "Response to the get administration logs request.",
"properties": {
"page": {
"description": "The current page number of the administration logs.",
"example": 1,
"type": "number"
},
"pageAmount": {
"description": "The total amount of pages needed to show all administration logs.",
"example": 10,
"type": "number"
},
"items": {
"description": "An array of administration logs items.",
"items": {
"$ref": "#/components/schemas/getAdministrationLogsResponseschema_items_inner"
},
"type": "array"
}
},
"required": [
"items"
],
"title": "Get Administration Logs Response",
"type": "object"
},
"getAdministrationLogsStatisticsResponseschema": {
"additionalProperties": false,
"description": "Response to the get administration logs statistics request.",
"properties": {
"totalUniqueDevices": {
"description": "The amount of unique devices that caused an administration log.",
"example": 2,
"type": "integer"
},
"administrationLogs": {
"description": "An array of administration logs stats.",
"items": {
"$ref": "#/components/schemas/getAdministrationLogsStatisticsResponseschema_administrationLogs_inner"
},
"type": "array"
}
},
"required": [
"administrationLogs",
"totalUniqueDevices"
],
"title": "Get Administration Logs Statistics",
"type": "object"
},
"getTranslationTemplatesResponseschema": {
"description": "Response to the get Translation Template request.",
"items": {
"$ref": "#/components/schemas/getTranslationTemplatesResponseschema_inner"
},
"title": "Get Translation Template Response",
"type": "array"
},
"createTranslationTemplateRequestschema": {
"additionalProperties": false,
"description": "Post new Translation Template model.",
"properties": {
"name": {
"description": "Name of the new template.",
"example": "",
"maxLength": 64,
"minLength": 1,
"type": "string"
},
"template": {
"description": "A stringified JSON template.",
"example": "",
"minLength": 1,
"type": "string"
},
"protocolFilter": {
"default": "COAP",
"description": "Protocol filter that applies to this template.",
"example": "COAP",
"items": {
"enum": [
"COAP",
"UDP"
],
"type": "string"
},
"minItems": 1,
"type": "array"
},
"status": {
"description": "The current status of the template.",
"enum": [
"ACTIVE",
"INACTIVE"
],
"example": "ACTIVE",
"type": "string"
}
},
"required": [
"name",
"protocolFilter",
"template"
],
"title": "Templates request",
"type": "object"
},
"postPatchTranslationTemplatesResponseschema": {
"description": "Response to the post or the patch Translation Template request.",
"properties": {
"name": {
"description": "Name of the specific template.",
"example": "",
"maxLength": 64,
"minLength": 1,
"type": "string"
},
"template": {
"description": "A stringified JSON template.",
"example": "",
"minLength": 1,
"type": "string"
},
"status": {
"description": "The current status of the template.",
"enum": [
"ACTIVE",
"INACTIVE"
],
"example": "ACTIVE",
"type": "string"
},
"id": {
"description": "The unique ID of the template.",
"example": "",
"type": "string"
},
"protocolFilter": {
"default": "COAP",
"description": "Protocol filter that applies to this template. Only the listed protocols will be processed by the template.",
"example": "COAP",
"items": {
"enum": [
"COAP",
"UDP"
],
"type": "string"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"id",
"name",
"protocolFilter",
"status",
"template"
],
"title": "Post/Patch Translation Template Response",
"type": "object"
},
"patchTranslationTemplateRequestschema": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"name"
],
"type": "object"
},
{
"required": [
"template"
],
"type": "object"
},
{
"required": [
"protocolFilter"
],
"type": "object"
},
{
"required": [
"status"
],
"type": "object"
}
],
"description": "Update a Translation Template.",
"properties": {
"name": {
"description": "New name of the template.",
"example": "",
"maxLength": 64,
"minLength": 1,
"type": "string"
},
"template": {
"description": "A new stringified JSON template.",
"example": "",
"minLength": 1,
"type": "string"
},
"protocolFilter": {
"default": "COAP",
"description": "Protocol filter that applies to this template.",
"example": "COAP",
"items": {
"enum": [
"COAP",
"UDP"
],
"type": "string"
},
"minItems": 1,
"type": "array"
},
"status": {
"description": "The current status of the template.",
"enum": [
"ACTIVE",
"INACTIVE"
],
"example": "ACTIVE",
"type": "string"
}
},
"title": "Templates request",
"type": "object"
},
"getAllResponseschema_2": {
"description": "Get all devices as a list.",
"properties": {
"items": {
"description": "List of devices.",
"items": {
"$ref": "#/components/schemas/getAllResponseschema_2_items_inner"
},
"type": "array"
},
"page": {
"description": "Current page number.",
"example": 1,
"minimum": 1,
"type": "number"
},
"pageAmount": {
"description": "Total number of pages.",
"example": 2,
"minimum": 1,
"type": "number"
}
},
"required": [
"items",
"page",
"pageAmount"
],
"title": "All Devices Request",
"type": "object"
},
"getResponseschema_4": {
"description": "Get a single device metadata.",
"properties": {
"name": {
"description": "Name of the device.",
"example": "",
"minLength": 1,
"type": "string"
},
"id": {
"description": "Id of the device.",
"example": "",
"minLength": 19,
"type": "string"
},
"iccid": {
"description": "Iccid of the device.",
"example": "8988280666000000000",
"pattern": "^[0-9]{19}$",
"type": "string"
},
"imsi1": {
"description": "IMSI1 of the device.",
"example": "901405100000018",
"pattern": "^[0-9]{15}$",
"type": "string"
},
"ip": {
"description": "Ip of the device.",
"example": "x.x.x.x",
"format": "ipv4",
"type": "string"
}
},
"required": [
"iccid",
"id",
"imsi1",
"ip"
],
"title": "Single Devices Request",
"type": "object"
},
"getResponseschema_5": {
"description": "Get a device shadow state (telemetry data).",
"properties": {
"id": {
"description": "Id of the device.",
"example": "",
"minLength": 19,
"type": "string"
},
"state": {
"description": "The current IoT Core Device State.",
"type": "object"
}
},
"required": [
"id",
"state"
],
"title": "Device Telemetry",
"type": "object"
},
"getResponseschema_6": {
"additionalProperties": false,
"description": "Get all device messages from the historian.",
"properties": {
"items": {
"description": "List of messages.",
"items": {
"$ref": "#/components/schemas/getResponseschema_6_items_inner"
},
"type": "array"
},
"nextToken": {
"description": "This API query uses token-based pagination. A queried page will include a nextToken for accessing the next page for pagination if a further page is available. Please use the returned token in the nextToken query parameters to obtain the next page.",
"example": "",
"type": "string"
},
"firstToken": {
"description": "When no nextToken is passed as part of the query parameters, the firstToken is provided as reference to the first page of the queried pages.",
"example": "",
"type": "string"
}
},
"required": [
"items"
],
"title": "Device History Response",
"type": "object"
},
"getAllResponseschema_3": {
"additionalProperties": false,
"description": "Get all messages from the historian.",
"properties": {
"items": {
"description": "List of messages.",
"items": {
"$ref": "#/components/schemas/getAllResponseschema_3_items_inner"
},
"type": "array"
},
"nextToken": {
"description": "This API query uses token-based pagination. A queried page will include a nextToken for accessing the next page for pagination if a further page is available. Please use the returned token in the nextToken query parameters to obtain the next page.",
"example": "",
"type": "string"
},
"firstToken": {
"description": "When no nextToken is passed as part of the query parameters, the firstToken is provided as reference to the first page of the queried pages.",
"example": "",
"type": "string"
}
},
"required": [
"items"
],
"title": "History Response",
"type": "object"
},
"getResponseschema_7": {
"additionalProperties": false,
"description": "Get the devices history insights for a specific time range.",
"properties": {
"items": {
"description": "List of messages.",
"items": {
"$ref": "#/components/schemas/getResponseschema_7_items_inner"
},
"type": "array"
},
"interval": {
"description": "Interval of the message statistics, like 1h.",
"example": "1d",
"type": "string"
}
},
"required": [
"interval",
"items"
],
"title": "Device History Insights Response",
"type": "object"
},
"getAllResponseschema_4": {
"additionalProperties": false,
"description": "Get the history insights for a specific time range.",
"properties": {
"items": {
"description": "List of messages.",
"items": {
"$ref": "#/components/schemas/getAllResponseschema_4_items_inner"
},
"type": "array"
},
"interval": {
"description": "Interval of the message statistics, like 1h.",
"example": "1d",
"type": "string"
}
},
"required": [
"interval",
"items"
],
"title": "Device History Insights Response",
"type": "object"
},
"getResponseschema_8": {
"description": "Get positions of a specific device.",
"properties": {
"page": {
"description": "The current page number of the positions.",
"example": 1,
"type": "number"
},
"pageAmount": {
"description": "The total amount of pages needed to show all positions.",
"example": 10,
"type": "number"
},
"coordinates": {
"description": "Positions of the device",
"items": {
"$ref": "#/components/schemas/getResponseschema_8_coordinates_inner"
},
"type": "array"
}
},
"required": [
"coordinates",
"page",
"pageAmount"
],
"title": "Device Positions response",
"type": "object"
},
"getLatestResponseschema": {
"description": "Get latest positions of customer devices.",
"properties": {
"page": {
"description": "The current page number of the positions.",
"example": 1,
"type": "number"
},
"pageAmount": {
"description": "The total amount of pages needed to show all positions.",
"example": 10,
"type": "number"
},
"coordinates": {
"description": "Latest positions of each customer device",
"items": {
"$ref": "#/components/schemas/getLatestResponseschema_coordinates_inner"
},
"type": "array"
}
},
"required": [
"coordinates",
"page",
"pageAmount"
],
"title": "Latest Devices Positions response",
"type": "object"
},
"getResponseschema_9": {
"description": "Get Cell location resolutions for one device (maximum of last 7 days).",
"properties": {
"items": {
"description": "Location resolutions of the device",
"items": {
"$ref": "#/components/schemas/getResponseschema_9_items_inner"
},
"type": "array"
}
},
"required": [
"items"
],
"title": "Device Celltower Location Resolutions response",
"type": "object"
},
"statisticsschema": {
"additionalProperties": false,
"description": "General statistics related to customer devices.",
"properties": {
"totalDevices": {
"description": "Total amount of devices for the customer.",
"example": 10,
"type": "integer"
},
"activatedDevices": {
"description": "Total amount of devices that completed the activation process.",
"example": 5,
"type": "integer"
}
},
"required": [
"activatedDevices",
"totalDevices"
],
"title": "Devices Statistics",
"type": "object"
},
"getAllGeofenceResponseschema": {
"description": "Response to get all geofences request.",
"properties": {
"items": {
"description": "List of geofences",
"items": {
"$ref": "#/components/schemas/GenericGeofenceData"
},
"type": "array"
},
"page": {
"description": "Current page number",
"minimum": 1,
"type": "number"
},
"pageAmount": {
"description": "Total number of pages",
"minimum": 1,
"type": "number"
}
},
"required": [
"items",
"page",
"pageAmount"
],
"title": "Get All Geofences Response",
"type": "object"
},
"postschema_5": {
"description": "Request to create a geofence.",
"oneOf": [
{
"$ref": "#/components/schemas/CreatePolygonGeofence"
},
{
"$ref": "#/components/schemas/CreateCircleGeofence"
}
],
"title": "Post Geofence Request",
"type": "object"
},
"postGeofenceResponseschema": {
"description": "Response to post geofence request.",
"oneOf": [
{
"$ref": "#/components/schemas/postGeofenceResponseschema_oneOf"
},
{
"$ref": "#/components/schemas/postGeofenceResponseschema_oneOf_1"
}
],
"title": "Post Geofence Response"
},
"getGeofenceResponseschema": {
"description": "Response to get geofence request.",
"oneOf": [
{
"$ref": "#/components/schemas/PolygonGeofenceData"
},
{
"$ref": "#/components/schemas/CircleGeofenceData"
}
],
"title": "Get Geofence Response"
},
"patchschema_1": {
"additionalProperties": false,
"description": "Request to update a geofence.",
"properties": {
"name": {
"$ref": "#/components/schemas/Name"
},
"eventTypes": {
"$ref": "#/components/schemas/EventTypes"
},
"eventSources": {
"$ref": "#/components/schemas/EventSources"
}
},
"title": "Patch Geofence Request",
"type": "object"
},
"patchGeofenceResponseschema": {
"description": "Patch request geofence response.",
"oneOf": [
{
"$ref": "#/components/schemas/patchGeofenceResponseschema_oneOf"
},
{
"$ref": "#/components/schemas/patchGeofenceResponseschema_oneOf_1"
}
],
"title": "Patch Geofence Response"
},
"patchschema_2": {
"additionalProperties": false,
"description": "Patch options for setting request.",
"properties": {
"state": {
"description": "State to set for setting.",
"enum": [
"ENABLED",
"DISABLED"
],
"type": "string"
},
"readAndAcceptedDisclaimer": {
"description": "Has the disclaimer for enabling CELL_TOWER_LOCATION setting been read and accepted.",
"type": "boolean"
}
},
"required": [
"state"
],
"title": "Setting Patch Request",
"type": "object"
},
"patchSettingResponseschema": {
"additionalProperties": false,
"description": "Response to configuring a setting.",
"properties": {
"customerId": {
"description": "Internal customer identifier.",
"example": "",
"minLength": 1,
"type": "string"
},
"name": {
"description": "Name of setting.",
"example": "",
"minLength": 1,
"type": "string"
},
"state": {
"description": "State of the setting.",
"enum": [
"ENABLED",
"DISABLED"
],
"type": "string"
}
},
"required": [
"customerId",
"name",
"state"
],
"title": "Setting Patch Response",
"type": "object"
},
"getResponseschema_10": {
"additionalProperties": false,
"description": "Get customer settings filtered by feature flags.",
"properties": {
"items": {
"description": "List of settings.",
"items": {
"$ref": "#/components/schemas/getResponseschema_10_items_inner"
},
"type": "array"
},
"page": {
"description": "The number corresponding to the page for which data was requested.",
"minimum": 1,
"type": "number"
},
"pageAmount": {
"description": "Total amount of pages to be queried using the given pageSize.",
"minimum": 1,
"type": "number"
}
},
"required": [
"items",
"page",
"pageAmount"
],
"title": "Customer Settings Response",
"type": "object"
},
"postschema_6": {
"additionalProperties": false,
"description": "Post AWS integration request",
"properties": {
"name": {
"description": "Name of the new AWS integration.",
"example": "",
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"eventTypes": {
"description": "A list of event types",
"items": {
"$ref": "#/components/schemas/postschema_6_eventTypes_inner"
},
"minItems": 1,
"type": "array"
},
"jsonPayloadEnabled": {
"default": false,
"description": "Flag if the payloads of this integration should be bridged in JSON format.",
"example": true,
"type": "boolean"
}
},
"required": [
"eventTypes",
"name"
],
"title": "AWS Integration request",
"type": "object"
},
"postResponseschema_4": {
"additionalProperties": false,
"description": "Post AWS integration response",
"properties": {
"name": {
"description": "Name of the new AWS integration.",
"example": "",
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"eventTypes": {
"description": "A list of event types",
"items": {
"$ref": "#/components/schemas/postResponseschema_4_eventTypes_inner"
},
"minItems": 1,
"type": "array"
},
"state": {
"description": "State of the new AWS integration.",
"enum": [
"ROLLOUT_STARTED",
"ROLLOUT_DONE",
"ROLLOUT_FAILED",
"INTEGRATION_ACTIVE",
"INTEGRATION_FAILED"
],
"example": "ROLLOUT_STARTED",
"minLength": 1,
"type": "string"
},
"type": {
"description": "Type of the new integration.",
"enum": [
"AWS"
],
"example": "AWS",
"minLength": 1,
"type": "string"
},
"id": {
"description": "ID of the new AWS integration.",
"example": "",
"minLength": 1,
"type": "string"
},
"jwt": {
"description": "JWT token with details for integration stack creation",
"example": "",
"minLength": 1,
"type": "string"
},
"createdTime": {
"description": "Created timestamp of the AWS integration.",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"updatedTime": {
"description": "Updated timestamp of the AWS integration.",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"jsonPayloadEnabled": {
"default": false,
"description": "Flag if the payloads of this integration should be bridged in JSON format.",
"example": true,
"type": "boolean"
}
},
"required": [
"createdTime",
"eventTypes",
"id",
"jsonPayloadEnabled",
"jwt",
"name",
"state",
"type",
"updatedTime"
],
"title": "AWS Integration response",
"type": "object"
},
"getResponseschema_11": {
"description": "Get Integration response",
"properties": {
"id": {
"description": "Unique ID of the Integration",
"example": "2BLURnaUZSlbKp6vN1V5dYiJvC4",
"minLength": 1,
"type": "string"
},
"lastSuccessfulMessageDelivery": {
"description": "Timestamp of the first message successfully delivered to integration, in ISO 8601 format",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"name": {
"description": "name",
"example": "a-sample-integration-name",
"minLength": 1,
"type": "string"
},
"eventTypes": {
"description": "A list of event types",
"items": {
"$ref": "#/components/schemas/postResponseschema_4_eventTypes_inner"
},
"minItems": 1,
"type": "array"
},
"state": {
"description": "Current state of the Integration",
"enum": [
"ROLLOUT_STARTED",
"ROLLOUT_DONE",
"ROLLOUT_FAILED",
"INTEGRATION_FAILED",
"INTEGRATION_ACTIVE"
],
"type": "string"
},
"type": {
"description": "Type of the Integration",
"enum": [
"AWS",
"WEBHOOK"
],
"type": "string"
},
"awsAccountId": {
"description": "AWS Account Id where the stack was deployed, only showed when AWS Integration",
"example": "123456789012",
"type": "string"
},
"region": {
"description": "AWS Region where the stack was deployed, only showed when AWS Integration",
"example": "eu-central-1",
"type": "string"
},
"error": {
"description": "Last error either during the creation of the Integration or during some attempt to integrate",
"example": "some error has just happened",
"type": "string"
},
"jwt": {
"description": "JWT token with details for integration stack creation",
"example": "",
"minLength": 1,
"type": "string"
},
"createdTime": {
"description": "Created timestamp of Integration",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"updatedTime": {
"description": "Updated timestamp of Integration",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"url": {
"description": "URL of the Webhook Integration",
"example": "https://example.com",
"format": "uri",
"minLength": 1,
"type": "string"
},
"headers": {
"description": "Headers of the Webhook Integration",
"type": "object"
},
"jsonPayloadEnabled": {
"default": false,
"description": "Flag if the payloads of this integration should be bridged in JSON format.",
"example": true,
"type": "boolean"
}
},
"required": [
"createdTime",
"eventTypes",
"id",
"jsonPayloadEnabled",
"name",
"state",
"type",
"updatedTime"
],
"title": "Get Integration Response",
"type": "object"
},
"patchschema_3": {
"additionalProperties": false,
"description": "Patch integration request",
"properties": {
"url": {
"description": "URL of the webhook (HTTPS required)",
"example": "https://www.example.com",
"format": "uri",
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"description": "Headers that should be sent to the webhook. Only string values and no nested objects",
"type": "object"
},
"eventTypes": {
"description": "A list of all event types",
"items": {
"$ref": "#/components/schemas/patchschema_3_eventTypes_inner"
},
"minItems": 1,
"type": "array"
},
"jsonPayloadEnabled": {
"description": "Flag if the payloads of this integration should be bridged in JSON format.",
"example": true,
"type": "boolean"
}
},
"title": "Integration request",
"type": "object"
},
"patchResponseschema_1": {
"additionalProperties": false,
"description": "Patch integration response",
"properties": {
"name": {
"description": "Name of the integration.",
"example": "",
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"eventTypes": {
"description": "A list of event types",
"items": {
"$ref": "#/components/schemas/postResponseschema_4_eventTypes_inner"
},
"minItems": 1,
"type": "array"
},
"state": {
"description": "State of the integration.",
"enum": [
"ROLLOUT_STARTED",
"ROLLOUT_DONE",
"ROLLOUT_FAILED",
"INTEGRATION_ACTIVE",
"INTEGRATION_FAILED"
],
"example": "ROLLOUT_DONE",
"minLength": 1,
"type": "string"
},
"type": {
"description": "Type of the integration.",
"enum": [
"WEBHOOK",
"AWS"
],
"example": "WEBHOOK",
"minLength": 1,
"type": "string"
},
"id": {
"description": "ID of the integration.",
"example": "",
"minLength": 1,
"type": "string"
},
"createdTime": {
"description": "Created timestamp of the integration.",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"updatedTime": {
"description": "Updated timestamp of the integration.",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"awsAccountId": {
"description": "AWS Account Id where the stack was deployed, only showed when AWS Integration",
"example": "123456789012",
"type": "string"
},
"region": {
"description": "AWS Region where the stack was deployed, only showed when AWS Integration",
"example": "eu-central-1",
"type": "string"
},
"jwt": {
"description": "JWT token with details for integration stack creation",
"example": "",
"minLength": 1,
"type": "string"
},
"headers": {
"description": "Headers of the integration.",
"type": "object"
},
"url": {
"description": "URL of the integration.",
"example": "https://example.com",
"format": "uri",
"minLength": 1,
"type": "string"
},
"jsonPayloadEnabled": {
"default": false,
"description": "Flag if the payloads of this integration should be bridged in JSON format.",
"example": true,
"type": "boolean"
}
},
"required": [
"createdTime",
"eventTypes",
"id",
"jsonPayloadEnabled",
"name",
"state",
"type",
"updatedTime"
],
"title": "Integration response",
"type": "object"
},
"getAllResponseschema_5": {
"description": "Get a list of Integrations",
"properties": {
"items": {
"description": "List of Integrations",
"items": {
"$ref": "#/components/schemas/getAllResponseschema_5_items_inner"
},
"type": "array"
},
"page": {
"description": "Current page number",
"example": 1,
"minimum": 1,
"type": "number"
},
"pageAmount": {
"description": "Total number of pages",
"example": 2,
"minimum": 1,
"type": "number"
}
},
"required": [
"items",
"page",
"pageAmount"
],
"title": "Get a list of Integrations",
"type": "object"
},
"getEventTypesResponseschema": {
"description": "Get all event types response",
"properties": {
"eventTypes": {
"description": "List of event types",
"items": {
"$ref": "#/components/schemas/getEventTypesResponseschema_eventTypes_inner"
},
"type": "array"
}
},
"required": [
"eventTypes"
],
"title": "Get Event Types Response",
"type": "object"
},
"postschema_7": {
"additionalProperties": false,
"description": "Post Webhook integration request",
"properties": {
"name": {
"description": "Name of the new Webhook integration",
"example": "",
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"url": {
"description": "URL of the webhook (HTTPS required)",
"example": "https://www.example.com",
"format": "uri",
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"description": "Headers that should be sent to the webhook. Only string values and no nested objects",
"type": "object"
},
"eventTypes": {
"description": "A list of event types",
"items": {
"$ref": "#/components/schemas/postschema_6_eventTypes_inner"
},
"minItems": 1,
"type": "array"
},
"jsonPayloadEnabled": {
"default": false,
"description": "Flag if the payloads of this integration should be bridged in JSON format.",
"example": true,
"type": "boolean"
}
},
"required": [
"eventTypes",
"headers",
"name",
"url"
],
"title": "Webhook Integration request",
"type": "object"
},
"postResponseschema_5": {
"additionalProperties": false,
"description": "Post Webhook integration response",
"properties": {
"name": {
"description": "Name of the new Webhook integration.",
"example": "",
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"eventTypes": {
"description": "A list of event types",
"items": {
"$ref": "#/components/schemas/postResponseschema_4_eventTypes_inner"
},
"minItems": 1,
"type": "array"
},
"state": {
"description": "State of the new Webhook integration.",
"enum": [
"ROLLOUT_DONE",
"INTEGRATION_ACTIVE",
"INTEGRATION_FAILED"
],
"example": "ROLLOUT_DONE",
"minLength": 1,
"type": "string"
},
"type": {
"description": "Type of the new integration.",
"enum": [
"WEBHOOK"
],
"example": "WEBHOOK",
"minLength": 1,
"type": "string"
},
"id": {
"description": "ID of the new Webhook integration.",
"example": "",
"minLength": 1,
"type": "string"
},
"createdTime": {
"description": "Created timestamp of the Webhook integration.",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"updatedTime": {
"description": "Updated timestamp of the Webhook integration.",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"headers": {
"description": "Headers of the new Webhook integration.",
"type": "object"
},
"url": {
"description": "URL of the new Webhook integration.",
"example": "https://example.com",
"format": "uri",
"minLength": 1,
"type": "string"
},
"jsonPayloadEnabled": {
"default": false,
"description": "Flag if the payloads of this integration should be bridged in JSON format.",
"example": true,
"type": "boolean"
}
},
"required": [
"createdTime",
"eventTypes",
"headers",
"id",
"jsonPayloadEnabled",
"name",
"state",
"type",
"updatedTime",
"url"
],
"title": "Webhook Integration response",
"type": "object"
},
"patchschema_4": {
"additionalProperties": false,
"description": "Patch Webhook integration request",
"properties": {
"url": {
"description": "URL of the webhook (HTTPS required)",
"example": "https://www.example.com",
"format": "uri",
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"description": "Headers that should be sent to the webhook. Only string values and no nested objects",
"type": "object"
},
"eventTypes": {
"description": "A list of all event types",
"items": {
"$ref": "#/components/schemas/patchschema_3_eventTypes_inner"
},
"minItems": 1,
"type": "array"
},
"jsonPayloadEnabled": {
"description": "Flag if the payloads of this integration should be bridged in JSON format.",
"example": true,
"type": "boolean"
}
},
"title": "WebhookIntegration request",
"type": "object"
},
"patchResponseschema_2": {
"additionalProperties": false,
"description": "Patch Webhook integration response",
"properties": {
"name": {
"description": "Name of the integration.",
"example": "",
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"eventTypes": {
"description": "A list of event types",
"items": {
"$ref": "#/components/schemas/postResponseschema_4_eventTypes_inner"
},
"minItems": 1,
"type": "array"
},
"state": {
"description": "State of the integration.",
"enum": [
"ROLLOUT_DONE",
"INTEGRATION_ACTIVE",
"INTEGRATION_FAILED"
],
"example": "ROLLOUT_DONE",
"minLength": 1,
"type": "string"
},
"type": {
"description": "Type of the integration.",
"enum": [
"WEBHOOK"
],
"example": "WEBHOOK",
"minLength": 1,
"type": "string"
},
"id": {
"description": "ID of the integration.",
"example": "",
"minLength": 1,
"type": "string"
},
"createdTime": {
"description": "Created timestamp of the integration.",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"updatedTime": {
"description": "Updated timestamp of the integration.",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"headers": {
"description": "Headers of the integration.",
"type": "object"
},
"url": {
"description": "URL of the integration.",
"example": "https://example.com",
"format": "uri",
"minLength": 1,
"type": "string"
},
"jsonPayloadEnabled": {
"default": false,
"description": "Flag if the payloads of this integration should be bridged in JSON format.",
"example": true,
"type": "boolean"
}
},
"required": [
"createdTime",
"eventTypes",
"headers",
"id",
"jsonPayloadEnabled",
"name",
"state",
"type",
"updatedTime",
"url"
],
"title": "Webhook Integration response",
"type": "object"
},
"postResponseschema_6": {
"additionalProperties": false,
"description": "Post Webhook integration restart response",
"properties": {
"integration": {
"$ref": "#/components/schemas/postResponseschema_6_integration"
},
"restartStatus": {
"description": "Webhook integration restart status.",
"enum": [
"SUCCESS",
"FAILURE"
],
"example": "SUCCESS",
"type": "string"
},
"message": {
"description": "Webhook integration restart message.",
"example": "Restart was successful",
"minLength": 1,
"type": "string"
}
},
"required": [
"integration",
"message",
"restartStatus"
],
"title": "Webhook Integration restart response",
"type": "object"
},
"postResponseschema_7": {
"additionalProperties": false,
"description": "Post Webhook integration test response",
"properties": {
"testStatus": {
"description": "Webhook integration test status.",
"enum": [
"SUCCESS",
"FAILURE"
],
"example": "SUCCESS",
"type": "string"
},
"message": {
"description": "Webhook integration test message.",
"example": "Test was successful",
"minLength": 1,
"type": "string"
}
},
"required": [
"message",
"testStatus"
],
"title": "Webhook Integration test response",
"type": "object"
},
"postschema_8": {
"additionalProperties": false,
"description": "A request to install the Datacake plugin for 1NCE OS.",
"properties": {
"workspaceId": {
"description": "Datacake workspace ID",
"example": "abcdef12-0000-0000-ab12-123456789012",
"maxLength": 64,
"minLength": 1,
"pattern": "^[-A-Za-z0-9()@:%_+.~#?&/=]*$",
"type": "string"
}
},
"required": [
"workspaceId"
],
"title": "Datacake plugin installation",
"type": "object"
},
"postResponseschema_8": {
"additionalProperties": false,
"description": "Response to the Datacake plugin installation request.",
"properties": {
"id": {
"description": "Plugin installation identifier",
"example": "mo3--1DzmAgO-X777AY9h",
"type": "string"
},
"partner": {
"description": "Partner name",
"example": "DATACAKE",
"type": "string"
},
"created": {
"description": "Plugin installation timestamp",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"updated": {
"description": "Plugin installation update timestamp",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Status of the plugin installation",
"example": "INSTALLED",
"type": "string"
},
"workspaceId": {
"description": "Datacake workspace ID of the plugin",
"example": "abcdef12-0000-0000-ab12-123456789012",
"type": "string"
}
},
"required": [
"created",
"id",
"partner",
"status",
"updated",
"workspaceId"
],
"title": "Plugin installation response",
"type": "object"
},
"postschema_9": {
"additionalProperties": false,
"description": "A request to install the Mender plugin for 1NCE OS.",
"properties": {
"tenantToken": {
"description": "Mender tenant token",
"maxLength": 800,
"minLength": 1,
"type": "string"
},
"privateKey": {
"description": "Mender private key",
"maxLength": 3000,
"minLength": 1,
"type": "string"
},
"publicKey": {
"description": "Mender public key",
"maxLength": 1000,
"minLength": 1,
"type": "string"
}
},
"required": [
"tenantToken"
],
"title": "Mender plugin installation",
"type": "object"
},
"postResponseschema_9": {
"additionalProperties": false,
"description": "Response to the Mender plugin installation request.",
"properties": {
"id": {
"description": "Plugin installation identifier",
"example": "mo3--1DzmAgO-X777AY9h",
"type": "string"
},
"partner": {
"description": "Partner name",
"example": "MENDER",
"type": "string"
},
"created": {
"description": "Plugin installation timestamp",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"updated": {
"description": "Plugin installation update timestamp",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Status of the plugin installation",
"example": "INSTALLED",
"type": "string"
},
"tenantToken": {
"description": "Mender tenant token",
"type": "string"
},
"privateKey": {
"description": "Mender private key",
"type": "string"
},
"publicKey": {
"description": "Mender public key",
"type": "string"
}
},
"required": [
"created",
"id",
"partner",
"privateKey",
"publicKey",
"status",
"tenantToken",
"updated"
],
"title": "Plugin installation response",
"type": "object"
},
"postschema_10": {
"additionalProperties": false,
"description": "A request to install the Tartabit plugin for 1NCE OS.",
"properties": {
"serverDomain": {
"description": "Tartabit IoT Bridge host domain. Must be a valid hostname.",
"maxLength": 253,
"minLength": 1,
"pattern": "^[-A-Za-z0-9@:%.+~#=]{1,256}.[a-zA-Z0-9()]+\\b([-A-Za-z0-9()@:%+.~#?&\\/=]*)$",
"type": "string"
},
"webhookKey": {
"description": "Webhook Secret from service specification in Tartabit IoT Bridge. Must contain valid uri characters.",
"maxLength": 40,
"minLength": 1,
"pattern": "^[A-Za-z0-9()]+\\b([-A-Za-z0-9()@:%_+.~#?&\\/=]*)$",
"type": "string"
}
},
"required": [
"serverDomain",
"webhookKey"
],
"title": "Tartabit plugin installation",
"type": "object"
},
"postResponseschema_10": {
"additionalProperties": false,
"description": "Response to the Tartabit plugin installation request.",
"properties": {
"id": {
"description": "Plugin installation identifier",
"example": "mo3--1DzmAgO-X777AY9h",
"type": "string"
},
"partner": {
"description": "Partner name",
"example": "TARTABIT",
"type": "string"
},
"created": {
"description": "Plugin installation timestamp",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"updated": {
"description": "Plugin installation update timestamp",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Status of the plugin installation",
"example": "INSTALLED",
"type": "string"
},
"serverDomain": {
"description": "Tartabit IoT Bridge host domain",
"type": "string"
},
"webhookKey": {
"description": "Webhook Secret from service specification in Tartabit IoT Bridge.",
"type": "string"
}
},
"required": [
"created",
"id",
"partner",
"serverDomain",
"status",
"updated",
"webhookKey"
],
"title": "Plugin installation response",
"type": "object"
},
"postschema_11": {
"additionalProperties": false,
"description": "A request to install the Memfault plugin for 1NCE OS.",
"properties": {},
"title": "Memfault plugin installation",
"type": "object"
},
"postResponseschema_11": {
"additionalProperties": false,
"description": "Response to the Memfault plugin installation request.",
"properties": {
"id": {
"description": "Plugin installation identifier",
"example": "mo3--1DzmAgO-X777AY9h",
"type": "string"
},
"partner": {
"description": "Partner name",
"example": "MEMFAULT",
"type": "string"
},
"created": {
"description": "Plugin installation timestamp",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"updated": {
"description": "Plugin installation update timestamp",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Status of the plugin installation",
"example": "INSTALLED",
"type": "string"
}
},
"required": [
"created",
"id",
"partner",
"status",
"updated"
],
"title": "Plugin installation response",
"type": "object"
},
"getResponseschema_12": {
"additionalProperties": false,
"description": "Plugin installation details by ID request. Also contains Datacake specific fields.",
"properties": {
"id": {
"description": "Plugin installation identifier",
"example": "mo3--1DzmAgO-X777AY9h",
"type": "string"
},
"partner": {
"description": "Partner name",
"example": "PLUGIN-PARTNER",
"type": "string"
},
"created": {
"description": "Plugin installation timestamp",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"updated": {
"description": "Plugin installation update timestamp",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Status of the plugin installation",
"example": "INSTALLED",
"type": "string"
},
"workspaceId": {
"description": "Datacake workspace ID of the plugin",
"example": "abcdef12-0000-0000-ab12-123456789012",
"type": "string"
}
},
"required": [
"created",
"id",
"partner",
"status",
"updated",
"workspaceId"
],
"title": "Datacake plugin details",
"type": "object"
},
"getResponseschema_13": {
"additionalProperties": false,
"description": "Plugin installation details by ID request. Also contains Mender specific fields.",
"properties": {
"id": {
"description": "Plugin installation identifier",
"example": "mo3--1DzmAgO-X777AY9h",
"type": "string"
},
"partner": {
"description": "Partner name",
"example": "PLUGIN-PARTNER",
"type": "string"
},
"created": {
"description": "Plugin installation timestamp",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"updated": {
"description": "Plugin installation update timestamp",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Status of the plugin installation",
"example": "INSTALLED",
"type": "string"
},
"tenantToken": {
"description": "Mender tenant token",
"type": "string"
},
"privateKey": {
"description": "Mender private key",
"type": "string"
},
"publicKey": {
"description": "Mender public key",
"type": "string"
}
},
"required": [
"created",
"id",
"partner",
"privateKey",
"publicKey",
"status",
"tenantToken",
"updated"
],
"title": "Mender plugin details",
"type": "object"
},
"getResponseschema_14": {
"additionalProperties": false,
"description": "Plugin installation details by ID request. Also contains Tartabit specific fields.",
"properties": {
"id": {
"description": "Plugin installation identifier",
"example": "mo3--1DzmAgO-X777AY9h",
"type": "string"
},
"partner": {
"description": "Partner name",
"example": "PLUGIN-PARTNER",
"type": "string"
},
"created": {
"description": "Plugin installation timestamp",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"updated": {
"description": "Plugin installation update timestamp",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Status of the plugin installation",
"example": "INSTALLED",
"type": "string"
},
"serverDomain": {
"description": "Tartabit IoT Bridge host domain",
"type": "string"
},
"webhookKey": {
"description": "Webhook Secret from service specification in Tartabit IoT Bridge.",
"type": "string"
}
},
"required": [
"created",
"id",
"partner",
"serverDomain",
"status",
"updated",
"webhookKey"
],
"title": "Tartabit plugin details",
"type": "object"
},
"getResponseschema_15": {
"additionalProperties": false,
"description": "Plugin installation details by plugin ID. Also contains Memfault specific fields.",
"properties": {
"id": {
"description": "Plugin installation identifier",
"example": "mo3--1DzmAgO-X777AY9h",
"type": "string"
},
"partner": {
"description": "Partner name",
"example": "MEMFAULT",
"type": "string"
},
"created": {
"description": "Plugin installation timestamp",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"updated": {
"description": "Plugin installation update timestamp",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Status of the plugin installation",
"example": "INSTALLED",
"type": "string"
},
"email": {
"description": "The email address used to create Memfault organization and to login to the Memfault frontend",
"example": "john.doe@user.com",
"type": "string"
},
"url": {
"description": "The Memfault login URL address",
"example": "https://app.memfault.com/invites/.eJyrVkrNTczr4sdfsd",
"type": "string"
},
"memfaultProjectId": {
"description": "Project id which is saved in the Memfault System",
"example": "34324-5434533fddgesdf-2sfdfsdfsf",
"type": "string"
}
},
"required": [
"created",
"email",
"id",
"memfaultProjectId",
"partner",
"status",
"updated",
"url"
],
"title": "Memfault plugin details",
"type": "object"
},
"restartResponseschema": {
"additionalProperties": false,
"description": "Response to the plugin installation details by ID request.",
"properties": {
"plugin": {
"$ref": "#/components/schemas/restartResponseschema_plugin"
},
"restartStatus": {
"description": "Restart action status",
"enum": [
"SUCCESS",
"FAILURE"
],
"example": "SUCCESS",
"type": "string"
},
"message": {
"description": "Restart action detail message",
"example": "Restart was successful",
"type": "string"
}
},
"required": [
"message",
"plugin",
"restartStatus"
],
"title": "Get plugin details by ID response",
"type": "object"
},
"getAllResponseschema_6": {
"additionalProperties": false,
"description": "List of Plugin installations",
"properties": {
"items": {
"description": "List of Plugins",
"items": {
"$ref": "#/components/schemas/getAllResponseschema_6_items_inner"
},
"type": "array"
},
"page": {
"description": "Current page number.",
"example": 1,
"minimum": 1,
"type": "number"
},
"pageAmount": {
"description": "Total number of pages.",
"example": 2,
"minimum": 1,
"type": "number"
}
},
"required": [
"items",
"page",
"pageAmount"
],
"title": "List of Plugins",
"type": "object"
},
"badRequestResponse": {
"description": "An API error response in case of an HTTP Bad Request.",
"properties": {
"statusCode": {
"description": "HTTP Response Code",
"example": 400,
"type": "integer"
},
"statusText": {
"description": "HTTP Status Text",
"enum": [
"Bad Request"
],
"type": "string"
},
"errors": {
"description": "Detailed error information.",
"items": {
"type": "object"
},
"type": "array"
}
},
"title": "Bad Request",
"type": "object"
},
"notFoundResponse": {
"description": "An API error response when a resource is Not Found.",
"properties": {
"statusCode": {
"description": "HTTP Response Code",
"example": 404,
"type": "integer"
},
"statusText": {
"description": "HTTP Status Text",
"enum": [
"Not Found"
],
"type": "string"
},
"errors": {
"description": "Detailed error information",
"items": {
"type": "object"
},
"type": "array"
}
},
"title": "Not Found",
"type": "object"
},
"serverErrorResponse": {
"description": "An API error response in case of a Server Side Error.",
"properties": {
"statusText": {
"description": "HTTP Status Text",
"enum": [
"Unknown Error",
"Server Error"
],
"type": "string"
},
"errors": {
"description": "List of errors encountered while calling the API.",
"items": {
"type": "object"
},
"type": "array"
}
},
"title": "Server Error",
"type": "object"
},
"forbiddenResponse": {
"description": "An API error response in case of an HTTP Forbidden Request.",
"properties": {
"statusCode": {
"description": "HTTP Response Code",
"example": 403,
"type": "integer"
},
"statusText": {
"description": "HTTP Status Text",
"enum": [
"Forbidden"
],
"type": "string"
},
"errors": {
"description": "Detailed error information.",
"items": {
"type": "object"
},
"type": "array"
}
},
"title": "Forbidden Request",
"type": "object"
},
"unauthorizedRequestResponse": {
"description": "An API error response in case of an HTTP Unauthorized Request.",
"properties": {
"statusCode": {
"description": "HTTP Response Code",
"example": 401,
"type": "integer"
},
"statusText": {
"description": "HTTP Status Text",
"enum": [
"Unauthorized"
],
"type": "string"
},
"errors": {
"description": "Detailed error information.",
"items": {
"type": "object"
},
"type": "array"
}
},
"title": "Unauthorized Request",
"type": "object"
},
"unprocessableEntityResponse": {
"description": "An API error response when the request is valid but cannot be processed.",
"properties": {
"statusCode": {
"description": "HTTP Response Code",
"example": 422,
"type": "integer"
},
"statusText": {
"description": "HTTP Status Text",
"enum": [
"Unprocessable Entity"
],
"type": "string"
},
"errors": {
"description": "Detailed error information.",
"items": {
"type": "object"
},
"type": "array"
}
},
"title": "Unprocessable Entity",
"type": "object"
},
"conflictResponse": {
"description": "An API error response when a conflict is found.",
"properties": {
"statusCode": {
"description": "HTTP Response Code",
"example": 409,
"type": "integer"
},
"statusText": {
"description": "Http Status Text",
"enum": [
"Conflict"
],
"type": "string"
},
"errors": {
"description": "Detailed error information.",
"items": {
"type": "object"
},
"type": "array"
}
},
"title": "Conflict",
"type": "object"
},
"GenericGeofenceData": {
"properties": {
"id": {
"$ref": "#/components/schemas/Id"
},
"name": {
"$ref": "#/components/schemas/Name"
},
"created": {
"$ref": "#/components/schemas/Created"
},
"updated": {
"$ref": "#/components/schemas/Updated"
},
"deviceId": {
"$ref": "#/components/schemas/DeviceId"
},
"type": {
"$ref": "#/components/schemas/Type"
}
},
"required": [
"created",
"deviceId",
"id",
"name",
"type",
"updated"
],
"type": "object"
},
"Id": {
"description": "Identifier of the geofence",
"type": "string"
},
"Name": {
"description": "The name of the geofence",
"maxLength": 50,
"type": "string"
},
"Created": {
"description": "When the Geofence was created",
"format": "date-time",
"type": "string"
},
"Updated": {
"description": "When the Geofence was last updated",
"format": "date-time",
"type": "string"
},
"DeviceId": {
"description": "The device for which this Geofence is bound to"
},
"Type": {
"description": "The type of Geofence",
"enum": [
"polygon",
"circle"
],
"type": "string"
},
"CreatePolygonGeofence": {
"additionalProperties": false,
"properties": {
"name": {
"$ref": "#/components/schemas/Name"
},
"eventTypes": {
"$ref": "#/components/schemas/EventTypes"
},
"eventSources": {
"$ref": "#/components/schemas/EventSources"
},
"deviceId": {
"$ref": "#/components/schemas/DeviceId"
},
"type": {
"description": "The type of geofence",
"type": "string"
},
"coordinates": {
"$ref": "#/components/schemas/Coordinates"
}
},
"required": [
"coordinates",
"name",
"type"
],
"type": "object"
},
"EventTypes": {
"description": "The event types to register to. Defaults to [ENTER, EXIT]",
"items": {
"enum": [
"ENTER",
"EXIT"
],
"type": "string"
},
"maxItems": 2,
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"EventSources": {
"description": "The sources of coordinates to evaluate towards geofence. Defaults to [GPS, CellTower]",
"items": {
"enum": [
"CellTower",
"GPS"
],
"type": "string"
},
"maxItems": 2,
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"Coordinates": {
"description": "The polygon geofence coordinates",
"items": {
"items": {
"description": "Coordinates (long, lat)",
"items": {
"type": "number"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"minItems": 4,
"type": "array"
},
"minItems": 1,
"type": "array"
},
"CreateCircleGeofence": {
"additionalProperties": false,
"properties": {
"name": {
"$ref": "#/components/schemas/Name"
},
"eventTypes": {
"$ref": "#/components/schemas/EventTypes"
},
"eventSources": {
"$ref": "#/components/schemas/EventSources"
},
"deviceId": {
"$ref": "#/components/schemas/DeviceId"
},
"type": {
"description": "The type of geofence",
"type": "string"
},
"radius": {
"$ref": "#/components/schemas/Radius"
},
"center": {
"$ref": "#/components/schemas/Center"
}
},
"required": [
"name",
"radius",
"type"
],
"type": "object"
},
"Radius": {
"description": "Circle geofence radius in meters",
"maximum": 30000,
"minimum": 50,
"type": "number"
},
"Center": {
"description": "The coordinates of the center of the geofence (long, lat)",
"items": {
"type": "number"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"PolygonGeofenceData": {
"additionalProperties": false,
"properties": {
"id": {
"$ref": "#/components/schemas/Id"
},
"name": {
"$ref": "#/components/schemas/Name"
},
"created": {
"$ref": "#/components/schemas/Created"
},
"updated": {
"$ref": "#/components/schemas/Updated"
},
"deviceId": {
"$ref": "#/components/schemas/DeviceId"
},
"eventTypes": {
"$ref": "#/components/schemas/EventTypes"
},
"eventSources": {
"$ref": "#/components/schemas/EventSources"
},
"type": {
"description": "The type of geofence",
"type": "string"
},
"coordinates": {
"$ref": "#/components/schemas/Coordinates"
}
},
"required": [
"coordinates",
"created",
"deviceId",
"eventSources",
"eventTypes",
"id",
"name",
"type",
"updated"
],
"type": "object"
},
"CircleGeofenceData": {
"additionalProperties": false,
"properties": {
"id": {
"$ref": "#/components/schemas/Id"
},
"name": {
"$ref": "#/components/schemas/Name"
},
"created": {
"$ref": "#/components/schemas/Created"
},
"updated": {
"$ref": "#/components/schemas/Updated"
},
"deviceId": {
"$ref": "#/components/schemas/DeviceId"
},
"eventTypes": {
"$ref": "#/components/schemas/EventTypes"
},
"eventSources": {
"$ref": "#/components/schemas/EventSources"
},
"type": {
"description": "The type of geofence",
"type": "string"
},
"radius": {
"$ref": "#/components/schemas/Radius"
},
"center": {
"$ref": "#/components/schemas/Center"
}
},
"required": [
"center",
"created",
"deviceId",
"eventSources",
"eventTypes",
"id",
"name",
"radius",
"type",
"updated"
],
"type": "object"
},
"_v1_partners_plugins__pluginId__get_200_response": {
"oneOf": [
{
"$ref": "#/components/schemas/getResponseschema_12"
},
{
"$ref": "#/components/schemas/getResponseschema_13"
},
{
"$ref": "#/components/schemas/getResponseschema_14"
},
{
"$ref": "#/components/schemas/getResponseschema_15"
}
]
},
"getAllResponseschema_items_inner": {
"properties": {
"protocol": {
"description": "The protocol of the endpoint.",
"example": "COAP",
"type": "string"
},
"active": {
"description": "The current status of the endpoint.",
"example": true,
"type": "boolean"
},
"domain": {
"description": "The domain of the endpoint.",
"example": "coap.os.1nce.com",
"type": "string"
},
"ipAddresses": {
"items": {
"description": "The public IP addresses of the endpoint.",
"example": "127.0.0.1",
"type": "string"
},
"type": "array"
},
"port": {
"description": "The port of the endpoint.",
"example": 5683,
"type": "number"
},
"securePort": {
"description": "The port of the endpoint.",
"example": 5684,
"type": "number"
}
},
"required": [
"active",
"domain",
"ipAddresses",
"port",
"protocol"
],
"type": "object"
},
"getResponseschema_settings_inner": {
"properties": {
"name": {
"description": "Name of the setting.",
"example": "LWM2M_PASSIVE_REPORTING",
"type": "string"
},
"state": {
"description": "State of the setting.",
"enum": [
"ENABLED",
"DISABLED"
],
"example": "ENABLED",
"type": "string"
},
"description": {
"description": "Description of the setting.",
"example": "This is an example description of a setting",
"type": "string"
}
},
"required": [
"name",
"state"
],
"type": "object"
},
"patchschema_settings_inner": {
"properties": {
"name": {
"description": "Name of the setting.",
"enum": [
"LWM2M_PASSIVE_REPORTING"
],
"type": "string"
},
"state": {
"description": "State of the setting.",
"enum": [
"ENABLED",
"DISABLED"
],
"example": "ENABLED",
"type": "string"
}
},
"required": [
"name",
"state"
],
"type": "object"
},
"getAllResponseschema_1_items_inner": {
"additionalProperties": false,
"properties": {
"id": {
"description": "The ID of the request.",
"example": "",
"type": "string"
},
"status": {
"description": "The status of the request.",
"enum": [
"SCHEDULED",
"IN_PROGRESS",
"FAILED",
"SUCCEEDED",
"CANCELLED"
],
"example": "IN_PROGRESS",
"type": "string"
},
"deviceId": {
"description": "The unique ID of the device.",
"example": "",
"type": "string"
},
"ip": {
"description": "The IP address of the device.",
"example": "x.x.x.x",
"type": "string"
},
"protocol": {
"description": "The protocol of the request.",
"example": "LWM2M",
"type": "string"
},
"created": {
"description": "The timestamp at which the request was created.",
"format": "date-time",
"type": "string"
},
"updated": {
"description": "The timestamp at which the request was updated.",
"format": "date-time",
"type": "string"
},
"mode": {
"description": "The mode of the request.",
"enum": [
"SEND_NOW",
"SEND_WHEN_ACTIVE"
],
"example": "SEND_NOW",
"type": "string"
},
"resultData": {
"description": "Result data (can include response from device etc.).",
"type": "object"
},
"requestData": {
"description": "Protocol specific request data.",
"type": "object"
},
"sendAttemptsLeft": {
"description": "How many attempts are left to send data to the device",
"example": 1,
"maximum": 5,
"minimum": 0,
"type": "number"
},
"sendAttempts": {
"description": "The maximum number of attempts to send data to a device",
"example": 3,
"maximum": 5,
"minimum": 1,
"type": "number"
}
},
"required": [
"created",
"deviceId",
"id",
"ip",
"mode",
"protocol",
"status",
"updated"
],
"type": "object"
},
"getActiveResponseschema_items_inner": {
"additionalProperties": false,
"properties": {
"id": {
"description": "The ID of the request.",
"example": "",
"type": "string"
},
"status": {
"description": "The status of the request.",
"enum": [
"SCHEDULED",
"IN_PROGRESS"
],
"example": "IN_PROGRESS",
"type": "string"
},
"deviceId": {
"description": "The unique ID of the device.",
"example": "",
"type": "string"
},
"ip": {
"description": "The IP address of the device.",
"example": "x.x.x.x",
"type": "string"
},
"protocol": {
"description": "The protocol of the request.",
"enum": [
"UDP",
"COAP",
"LWM2M"
],
"example": "LWM2M",
"type": "string"
},
"created": {
"description": "The timestamp at which the request was created.",
"format": "date-time",
"type": "string"
},
"updated": {
"description": "The timestamp at which the request was updated.",
"format": "date-time",
"type": "string"
},
"mode": {
"description": "The mode of the request.",
"enum": [
"SEND_NOW",
"SEND_WHEN_ACTIVE"
],
"example": "SEND_NOW",
"type": "string"
},
"resultData": {
"description": "Result data (can include response from device etc.).",
"type": "object"
},
"requestData": {
"description": "Protocol specific request data.",
"type": "object"
},
"sendAttemptsLeft": {
"description": "How many attempts are left to send data to the device",
"example": 1,
"maximum": 5,
"minimum": 0,
"type": "number"
},
"sendAttempts": {
"description": "The maximum number of attempts to send data to a device",
"example": 3,
"maximum": 5,
"minimum": 1,
"type": "number"
}
},
"required": [
"created",
"deviceId",
"id",
"ip",
"mode",
"protocol",
"status",
"updated"
],
"type": "object"
},
"getArchivedResponseschema_items_inner": {
"additionalProperties": false,
"properties": {
"id": {
"description": "The ID of the request.",
"example": "",
"type": "string"
},
"status": {
"description": "The status of the request.",
"enum": [
"FAILED",
"SUCCEEDED",
"CANCELLED"
],
"example": "SUCCEEDED",
"type": "string"
},
"deviceId": {
"description": "The unique ID of the device.",
"example": "",
"type": "string"
},
"ip": {
"description": "The IP address of the device.",
"example": "x.x.x.x",
"type": "string"
},
"protocol": {
"description": "The protocol of the request.",
"enum": [
"UDP",
"COAP",
"LWM2M"
],
"example": "LWM2M",
"type": "string"
},
"created": {
"description": "The timestamp at which the request was created.",
"format": "date-time",
"type": "string"
},
"updated": {
"description": "The timestamp at which the request was updated.",
"format": "date-time",
"type": "string"
},
"mode": {
"description": "The mode of the request.",
"enum": [
"SEND_NOW",
"SEND_WHEN_ACTIVE"
],
"example": "SEND_NOW",
"type": "string"
},
"resultData": {
"description": "Result data (can include response from device etc.).",
"type": "object"
},
"requestData": {
"description": "Protocol specific request data.",
"type": "object"
},
"sendAttemptsLeft": {
"description": "How many attempts are left to send data to the device",
"example": 1,
"maximum": 5,
"minimum": 0,
"type": "number"
},
"sendAttempts": {
"description": "The maximum number of attempts to send data to a device",
"example": 3,
"maximum": 5,
"minimum": 1,
"type": "number"
}
},
"required": [
"created",
"deviceId",
"id",
"ip",
"mode",
"protocol",
"status",
"updated"
],
"type": "object"
},
"deleteAllResponseschema_inner": {
"additionalProperties": false,
"properties": {
"id": {
"description": "The ID of the request.",
"example": "",
"type": "string"
},
"status": {
"description": "The status of the request.",
"enum": [
"CANCELLED"
],
"example": "CANCELLED",
"type": "string"
}
},
"required": [
"id",
"status"
],
"type": "object"
},
"getResponseschema_2_items_inner": {
"additionalProperties": false,
"properties": {
"id": {
"description": "The unique ID of the import job.",
"example": "",
"type": "string"
},
"createdAt": {
"description": "Time when job created",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"updatedAt": {
"description": "Time when job last updated",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Status of the job.",
"enum": [
"IN_PROGRESS",
"DONE"
],
"type": "string"
},
"amount": {
"description": "Total number of device PSK to import",
"example": 2,
"type": "number"
},
"failed": {
"description": "Number of device PSK imports failed",
"example": 1,
"type": "number"
},
"done": {
"description": "Number of device PSK imports succeeded",
"example": 1,
"type": "number"
}
},
"required": [
"amount",
"createdAt",
"done",
"failed",
"id",
"status",
"updatedAt"
],
"type": "object"
},
"postschema_inner": {
"additionalProperties": false,
"properties": {
"deviceId": {
"description": "The unique ID of the device.",
"example": "",
"type": "string"
},
"secretKey": {
"description": "Pre-shared secret key for a device.",
"example": "",
"maxLength": 128,
"minLength": 8,
"type": "string"
},
"protocol": {
"description": "Protocol PSK is applied for",
"enum": [
"COAP",
"LWM2M"
],
"type": "string"
},
"format": {
"description": "The format in which the secret key was provided.",
"enum": [
"STRING",
"HEX"
],
"type": "string"
}
},
"required": [
"deviceId",
"protocol",
"secretKey"
],
"type": "object"
},
"bulkPostResponseschema_acceptedRequests_inner": {
"properties": {
"deviceId": {
"description": "Id of the device.",
"example": "",
"type": "string"
},
"requestId": {
"description": "Id of the request.",
"example": "",
"type": "string"
}
},
"type": "object"
},
"getResponseschema_3_messagesTranslated": {
"additionalProperties": false,
"description": "Statistics about the number of messages translated.",
"properties": {
"value": {
"description": "The number of messages translated.",
"example": 1,
"type": "number"
},
"delta": {
"description": "The difference to the number of messages translated in the previous timeframe.",
"example": 1,
"type": "number"
}
},
"required": [
"delta",
"value"
],
"type": "object"
},
"getResponseschema_3_averageBytesReducedPerMessage": {
"additionalProperties": false,
"description": "Statistics about the average amount of bytes reduced per translated message.",
"properties": {
"value": {
"description": "The average amount of bytes reduced per translated message.",
"example": 1,
"type": "number"
},
"delta": {
"description": "The difference to the average amount of bytes reduced in the previous timeframe.",
"example": 1,
"type": "number"
}
},
"required": [
"delta",
"value"
],
"type": "object"
},
"getResponseschema_3_bytesSaved": {
"additionalProperties": false,
"description": "Statistics about the bytes reduced by using the translation templates.",
"properties": {
"value": {
"description": "The amount of bytes reduced by using the translation templates.",
"example": 1,
"type": "number"
},
"delta": {
"description": "The difference to the amount of bytes reduced in the previous timeframe.",
"example": 1,
"type": "number"
}
},
"required": [
"delta",
"value"
],
"type": "object"
},
"getCloudFormationParameters_awsIntegration_inner": {
"properties": {
"version": {
"description": "The specific version of a template.",
"example": "v2.1",
"type": "string"
},
"url": {
"description": "The resource URL to the template.",
"example": "",
"type": "string"
}
},
"required": [
"url",
"version"
],
"type": "object"
},
"postResponseschema_2_integration_eventTypes_inner": {
"properties": {
"type": {
"description": "Name of the event type",
"enum": [
"TELEMETRY_DATA",
"LIFECYCLE",
"ERROR",
"GEOFENCE",
"LOCATION"
],
"example": "TELEMETRY_DATA",
"type": "string"
},
"version": {
"description": "Version of the event type",
"example": "1.0.0",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"postResponseschema_2_integration": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the AWS integration.",
"example": "",
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"state": {
"description": "State of the AWS integration.",
"enum": [
"ROLLOUT_STARTED",
"ROLLOUT_DONE",
"ROLLOUT_FAILED",
"INTEGRATION_ACTIVE",
"INTEGRATION_FAILED"
],
"example": "ROLLOUT_STARTED",
"type": "string"
},
"type": {
"description": "Type of the integration.",
"enum": [
"AWS"
],
"example": "AWS",
"type": "string"
},
"id": {
"description": "ID of the AWS integration.",
"example": "",
"minLength": 1,
"type": "string"
},
"createdTime": {
"description": "Created timestamp of the AWS integration.",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"updatedTime": {
"description": "Updated timestamp of the AWS integration.",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"lastSuccessfulMessageDelivery": {
"description": "Timestamp of the first message successfully delivered to integration, in ISO 8601 format",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"eventTypes": {
"description": "A list of event types",
"items": {
"$ref": "#/components/schemas/postResponseschema_2_integration_eventTypes_inner"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"createdTime",
"eventTypes",
"id",
"name",
"state",
"type",
"updatedTime"
],
"type": "object"
},
"getAdministrationLogsResponseschema_items_inner": {
"properties": {
"imsi": {
"description": "IMSI of the device.",
"example": "901405100000018",
"pattern": "^[0-9]{15}$",
"type": "string"
},
"payloadReference": {
"description": "A reference to the payload of the administration log.",
"example": "",
"type": "string"
},
"ip": {
"description": "The IP address of the device.",
"example": "x.x.x.x",
"type": "string"
},
"iccid": {
"description": "The ICCID of the SIM the administration log was caused by.",
"example": "8988280666000000000",
"pattern": "^[0-9]{19}$",
"type": "string"
},
"customerId": {
"description": "The ID of the customer organization.",
"example": "",
"type": "string"
},
"id": {
"description": "The ID of the administration log.",
"example": "",
"type": "string"
},
"timestamp": {
"description": "The timestamp at which the administration log was received by 1NCE.",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"category": {
"description": "The category of the administration log.",
"enum": [
"info",
"error"
],
"type": "string"
},
"type": {
"description": "The type of the administration log.",
"enum": [
"INTEGRATION",
"DEVICE",
"GENERAL",
"LOCATION",
"LIFECYCLE"
],
"type": "string"
},
"description": {
"description": "A description of the administration log.",
"example": "",
"type": "string"
},
"message": {
"description": "The message provided by the administration log.",
"example": "",
"type": "string"
},
"traceId": {
"description": "TraceId of the administration log.",
"example": "",
"type": "string"
},
"geofenceId": {
"description": "ID of the geofence.",
"example": "",
"type": "string"
},
"integrationId": {
"description": "ID of the Integration.",
"example": "",
"type": "string"
}
},
"required": [
"customerId",
"id",
"message",
"timestamp",
"type"
],
"type": "object"
},
"getAdministrationLogsStatisticsResponseschema_administrationLogs_inner": {
"properties": {
"day": {
"description": "The timestamp value of the day of the administration log.",
"example": "2022-03-07",
"format": "date",
"type": "string"
},
"amount": {
"description": "The amount of administration logs received on the specified day.",
"example": 2,
"type": "integer"
}
},
"required": [
"amount",
"day"
],
"type": "object"
},
"getTranslationTemplatesResponseschema_inner": {
"properties": {
"name": {
"description": "Name of the specific template.",
"example": "",
"maxLength": 64,
"minLength": 1,
"type": "string"
},
"template": {
"description": "A stringified JSON template.",
"example": "",
"minLength": 1,
"type": "string"
},
"status": {
"description": "The current status of the template.",
"example": "",
"type": "string"
},
"id": {
"description": "The unique ID of the template.",
"example": "",
"type": "string"
},
"protocolFilter": {
"default": "COAP",
"description": "Protocol filter that applies to this template. Only the listed protocols will be processed by the template.",
"example": "COAP",
"items": {
"enum": [
"COAP",
"UDP"
],
"type": "string"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"id",
"name",
"protocolFilter",
"status",
"template"
],
"type": "object"
},
"getAllResponseschema_2_items_inner": {
"properties": {
"id": {
"description": "Id of the device.",
"example": "",
"minLength": 1,
"type": "string"
},
"iccid": {
"description": "Iccid of the device.",
"example": "8988280666000000000",
"pattern": "^[0-9]{19}$",
"type": "string"
},
"imsi1": {
"description": "IMSI1 of the device.",
"example": "901405100000018",
"pattern": "^[0-9]{15}$",
"type": "string"
},
"ip": {
"description": "Ip of the device.",
"example": "x.x.x.x",
"format": "ipv4",
"type": "string"
}
},
"required": [
"iccid",
"id",
"imsi1",
"ip"
],
"type": "object"
},
"getResponseschema_6_items_inner": {
"additionalProperties": false,
"properties": {
"iccid": {
"description": "Iccid of the device.",
"example": "8988280666000000000",
"pattern": "^[0-9]{19}$",
"type": "string"
},
"time": {
"description": "Time when message was received.",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"payload": {
"description": "Stringified JSON object or base64 encoded string.",
"example": "",
"type": "string"
},
"protocol": {
"description": "The protocol used to communicate.",
"enum": [
"UDP",
"COAP",
"LWM2M"
],
"example": "COAP",
"type": "string"
},
"deviceId": {
"description": "The unique ID of the device.",
"example": "",
"type": "string"
},
"topic": {
"description": "The MQTT topic that was passed with the CoAP message (not present if no topic was set).",
"example": "topic",
"type": "string"
}
},
"required": [
"deviceId",
"iccid",
"payload",
"protocol",
"time"
],
"type": "object"
},
"getAllResponseschema_3_items_inner": {
"additionalProperties": false,
"properties": {
"iccid": {
"description": "Iccid of the device.",
"example": "8988280666000000000",
"pattern": "^[0-9]{19}$",
"type": "string"
},
"time": {
"description": "Time when message was received.",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"payload": {
"description": "Stringified JSON object or base64 encoded string.",
"example": "",
"type": "string"
},
"protocol": {
"description": "The protocol used to communicate.",
"enum": [
"UDP",
"COAP",
"LWM2M"
],
"example": "COAP",
"type": "string"
},
"deviceId": {
"description": "The unique ID of the device.",
"example": "",
"type": "string"
}
},
"required": [
"deviceId",
"iccid",
"payload",
"protocol",
"time"
],
"type": "object"
},
"getResponseschema_7_items_inner": {
"additionalProperties": false,
"properties": {
"time": {
"description": "Date of the device statistics.",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"protocol": {
"description": "Protocol of the message.",
"enum": [
"UDP",
"COAP",
"LWM2M"
],
"example": "COAP",
"type": "string"
},
"amount": {
"description": "Amount of messages.",
"example": 8,
"type": "number"
}
},
"required": [
"amount",
"protocol",
"time"
],
"type": "object"
},
"getAllResponseschema_4_items_inner": {
"additionalProperties": false,
"properties": {
"time": {
"description": "Date of the statistics.",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"protocol": {
"description": "Protocol of the message.",
"enum": [
"UDP",
"COAP",
"LWM2M"
],
"example": "COAP",
"type": "string"
},
"amount": {
"description": "Amount of messages.",
"example": 8,
"type": "number"
}
},
"required": [
"amount",
"protocol",
"time"
],
"type": "object"
},
"getResponseschema_8_coordinates_inner": {
"additionalProperties": false,
"properties": {
"coordinate": {
"description": "Coordinates of the specific position, in the following format [long, lat]",
"items": {
"type": "number"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"sampleTime": {
"description": "Sample time of the position",
"format": "date-time",
"type": "string"
},
"source": {
"description": "Source of the Position",
"enum": [
"GPS",
"CellTower"
],
"type": "string"
},
"metadata": {
"description": "Metadata of the Position",
"type": "object"
}
},
"required": [
"coordinate",
"sampleTime",
"source"
],
"type": "object"
},
"getLatestResponseschema_coordinates_inner": {
"additionalProperties": false,
"properties": {
"deviceId": {
"description": "The unique ID of the device.",
"example": "",
"type": "string"
},
"coordinate": {
"description": "Coordinates of the specific position, in the following format [long, lat]",
"items": {
"type": "number"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"sampleTime": {
"description": "Sample time of the position",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"source": {
"description": "Source of the Position",
"enum": [
"GPS",
"CellTower"
],
"type": "string"
},
"metadata": {
"description": "Metadata of the Position",
"type": "object"
}
},
"required": [
"coordinate",
"deviceId",
"sampleTime",
"source"
],
"type": "object"
},
"getResponseschema_9_items_inner_towerLocation": {
"description": "Coordinates of the specific celltower",
"properties": {
"longitude": {
"type": "number"
},
"latitude": {
"type": "number"
}
},
"type": "object"
},
"getResponseschema_9_items_inner_towerMetadata": {
"description": "Identifier attributes of the tower",
"properties": {
"MCC": {
"type": "string"
},
"MNC": {
"type": "string"
},
"LAC": {
"type": "string"
},
"CellID": {
"type": "string"
}
},
"type": "object"
},
"getResponseschema_9_items_inner": {
"additionalProperties": false,
"properties": {
"iccid": {
"description": "Device identifier",
"type": "string"
},
"towerLocation": {
"$ref": "#/components/schemas/getResponseschema_9_items_inner_towerLocation"
},
"towerMetadata": {
"$ref": "#/components/schemas/getResponseschema_9_items_inner_towerMetadata"
},
"sampleTime": {
"description": "Sample time of the location record",
"format": "date-time",
"type": "string"
},
"resolutionMetadata": {
"description": "Metadata of the location resolution",
"type": "object"
},
"radioAccessType": {
"description": "Radio access type",
"enum": [
"3G",
"2G",
"3.5G",
"4G",
"NB-IoT",
"LTE-M"
],
"type": "string"
},
"resolutionMode": {
"description": "Location resolver used to resolve location",
"enum": [
"BASIC",
"ADVANCED"
],
"type": "string"
},
"locationResolutionStatus": {
"description": "Status of location resolution attempt",
"enum": [
"SUCCEEDED",
"FAILED"
],
"type": "string"
}
},
"required": [
"iccid",
"locationResolutionStatus",
"radioAccessType",
"resolutionMode",
"sampleTime"
],
"type": "object"
},
"postGeofenceResponseschema_oneOf": {
"additionalProperties": false,
"properties": {
"id": {
"$ref": "#/components/schemas/Id"
},
"name": {
"$ref": "#/components/schemas/Name"
},
"eventTypes": {
"$ref": "#/components/schemas/EventTypes"
},
"eventSources": {
"$ref": "#/components/schemas/EventSources"
},
"type": {
"description": "The type of geofence",
"type": "string"
},
"coordinates": {
"$ref": "#/components/schemas/Coordinates"
},
"deviceId": {
"$ref": "#/components/schemas/DeviceId"
}
},
"required": [
"coordinates",
"deviceId",
"eventSources",
"eventTypes",
"id",
"name",
"type"
],
"type": "object"
},
"postGeofenceResponseschema_oneOf_1": {
"additionalProperties": false,
"properties": {
"id": {
"$ref": "#/components/schemas/Id"
},
"name": {
"$ref": "#/components/schemas/Name"
},
"eventTypes": {
"$ref": "#/components/schemas/EventTypes"
},
"eventSources": {
"$ref": "#/components/schemas/EventSources"
},
"type": {
"description": "The type of geofence",
"type": "string"
},
"radius": {
"$ref": "#/components/schemas/Radius"
},
"center": {
"$ref": "#/components/schemas/Center"
},
"deviceId": {
"$ref": "#/components/schemas/DeviceId"
}
},
"required": [
"center",
"deviceId",
"eventSources",
"eventTypes",
"id",
"name",
"radius",
"type"
],
"type": "object"
},
"patchGeofenceResponseschema_oneOf": {
"additionalProperties": false,
"properties": {
"id": {
"$ref": "#/components/schemas/Id"
},
"name": {
"$ref": "#/components/schemas/Name"
},
"eventTypes": {
"$ref": "#/components/schemas/EventTypes"
},
"eventSources": {
"$ref": "#/components/schemas/EventSources"
},
"type": {
"description": "The type of geofence",
"type": "string"
},
"coordinates": {
"$ref": "#/components/schemas/Coordinates"
},
"deviceId": {
"$ref": "#/components/schemas/DeviceId"
},
"created": {
"$ref": "#/components/schemas/Created"
},
"updated": {
"$ref": "#/components/schemas/Updated"
}
},
"required": [
"coordinates",
"created",
"deviceId",
"eventSources",
"eventTypes",
"id",
"name",
"updated"
],
"type": "object"
},
"patchGeofenceResponseschema_oneOf_1": {
"additionalProperties": false,
"properties": {
"id": {
"$ref": "#/components/schemas/Id"
},
"name": {
"$ref": "#/components/schemas/Name"
},
"eventTypes": {
"$ref": "#/components/schemas/EventTypes"
},
"eventSources": {
"$ref": "#/components/schemas/EventSources"
},
"type": {
"description": "The type of geofence",
"type": "string"
},
"radius": {
"$ref": "#/components/schemas/Radius"
},
"center": {
"$ref": "#/components/schemas/Center"
},
"deviceId": {
"$ref": "#/components/schemas/DeviceId"
},
"created": {
"$ref": "#/components/schemas/Created"
},
"updated": {
"$ref": "#/components/schemas/Updated"
}
},
"required": [
"center",
"created",
"deviceId",
"eventSources",
"eventTypes",
"id",
"name",
"radius",
"updated"
],
"type": "object"
},
"getResponseschema_10_items_inner_details": {
"additionalProperties": false,
"description": "Details of the setting.",
"properties": {
"credits": {
"description": "Credits remaining for ADVANCED_CELL_TOWER_LOCATION resolutions",
"example": 1000,
"type": "number"
},
"expiryDate": {
"description": "Expiry date of credits for ADVANCED_CELL_TOWER_LOCATION resolutions",
"example": "2030-03-07T08:51:29.015Z",
"format": "date-time",
"type": "object"
}
},
"required": [
"credits",
"expiryDate"
],
"type": "object"
},
"getResponseschema_10_items_inner": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the setting.",
"example": "ADVANCED_CELL_TOWER_LOCATION",
"type": "string"
},
"description": {
"description": "Description of the setting.",
"example": "Improves the Cell Tower Location functionality, especially for 3G, 4G and LTE-M.",
"type": "string"
},
"state": {
"description": "State of the setting.",
"enum": [
"ENABLED",
"DISABLED"
],
"example": "ENABLED",
"type": "string"
},
"details": {
"$ref": "#/components/schemas/getResponseschema_10_items_inner_details"
}
},
"required": [
"description",
"name",
"state"
],
"type": "object"
},
"postschema_6_eventTypes_inner": {
"properties": {
"type": {
"description": "Name of the event type",
"enum": [
"TELEMETRY_DATA",
"LIFECYCLE",
"ERROR",
"GEOFENCE",
"LOCATION"
],
"example": "TELEMETRY_DATA",
"type": "string"
},
"version": {
"description": "Version of the event type, if not provided latest version will be used",
"example": "1.0.0",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"postResponseschema_4_eventTypes_inner": {
"properties": {
"type": {
"description": "Name of the event type",
"enum": [
"TELEMETRY_DATA",
"LIFECYCLE",
"ERROR",
"GEOFENCE",
"LOCATION"
],
"example": "TELEMETRY_DATA",
"type": "string"
},
"version": {
"description": "Version of the event type",
"example": "1.0.0",
"type": "string"
}
},
"required": [
"type",
"version"
],
"type": "object"
},
"patchschema_3_eventTypes_inner": {
"additionalProperties": false,
"properties": {
"type": {
"description": "Name of the event type",
"enum": [
"TELEMETRY_DATA",
"LIFECYCLE",
"ERROR",
"GEOFENCE",
"LOCATION"
],
"example": "TELEMETRY_DATA",
"type": "string"
},
"version": {
"description": "Version of the event type",
"example": "1.0.0",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"getAllResponseschema_5_items_inner": {
"properties": {
"id": {
"description": "Unique ID of the Integration",
"example": "2BLURnaUZSlbKp6vN1V5dYiJvC4",
"minLength": 1,
"type": "string"
},
"lastSuccessfulMessageDelivery": {
"description": "Timestamp of the first message successfully delivered to integration, in ISO 8601 format",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"name": {
"description": "name",
"example": "a-sample-integration-name",
"minLength": 1,
"type": "string"
},
"eventTypes": {
"description": "A list of event types",
"items": {
"$ref": "#/components/schemas/postResponseschema_4_eventTypes_inner"
},
"minItems": 1,
"type": "array"
},
"state": {
"description": "Current state of the Integration",
"enum": [
"ROLLOUT_STARTED",
"ROLLOUT_DONE",
"ROLLOUT_FAILED",
"INTEGRATION_FAILED",
"INTEGRATION_ACTIVE"
],
"type": "string"
},
"type": {
"description": "Type of the Integration",
"enum": [
"AWS",
"WEBHOOK"
],
"type": "string"
},
"createdTime": {
"description": "Created timestamp of Integration",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"updatedTime": {
"description": "Updated timestamp of Integration",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"jsonPayloadEnabled": {
"default": false,
"description": "Flag if the payloads of this integration should be bridged in JSON format.",
"example": true,
"type": "boolean"
}
},
"required": [
"createdTime",
"eventTypes",
"id",
"jsonPayloadEnabled",
"name",
"state",
"type",
"updatedTime"
],
"type": "object"
},
"getEventTypesResponseschema_eventTypes_inner": {
"properties": {
"name": {
"description": "Name of the event type.",
"enum": [
"TELEMETRY_DATA",
"LIFECYCLE",
"ERROR",
"GEOFENCE",
"TEST_MESSAGE",
"LOCATION"
],
"example": "TELEMETRY_DATA",
"minLength": 1,
"type": "string"
},
"description": {
"description": "Description of the event type.",
"minLength": 1,
"type": "string"
},
"version": {
"description": "Version of the event type.",
"example": "1.0.0",
"minLength": 1,
"type": "string"
},
"payload": {
"description": "Payload of the event type.",
"type": "object"
}
},
"required": [
"description",
"name",
"payload",
"version"
],
"type": "object"
},
"postResponseschema_6_integration": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the Webhook integration.",
"example": "",
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"state": {
"description": "State of the Webhook integration.",
"enum": [
"ROLLOUT_DONE",
"INTEGRATION_ACTIVE",
"INTEGRATION_FAILED"
],
"example": "INTEGRATION_ACTIVE",
"type": "string"
},
"type": {
"description": "Type of the integration.",
"enum": [
"WEBHOOK"
],
"example": "WEBHOOK",
"type": "string"
},
"id": {
"description": "ID of the Webhook integration.",
"example": "",
"minLength": 1,
"type": "string"
},
"createdTime": {
"description": "Created timestamp of the Webhook integration.",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"updatedTime": {
"description": "Updated timestamp of the Webhook integration.",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"lastSuccessfulMessageDelivery": {
"description": "Timestamp of the first message successfully delivered to integration, in ISO 8601 format",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"eventTypes": {
"description": "A list of event types",
"items": {
"$ref": "#/components/schemas/postResponseschema_2_integration_eventTypes_inner"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"createdTime",
"eventTypes",
"id",
"name",
"state",
"type",
"updatedTime"
],
"type": "object"
},
"restartResponseschema_plugin": {
"oneOf": [
{
"$ref": "#/components/schemas/getResponseschema_12"
},
{
"$ref": "#/components/schemas/getResponseschema_14"
}
]
},
"getAllResponseschema_6_items_inner": {
"additionalProperties": false,
"properties": {
"id": {
"description": "Plugin installation identifier",
"example": "mo3--1DzmAgO-X777AY9h",
"type": "string"
},
"partner": {
"description": "Partner name",
"example": "PLUGIN-PARTNER",
"type": "string"
},
"created": {
"description": "Plugin installation timestamp",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"updated": {
"description": "Plugin installation update timestamp",
"example": "2022-03-07T08:51:29.015Z",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Status of the plugin installation",
"example": "INSTALLED",
"type": "string"
}
},
"required": [
"created",
"id",
"partner",
"status",
"updated"
],
"type": "object"
}
},
"securitySchemes": {
"BearerAuthentication": {
"description": "Bearer Authentication Token used to gain access to the 1NCE API. Please refer to the Open Authorization (/oauth/token) request for obtaining a Bearer Token.",
"scheme": "bearer",
"type": "http"
}
}
}
}