Get installed components in edge gateway

GET 
/organizations/:organizationId/edge-gateways/:edgeGatewayId/installed-components

Get installed components in edge gateway

Request

Path Parameters

organizationId stringrequired

The ID of organization.

edgeGatewayId stringrequired

Edge Gateway ID

Responses

200

application/json

Schema

Schema

data object[]required
Data of the edge gateway.
Array [
componentName stringrequired
componentVersion stringrequired
isRoot booleanrequired
lastInstallationSource stringrequired
lastReportedTimestamp required
lastStatusChangeTimestamp required
lifecycleState stringrequired
lifecycleStateDetails stringrequired
lifecycleStatusCodes string[]required
]

Example (from schema)

{
  "data": [
    {
      "componentName": "string",
      "componentVersion": "string",
      "isRoot": true,
      "lastInstallationSource": "string",
      "lastReportedTimestamp": {},
      "lastStatusChangeTimestamp": {},
      "lifecycleState": "string",
      "lifecycleStateDetails": "string",
      "lifecycleStatusCodes": [
        "string"
      ]
    }
  ]
}

Example

{
  "data": [
    {
      "componentName": "com.example.ComponentA",
      "componentVersion": "1.0.0",
      "isRoot": false,
      "lastInstallationSource": "https://example.com/components/componentA/1.0.0",
      "lastReportedTimestamp": 1700000000000,
      "lastStatusChangeTimestamp": 1704067200000,
      "lifecycleState": "RUNNING",
      "lifecycleStateDetails": "The component is currently running.",
      "lifecycleStatusCodes": [
        "NORMAL"
      ]
    }
  ]
}

401

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Unauthenticated",
  "message": "Authentication is required and has failed or has not yet been provided."
}

403

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Forbidden",
  "message": "Access to the requested resource is forbidden."
}

422

The input data has invalid.

application/json

Schema

Schema

error stringrequired

The input data has invalid.

message stringrequired

The input data has invalid message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "ValidationError",
  "message": "Input data validation failed."
}

Loading...