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 @@

Headers

-
Authorizations:
jwt-token
    header Parameters
    Environment-Hash-Id
    required
    string
    Example: yourAssetEnvironmentHashId
    Api-Version
    required
    integer
    Example: 5
    Request Body schema: text/json
    required
    object or object or object
    delimiter
    required
    string
    Enum: "," ";"
    rowDelimiter
    required
    string
    Enum: "\n" "\r\n"

    Responses

    Authorizations:
    jwt-token
      header Parameters
      Environment-Hash-Id
      required
      string
      Example: yourAssetEnvironmentHashId
      Api-Version
      required
      integer
      Example: 5
      Request Body schema: text/json
      required
      object or object or object or object
      delimiter
      required
      string
      Enum: "," ";"
      rowDelimiter
      required
      string
      Enum: "\n" "\r\n"

      Responses

      Request samples

      Content type
      text/json
      {
      • "content": {
        },
      • "delimiter": ",",
      • "rowDelimiter": "\n"
      }

      Response samples

      Content type
      text/json
      {
      • "hashId": "maay1"
      }

      findExportRequest

      Search through export requests

      Rights

        @@ -4200,7 +4200,7 @@

        Headers

      locale
      required
      string
      Enum: "en" "nl"

      Locale code

      defaultGraphRange
      required
      string
      measurementsExpirationDays
      required
      integer [ 1 .. 9999 ]
      enforceTwoFactorAuthentication
      required
      boolean

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

      expiresAt
      required
      string or null <date-time>
      createdAt
      required
      string <date-time>
      {
      • "hashId": "f1a4w1",
      • "name": "My monitoring environment",
      • "mapLayers": [],
      • "boundingBox": {
        },
      • "fieldConfigurations": {
        },
      • "locale": "en",
      • "defaultGraphRange": "30d",
      • "measurementsExpirationDays": 365,
      • "enforceTwoFactorAuthentication": false,
      • "expiresAt": null,
      • "createdAt": "2019-12-31T15:23Z"
      }

      environmentReportType

      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": {
        },
      • "type": "human",
      • "deletedAt": null
      }

      exportRequest

      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": {
        },
      • "type": "human",
      • "deletedAt": null
      }

      exportRequest

      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>
      {}

      fieldToServerFull

      Any of
      any

      The values and files that can be stored in a form field.

      Example
      true

      fieldsToServerUpdate

      Any of
      object

      How form fields should be sent to the server when updating them.

      { }

      fileToServer

      dataUrl
      required
      string

      Layout should be "data:;base64,", see https://developer.mozilla.org/en-US/docs/Web/API/FileReader/readAsDataURL

      @@ -4249,7 +4249,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": {
        }
      }