diff --git a/docs/index.html b/docs/index.html index 1e23e4db..e341396c 100644 --- a/docs/index.html +++ b/docs/index.html @@ -2960,8 +2960,9 @@

Headers

Authorizations:
jwt-token
header Parameters
Environment-Hash-Id
required
string
Example: yourAssetEnvironmentHashId
Api-Version
required
integer
Example: 5
Request Body schema: text/json
name
string
Array of objects (mapLayer) non-empty
object

See the chapter on open fields on how to use this. A minimum of 1 element should be present in each field configuration array

locale
string
Enum: "en" "nl"

Locale code

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

Describes if users need to have two factor authentication enabled in order to access this environment.

-
object or null

Responses

Request samples

Content type
text/json
{
  • "name": "My monitoring environment",
  • "mapLayers": [],
  • "fieldConfigurations": {
    },
  • "locale": "en",
  • "defaultGraphRange": "30d",
  • "measurementsExpirationDays": 365,
  • "enforceTwoFactorAuthentication": false,
  • "theme": {
    }
}

Response samples

Content type
text/json
{
  • "environment": {
    }
}

get

Get a specific monitoring environment identified by its hashId

+
object or null
environmentLogo
string or null

Should be a dataurl. Null clears the photo

+

Responses

Request samples

Content type
text/json
{
  • "name": "My monitoring environment",
  • "mapLayers": [],
  • "fieldConfigurations": {
    },
  • "locale": "en",
  • "defaultGraphRange": "30d",
  • "measurementsExpirationDays": 365,
  • "enforceTwoFactorAuthentication": false,
  • "theme": {
    },
  • "environmentLogo": "string"
}

Response samples

Content type
text/json
{
  • "environment": {
    }
}

get

Get a specific monitoring environment identified by its hashId

Authorizations:
jwt-token
path Parameters
hashId
required
string
Example: f1a4w1
header Parameters
Api-Version
required
integer
Example: 5

Responses

Request samples 

 
@@ -2971,7 +2972,7 @@ 
Headers

   -H 'Api-Version: 5' \
   -H 'Authorization: Bearer {access-token}'
 
-

Response samples

Content type
text/json
{
  • "environment": {
    },
  • "environmentRights": [
    ],
  • "userEnvironmentSettings": {
    }
}

Graph

addEdge

Create an edge

+

Response samples

Content type
text/json
{
  • "environment": {
    },
  • "environmentRights": [
    ],
  • "userEnvironmentSettings": {
    },
  • "environmentLogo": "https://api.withthegrid.com/file/yr969d..."
}

Graph

addEdge

Create an edge

Rights

  • Monitoring environment: STATIC
    • @@ -3994,7 +3995,7 @@

    Headers

    -H 'Api-Version: 5' \ -H 'Authorization: Bearer {access-token}' -

Response samples

Content type
text/json
{
  • "environment": {
    },
  • "environmentRights": [
    ],
  • "userEnvironmentSettings": {
    },
  • "user": {
    }
}

update

Update the settings of this user

+

Response samples

Content type
text/json
{
  • "environment": {
    },
  • "environmentRights": [
    ],
  • "userEnvironmentSettings": {
    },
  • "user": {
    },
  • "environmentLogo": "https://api.withthegrid.com/file/yr969d..."
}

update

Update the settings of this user

Authorizations:
jwt-token
header Parameters
Api-Version
required
integer
Example: 5
Request Body schema: text/json
name
string <= 255 characters
password
string >= 8 characters
locale
string
Enum: "en" "nl"

Locale code

timezone
string
phone
string or null
company
string or null

Responses

Request samples

Content type
text/json
{
  • "name": "Jane Doe",
  • "password": "stringst",
  • "locale": "en",
  • "timezone": "string",
  • "phone": "string",
  • "company": "string"
}

updateUserEnvironmentSettings

Update the environment settings of this user

@@ -4078,8 +4079,9 @@

Headers

  • Connectivity environment: ENVIRONMENT_ADMIN
    • Authorizations:
    jwt-token
    header Parameters
    Environment-Hash-Id
    required
    string
    Example: yourAssetEnvironmentHashId
    Api-Version
    required
    integer
    Example: 5
    Request Body schema: text/json
    name
    string
    enforceTwoFactorAuthentication
    boolean

    Describes if users need to have two factor authentication enabled in order to access this environment.

    -
    object or null

    Responses

    Request samples

    Content type
    text/json
    {
    • "name": "My connectivity environment",
    • "enforceTwoFactorAuthentication": false,
    • "theme": {
      }
    }

    get

    Get a specific connectivity environment identified by its hashId

    +
    object or null
    environmentLogo
    string or null

    Should be a dataurl. Null clears the photo

    +

    Responses

    Request samples

    Content type
    text/json
    {
    • "name": "My connectivity environment",
    • "enforceTwoFactorAuthentication": false,
    • "theme": {
      },
    • "environmentLogo": "string"
    }

    get

    Get a specific connectivity environment identified by its hashId

    Authorizations:
    jwt-token
    path Parameters
    hashId
    required
    string
    Example: f1a4w1
    header Parameters
    Api-Version
    required
    integer
    Example: 5

    Responses

    Request samples 

     
@@ -4089,7 +4091,7 @@ 
    Headers
    
   -H 'Api-Version: 5' \
   -H 'Authorization: Bearer {access-token}'
 
-

    Response samples

    Content type
    text/json
    {
    • "supplier": {
      },
    • "supplierRights": [
      ]
    }

    Supplier-activity

    find

    Search through activity in the connectivity environment

    +

    Response samples

    Content type
    text/json
    {
    • "supplier": {
      },
    • "supplierRights": [
      ],
    • "environmentLogo": "https://api.withthegrid.com/file/yr969d..."
    }

    Supplier-activity

    find

    Search through activity in the connectivity environment

    Rights

    • Connectivity environment: ENVIRONMENT_ADMIN
      • @@ -4452,7 +4454,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": {
      }
    }