From 3998dcffbd4dc4affae76ec81f7d091d90f381ef Mon Sep 17 00:00:00 2001 From: GitHub Actions Documentation Bot <> Date: Thu, 27 Oct 2022 15:05:34 +0000 Subject: [PATCH] chore: Documentation updated by github actions --- docs/index.html | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/index.html b/docs/index.html index 6650bc5f..c1e85756 100644 --- a/docs/index.html +++ b/docs/index.html @@ -2286,7 +2286,7 @@ 55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864 -231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688, -104.0616 -231.873,-231.248 z - " fill="currentColor">

platform-sdk (8)

Download OpenAPI specification:Download

API support: info@withthegrid.com URL: https://withthegrid.com/

Getting started

Introduction

This document provides information on how to access the withthegrid application programmatically.

+ " fill="currentColor">

platform-sdk (9)

Download OpenAPI specification:Download

API support: info@withthegrid.com URL: https://withthegrid.com/

Getting started

Introduction

This document provides information on how to access the withthegrid application programmatically.

Programmatic access to the application requires a machine account. Almost everything a user can do in the user interface of the application, can also be done with a machine account. To obtain one, contact us at info@withthegrid.com. Our programmatic interface is a REST JSON API that is accessible through HTTPS. Next to the raw HTTP queries (with examples in cURL), we provide a Javascript(Typescript) SDK. Select in the top bar whether you want to see the documentation for cURL or the Javascript SDK. To add the SDK to your javascript package, type npm i @withthegrid/platform-sdk into your console.

@@ -4293,21 +4293,21 @@

Headers

fields
required
object

The field configuration is stored in the fieldConfigurations key of the monitoring environment object

deviceLinkHashId
required
string or null

If null, there is no device installed at this location

level
required
integer
Enum: 0 1 2

0: no serious or critical open issues, 1: one or more serious open issues an no critical open issues, 2: one or more critical open issues

-
mapLayer
required
string
mostRecentMeasurementAt
required
string or null <date-time>
deletedAt
required
string or null <date-time>
{
  • "hashId": "dao97",
  • "geometry": {
    },
  • "name": "My location",
  • "symbolKey": "cp-pole",
  • "deviceFields": { },
  • "fields": {
    },
  • "deviceLinkHashId": null,
  • "level": 0,
  • "mapLayer": "myLayer",
  • "mostRecentMeasurementAt": null,
  • "deletedAt": null
}

quantity

hashId
required
string
required
untranslatedString (string) or translations (object) (stringOrTranslations)
color
required
string
unit
string or null

Will be displayed with an SI-prefix (eg. k or M) if relevant

+
mapLayer
required
string
mostRecentMeasurementAt
required
string or null <date-time>
deletedAt
required
string or null <date-time>
{
  • "hashId": "dao97",
  • "geometry": {
    },
  • "name": "My location",
  • "symbolKey": "cp-pole",
  • "deviceFields": { },
  • "fields": {
    },
  • "deviceLinkHashId": null,
  • "level": 0,
  • "mapLayer": "myLayer",
  • "mostRecentMeasurementAt": null,
  • "deletedAt": null
}

quantity

hashId
required
string
required
untranslatedString (string) or translations (object) (stringOrTranslations)
color
required
string
unit
string or null <= 10 characters

Will be displayed with an SI-prefix (eg. k or M) if relevant

defaultOrderOfMagnitude
integer [ -128 .. 127 ]

Defines default order of magnitude to be selected at manual report form

object or null (siNumber)

Significant number. Its value is significand * 10 ^ orderOfMagnitude. It has as many significant figures as the significand has (except when the significand is 0, then the number of significant figures is not defined)

object or null (siNumber)

Significant number. Its value is significand * 10 ^ orderOfMagnitude. It has as many significant figures as the significand has (except when the significand is 0, then the number of significant figures is not defined)

object or null (siNumber)

Significant number. Its value is significand * 10 ^ orderOfMagnitude. It has as many significant figures as the significand has (except when the significand is 0, then the number of significant figures is not defined)

object or null (siNumber)

Significant number. Its value is significand * 10 ^ orderOfMagnitude. It has as many significant figures as the significand has (except when the significand is 0, then the number of significant figures is not defined)

