From 939688904541a17c1a18c7b175046c18e8436b0a Mon Sep 17 00:00:00 2001 From: Kateryna Zavorotna Date: Thu, 9 Feb 2023 14:02:43 +0100 Subject: [PATCH] feat(port groups): added possibility to edit port groups from port details dialog --- docs/index.html | 12 ++++++------ src/routes/graph/add-pin.ts | 6 ++++++ src/routes/graph/get-pin-group.ts | 10 ++++++++-- src/routes/graph/update-pin.ts | 5 +++++ 4 files changed, 25 insertions(+), 8 deletions(-) diff --git a/docs/index.html b/docs/index.html index 5d0ff9c6..53846d54 100644 --- a/docs/index.html +++ b/docs/index.html @@ -3092,8 +3092,8 @@

Headers

  • Monitoring environment: STATIC
    • Authorizations:
    jwt-token
    path Parameters
    pinGroupHashId
    required
    string
    Example: dao97
    header Parameters
    Environment-Hash-Id
    required
    string
    Example: yourAssetEnvironmentHashId
    Api-Version
    required
    integer
    Example: 5
    Request Body schema: text/json
    fields
    required
    object

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

    -
    typeKey
    string or null
    edgeHashId
    string or null

    Responses

    Request samples

    Content type
    text/json
    {
    • "fields": {
      },
    • "typeKey": "string",
    • "edgeHashId": "ka08d"
    }

    Response samples

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

    deleteEdge

    Delete an edge.

    +
    typeKey
    string or null
    edgeHashId
    string or null
    pinGridsHashIds
    Array of strings or null

    Responses

    Request samples

    Content type
    text/json
    {
    • "fields": {
      },
    • "typeKey": "string",
    • "edgeHashId": "ka08d",
    • "pinGridsHashIds": [
      ]
    }

    Response samples

    Content type
    text/json
    {
    • "pin": {
      },
    • "grids": [
      ]
    }

    deleteEdge

    Delete an edge.

    Rights

    • Monitoring environment: STATIC
      • @@ -3198,7 +3198,7 @@

      Headers

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

    Response samples

    Content type
    text/json
    {
    • "pinGroup": {
      },
    • "pins": [
      ],
    • "edges": [
      ],
    • "device": {
      },
    • "deviceType": {
      },
    • "channelMapping": [
      ],
    • "measurementCycle": null,
    • "thresholds": [
      ],
    • "photo": "https://api.withthegrid.com/file/yr969d...",
    • "nextReportBefore": "2019-12-31T15:25Z",
    • "grids": [
      ]
    }

    updatePinGroup

    Updates a specific pin group

    +

    Response samples

    Content type
    text/json
    {
    • "pinGroup": {
      },
    • "pins": [
      ],
    • "edges": [
      ],
    • "device": {
      },
    • "deviceType": {
      },
    • "channelMapping": [
      ],
    • "measurementCycle": null,
    • "thresholds": [
      ],
    • "photo": "https://api.withthegrid.com/file/yr969d...",
    • "nextReportBefore": "2019-12-31T15:25Z",
    • "grids": [
      ]
    }

    updatePinGroup

    Updates a specific pin group

    Rights

    • Monitoring environment: STATIC
      • @@ -3280,8 +3280,8 @@

      Headers

    • Monitoring environment: STATIC
    Authorizations:
    jwt-token
    path Parameters
    hashId
    required
    string
    Example: e13d57
    header Parameters
    Environment-Hash-Id
    required
    string
    Example: yourAssetEnvironmentHashId
    Api-Version
    required
    integer
    Example: 5
    Request Body schema: text/json
    object or (Array of objects or objects) (fieldsToServerUpdate)

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

    -
    edgeHashId
    string or null

    Responses

    Request samples

    Content type
    text/json
    {
    • "fields": { },
    • "edgeHashId": "ka08d"
    }

    Response samples

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

    find

    Search through pinGroups, edges and pinGroup-grids

    +
    edgeHashId
    string or null
    pinGridsHashIds
    Array of strings

    Responses

    Request samples

    Content type
    text/json
    {
    • "fields": { },
    • "edgeHashId": "ka08d",
    • "pinGridsHashIds": [
      ]
    }

    Response samples

    Content type
    text/json
    {
    • "pin": {
      },
    • "grids": [
      ]
    }

    find

    Search through pinGroups, edges and pinGroup-grids

    Rights

    • Monitoring environment: READ
      • @@ -4450,7 +4450,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": {
      }
    }