diff --git a/docs/index.html b/docs/index.html index b415e9a9..85e43533 100644 --- a/docs/index.html +++ b/docs/index.html @@ -3752,7 +3752,7 @@
Environment-Hash-Id required | string Example: yourAssetEnvironmentHashId |
Api-Version required | integer Example: 5 |
required | object or object or object |
delimiter required | string Enum: "," ";" |
rowDelimiter required | string Enum: "\n" "\r\n" |
Environment-Hash-Id required | string Example: yourAssetEnvironmentHashId |
Api-Version required | integer Example: 5 |
required | object or object or object or object |
delimiter required | string Enum: "," ";" |
rowDelimiter required | string Enum: "\n" "\r\n" |
{- "content": {
- "type": "measurementFilter",
- "measurementFilterHashId": "k8gh3"
}, - "delimiter": ",",
- "rowDelimiter": "\n"
}
{- "hashId": "maay1"
}
Locale code
Determines whether users need to have two factor authentication enabled in order to access this environment.
{- "hashId": "f1a4w1",
- "name": "My monitoring environment",
- "mapLayers": [
- {
- "name": "My map layer",
- "key": "myLayer",
- "style": {
- "layers": [
- {
- "id": "pdok-layer",
- "type": "raster",
- "source": "pdok-source",
- "paint": { }
}
], - "sources": {
- "pdok-source": {
- "type": "raster",
- "bounds": [
- 3.1706551165717776,
- 50.5788239246427,
- 7.4887369433036834,
- 53.637607600687694
]
}
}
}, - "namedStyle": "pdok-bodemkaart"
}
], - "boundingBox": {
- "type": "LineString",
- "coordinates": [
- [
- 3.3135576,
- 47.9747658
], - [
- 5.1288442202798,
- 51.8145997
]
]
}, - "fieldConfigurations": {
- "pinGroups": [
- {
- "key": "id",
- "name": "untranslated string",
- "showIf": {
- "key": "string",
- "value": "string"
}, - "hint": "untranslated string",
- "allowNull": null,
- "valueOptions": null,
- "type": "string",
- "defaultValue": "string",
- "inputType": "text",
- "regex": "string",
- "prefix": "untranslated string",
- "suffix": "untranslated string"
}
], - "edges": [
- {
- "key": "id",
- "name": "untranslated string",
- "showIf": {
- "key": "string",
- "value": "string"
}, - "hint": "untranslated string",
- "allowNull": null,
- "valueOptions": null,
- "type": "string",
- "defaultValue": "string",
- "inputType": "text",
- "regex": "string",
- "prefix": "untranslated string",
- "suffix": "untranslated string"
}
], - "grids": [
- {
- "key": "id",
- "name": "untranslated string",
- "showIf": {
- "key": "string",
- "value": "string"
}, - "hint": "untranslated string",
- "allowNull": null,
- "valueOptions": null,
- "type": "string",
- "defaultValue": "string",
- "inputType": "text",
- "regex": "string",
- "prefix": "untranslated string",
- "suffix": "untranslated string"
}
], - "nodes": [
- {
- "key": "id",
- "name": "untranslated string",
- "showIf": {
- "key": "string",
- "value": "string"
}, - "hint": "untranslated string",
- "allowNull": null,
- "valueOptions": null,
- "type": "string",
- "defaultValue": "string",
- "inputType": "text",
- "regex": "string",
- "prefix": "untranslated string",
- "suffix": "untranslated string"
}
], - "pins": [
- {
- "key": "id",
- "name": "untranslated string",
- "showIf": {
- "key": "string",
- "value": "string"
}, - "hint": "untranslated string",
- "allowNull": null,
- "valueOptions": null,
- "type": "string",
- "defaultValue": "string",
- "inputType": "text",
- "regex": "string",
- "prefix": "untranslated string",
- "suffix": "untranslated string"
}
]
}, - "locale": "en",
- "defaultGraphRange": "30d",
- "measurementsExpirationDays": 365,
- "enforceTwoFactorAuthentication": false,
- "expiresAt": null,
- "createdAt": "2019-12-31T15:23Z"
}
hashId required | string |
name required | string |
required | object See the chapter on open fields on how to use this - |
type required | string Enum: "human" "device" |
deletedAt required | string or null <date-time> |
{- "hashId": "l19a7s",
- "name": "Temperature and inclination",
- "fieldConfigurations": {
- "pinGroup": [
- {
- "key": "id",
- "name": "untranslated string",
- "showIf": {
- "key": "string",
- "value": "string"
}, - "hint": "untranslated string",
- "allowNull": null,
- "valueOptions": null,
- "type": "string",
- "defaultValue": "string",
- "inputType": "text",
- "regex": "string",
- "prefix": "untranslated string",
- "suffix": "untranslated string"
}
], - "pin": [
- {
- "key": "id",
- "name": "untranslated string",
- "showIf": {
- "key": "string",
- "value": "string"
}, - "hint": "untranslated string",
- "allowNull": null,
- "valueOptions": null,
- "type": "string",
- "defaultValue": "string",
- "inputType": "text",
- "regex": "string",
- "prefix": "untranslated string",
- "suffix": "untranslated string"
}
], - "measurement": [
- {
- "key": "id",
- "name": "untranslated string",
- "showIf": {
- "key": "string",
- "value": "string"
}, - "hint": "untranslated string",
- "allowNull": null,
- "valueOptions": null,
- "type": "string",
- "defaultValue": "string",
- "inputType": "text",
- "regex": "string",
- "prefix": "untranslated string",
- "suffix": "untranslated string"
}
]
}, - "type": "human",
- "deletedAt": null
}
hashId required | string |
required | object or object or object |
delimiter required | string Enum: "," ";" |
rowDelimiter required | string Enum: "\n" "\r\n" |
status required | string Enum: "waiting" "creating" "available" "deleted" |
downloadUrl | string Only available at status available + |
type required | string Enum: "human" "device" |
deletedAt required | string or null <date-time> |
{- "hashId": "l19a7s",
- "name": "Temperature and inclination",
- "fieldConfigurations": {
- "pinGroup": [
- {
- "key": "id",
- "name": "untranslated string",
- "showIf": {
- "key": "string",
- "value": "string"
}, - "hint": "untranslated string",
- "allowNull": null,
- "valueOptions": null,
- "type": "string",
- "defaultValue": "string",
- "inputType": "text",
- "regex": "string",
- "prefix": "untranslated string",
- "suffix": "untranslated string"
}
], - "pin": [
- {
- "key": "id",
- "name": "untranslated string",
- "showIf": {
- "key": "string",
- "value": "string"
}, - "hint": "untranslated string",
- "allowNull": null,
- "valueOptions": null,
- "type": "string",
- "defaultValue": "string",
- "inputType": "text",
- "regex": "string",
- "prefix": "untranslated string",
- "suffix": "untranslated string"
}
], - "measurement": [
- {
- "key": "id",
- "name": "untranslated string",
- "showIf": {
- "key": "string",
- "value": "string"
}, - "hint": "untranslated string",
- "allowNull": null,
- "valueOptions": null,
- "type": "string",
- "defaultValue": "string",
- "inputType": "text",
- "regex": "string",
- "prefix": "untranslated string",
- "suffix": "untranslated string"
}
]
}, - "type": "human",
- "deletedAt": null
}
hashId required | string |
required | object or object or object or object |
delimiter required | string Enum: "," ";" |
rowDelimiter required | string Enum: "\n" "\r\n" |
status required | string Enum: "waiting" "creating" "available" "deleted" |
downloadUrl | string Only available at status available |
createdAt required | string <date-time> |
{- "hashId": "maay1",
- "content": {
- "type": "all",
- "staticOnly": false,
- "gridHashId": null,
- "from": "2019-12-01T00:00Z",
- "to": "2020-01-01T00:00Z"
}, - "delimiter": ",",
- "rowDelimiter": "\n",
- "status": "available",
- "createdAt": "2019-12-31T15:23Z"
}
How form fields should be sent to the server when updating them.
{ }
dataUrl required | string Layout should be "data: Headers |
{- "hashId": "b45zo0",
- "email": "info@acme.com",
- "name": "John Doe",
- "timezone": "Europe/Amsterdam",
- "locale": "en",
- "phone": "string",
- "company": "string",
- "rights": [
- "STATIC",
- "USERS"
], - "twoFactorAuthenticationEnabled": true
}
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"
}
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"
}
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": {
- "url": {
- "protocol": "https",
- "host": "api.withthegrid.com",
- "path": "/something",
- "query": {
- "e": "f1a4w1",
- "t": "asd193gaf11234"
}
}, - "ip": "8.8.8.8",
- "method": "post",
- "headers": {
- "content-type": "application/json;charset=UTF-8"
}, - "body": {
- "type": "json",
- "data": {
- "key": "value"
}
}, - "certificate": {
- "subjects": [
- [
- {
- "key": {
- "encoding": "utf8",
- "value": "cn"
}, - "value": {
- "encoding": "utf8",
- "value": "common name"
}
}
]
]
}, - "pskIdentityHint": "=d37d7&&dhdkf2"
}, - "response": {
- "statusCode": 200,
- "headers": {
- "content-type": "application/json;charset=UTF-8"
}, - "body": {
- "type": "json",
- "data": {
- "key": "value"
}
}
}
}