disableSiPrefixes
boolean
Default: false

Will disable SI-prefixes for this quantity if true

-
{
  • "hashId": "sajia1",
  • "name": "untranslated string",
  • "color": "#ff00ff",
  • "unit": "K",
  • "defaultOrderOfMagnitude": -3,
  • "defaultCriticallyLowThreshold": {
    },
  • "defaultLowThreshold": {
    },
  • "defaultHighThreshold": {
    },
  • "defaultCriticallyHighThreshold": {
    },
  • "disableSiPrefixes": true
}

siNumber

orderOfMagnitude
required
integer [ -128 .. 127 ]
significand
required
integer [ -2147483648 .. 2147483647 ]
{
  • "orderOfMagnitude": 0,
  • "significand": 1500
}

stringOrTranslations

Any of
string (untranslatedString)
Example
"untranslated string"

supplier

hashId
required
string
name
required
string
enforceTwoFactorAuthentication
required
boolean

Determines whether users need to have two factor authentication enabled in order to access this environment.

+
{
  • "hashId": "sajia1",
  • "name": "untranslated string",
  • "color": "#ff00ff",
  • "unit": "K",
  • "defaultOrderOfMagnitude": -3,
  • "defaultCriticallyLowThreshold": {
    },
  • "defaultLowThreshold": {
    },
  • "defaultHighThreshold": {
    },
  • "defaultCriticallyHighThreshold": {
    },
  • "disableSiPrefixes": true
}

siNumber

orderOfMagnitude
required
integer [ -128 .. 127 ]
significand
required
integer [ -2147483648 .. 2147483647 ]
{
  • "orderOfMagnitude": 0,
  • "significand": 1500
}

stringOrTranslations

Any of
<= 9999 characters
string (untranslatedString) <= 9999 characters
Example
"untranslated string"

supplier

hashId
required
string
name
required
string
enforceTwoFactorAuthentication
required
boolean

Determines whether users need to have two factor authentication enabled in order to access this environment.

object or null
createdAt
required
string <date-time>
{
  • "hashId": "f1a4w1",
  • "name": "My connectivity environment",
  • "enforceTwoFactorAuthentication": false,
  • "theme": {
    },
  • "createdAt": "2019-12-31T15:23Z"
}

supplierCertificate

hashId
required
string
name
required
string
certificate
required
string

A Base64 encoded intermediate certificate. Should be used to create device certificates.

createdAt
required
string <date-time>
{
  • "hashId": "v19a12",
  • "name": "My certificate",
  • "certificate": "-----BEGIN CERTIFICATE-----\n MIIBNzCB3gIBATAKBggqhkjOPQQDAjAkMREwDwYDVQQKDAhzdXBwbGllcjEPMA0G\n A1UEAwwGeGQycmQ0MB4XDTIwMDIyNDEzNTQwOVoXDTIxMDIyMzEzNTQwOVowLDEP\n MA0GA1UECgwGZGV2aWNlMRkwFwYDVQQDDBB1bnFpZSBpZGVudGlmaWVyMFkwEwYH\n KoZIzj0CAQYIKoZIzj0DAQcDQgAEUPyQwLuDlKw7CA41ADhxXRvD3n9ZFF0XCeI9\n OAgRIgl2mGmnO31wX1DD4weZoB2pswCBrC39FpyHgIz6LK10PzAKBggqhkjOPQQD\n AgNIADBFAiEAyz0Ha4eFfebqSoES4vxguipSHmR/zN8KjEEie7xpqo8CICFS5NWG\n iaT6xhGfChGbQjpmQQYYabau8Ons8F2JNyLu\n -----END CERTIFICATE-----\n ",
  • "createdAt": "2019-12-31T15:23Z"
}

supplierReportType

hashId
required
string
required
untranslatedString (string) or translations (object) (stringOrTranslations)
required
object

See the chapter on open fields on how to use this

deletedAt
required
string or null <date-time>
{
  • "hashId": "l19a7s",
  • "name": "untranslated string",
  • "fieldConfigurations": {
    },
  • "deletedAt": null
}

supplierWebhook

hashId
required
string
name
required
string
createdAt
required
string <date-time>
{
  • "hashId": "z812a63",
  • "name": "My webhook",
  • "createdAt": "2019-12-31T15:23Z"
}

threshold

hashId
required
string
pinHashId
required
string
required
object or null (siNumber)

Significant number. Its value is significand * 10 ^ orderOfMagnitude. It has as many significant figures as the significand has (except when the significand is 0, then the number of significant figures is not defined)

required
object or null (siNumber)

Significant number. Its value is significand * 10 ^ orderOfMagnitude. It has as many significant figures as the significand has (except when the significand is 0, then the number of significant figures is not defined)

required
object or null (siNumber)

Significant number. Its value is significand * 10 ^ orderOfMagnitude. It has as many significant figures as the significand has (except when the significand is 0, then the number of significant figures is not defined)

required
object or null (siNumber)

Significant number. Its value is significand * 10 ^ orderOfMagnitude. It has as many significant figures as the significand has (except when the significand is 0, then the number of significant figures is not defined)

-
{
  • "hashId": "tap192",
  • "pinHashId": "e13d57",
  • "criticallyLow": {
    },
  • "low": {
    },
  • "high": {
    },
  • "criticallyHigh": {
    }
}

translations

object or string
object or string
{
  • "en": {
    },
  • "nl": {
    }
}

untranslatedString

string (untranslatedString)
"untranslated string"

updatableFieldConfigurations

Array
existingKey
string^[a-z][a-zA-Z\d]*$
required
object or object or object or object or object or object or object or object or object or object or object or object or object

Defines which data can be stored in form fields.

+
{
  • "hashId": "tap192",
  • "pinHashId": "e13d57",
  • "criticallyLow": {
    },
  • "low": {
    },
  • "high": {
    },
  • "criticallyHigh": {
    }
}

translations

object or string
object or string
{
  • "en": {
    },
  • "nl": {
    }
}

untranslatedString

string (untranslatedString) <= 9999 characters
"untranslated string"

updatableFieldConfigurations

Array
existingKey
string^[a-z][a-zA-Z\d]*$
required
object or object or object or object or object or object or object or object or object or object or object or object or object

Defines which data can be stored in form fields.

[
  • {
    }
]

user

hashId
required
string
email
required
string or null <email>

Is null for machine accounts

name
required
string <= 255 characters
timezone
required
string

A IANA zone or a fixed-offset name of the form 'UTC+3', or the strings 'utc'.

locale
string
Default: "en"
Enum: "en" "nl"

Locale code

@@ -4316,7 +4316,7 @@

Headers

{
  • "hashId": "b45zo0",
  • "email": "info@acme.com",
  • "name": "John Doe",
  • "timezone": "Europe/Amsterdam",
  • "locale": "en",
  • "phone": "string",
  • "company": "string",
  • "rights": [
    ],
  • "twoFactorAuthenticationEnabled": true
}

userEnvironmentSettings

notificationLevel
required
number or null <float>
Enum: 0 1 2

The user is subscribed to every issue created on locations in this environment (0), when the issue gets serious (1) or when the issue gets critical (2). If null, the user is not autmatically subscribed to new issues.

defaultAnalyticsPanelHashId
required
string or null
{
  • "notificationLevel": 0,
  • "defaultAnalyticsPanelHashId": "7usgt"
}

userSubscription

hashId
required
string
objectType
required
string
Enum: "supplierReportType" "deviceType" "supplierWebhook" "supplierCertificate"
objectHashId
required
string
lastNotification
required
string or null <date-time>
alertsSinceLastNotification
required
integer
createdAt
required
string <date-time>
{
  • "hashId": "dfa1p",
  • "objectType": "deviceType",
  • "objectHashId": "wasd2",
  • "lastNotification": "2020-01-31T11:17Z",
  • "alertsSinceLastNotification": 0,
  • "createdAt": "2019-12-31T15:23Z"
}

webRequest

hashId
required
string
incoming
required
boolean
createdAt
required
string <date-time>
required
object
required
object or null
{
  • "hashId": "1a532q",
  • "incoming": true,
  • "createdAt": "2019-12-31T15:23Z",
  • "request": {
    },
  • "response": {
    }
}