Edge System

Save PDF

Last UpdatedJan 24, 2024
6 minute read

`List Edge Systems`

Returns a list of Edge Systems.

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/SoftwareManagement/Systems
?skip={skip}&count={count}&orderBy={orderBy}&query={query}

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

[optional] integer skip
Parameter representing the zero-based offset of the first Edge System to retrieve. If unspecified, a default value of 0 is used. Value must be greater than 0.

[optional] integer count
Parameter representing the maximum number of objects to retrieve. If unspecified, a default value of 100 is used. Value cannot be less than 1 or greater than 1000.

[optional] string orderBy
Query parameter to specify sort order. Valid sort order properties are EdgeSystemId, DeviceName, Name, Type, Tags, Status, StatusDescription, LastContactedTime, and SoftwareVersion. If unspecified, a default value of 'name asc' is used.

[optional] string query
Query parameter to specify filter. Valid filter properties are EdgeSystemId, DeviceName, Name, Type, Tags, Status, StatusDescription, LastContactedTime, and SoftwareVersion.

Response

Status Code	Body Type	Description
200	EdgeSystem[]	List of edge systems.
400	ErrorResponse	Missing or invalid inputs.
401	ErrorResponse	Unauthorized.
500	ErrorResponse	Internal server error.

Response Headers

Status	Header	Type	Description
200	Total-Count	integer	The total number of edge systems.

Example response body

200 Response (EdgeSystem[])

[
  {
    "Id": "string",
    "DeviceName": "string",
    "Name": "string",
    "Type": "string",
    "SoftwareVersion": "string",
    "CreatedDate": "2019-08-24T14:15:22Z",
    "LastContactedTime": "2019-08-24T14:15:22Z",
    "ModifiedDate": "2019-08-24T14:15:22Z",
    "ModifiedBy": "string",
    "ModifiedByType": 1,
    "Status": 1,
    "StatusDescription": "string",
    "SystemDiagnosticsStreamId": "string",
    "Components": [
      {
        "Id": "string",
        "ComponentType": "string",
        "DeviceStatusStreamId": "string",
        "NextHealthMessageExpectedStreamId": "string",
        "DiagnosticsStreams": [
          {
            "Id": "string",
            "NamespaceId": "string",
            "TypeId": "string"
          }
        ],
        "Status": 1,
        "StatusDescription": "string",
        "Errors": [
          "string"
        ]
      }
    ],
    "Tags": [
      "string"
    ],
    "IsVisible": true
  }
]

`Get Edge Systems Summary`

Returns header information for Edge Systems.

Request

HEAD /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/SoftwareManagement/Systems
?query={query}

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

[optional] string query
Query parameter to specify a filter. Valid filter properties are EdgeSystemId, DeviceName, Name, Type, Tags, Status, StatusDescription, LastContactedTime, and SoftwareVersion.

Response

Status Code	Body Type	Description
204	None	Headers for Edge Systems found.
401	ErrorResponse	Unauthorized.
500	ErrorResponse	Internal server error.

Response Headers

Status	Header	Type	Description
204	Total-Count	integer	The total number of edge systems.

`Get Edge System`

Returns a specific Edge System.

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/SoftwareManagement/Systems/{edgeSystemId}

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string edgeSystemId
Edge System identifier.

Response

Status Code	Body Type	Description
200	EdgeSystem	Edge System with the specified identifier.
401	ErrorResponse	Unauthorized.
404	ErrorResponse	Edge System not found.
500	ErrorResponse	Internal server error.

Example response body

200 Response (EdgeSystem)

{
  "Id": "string",
  "DeviceName": "string",
  "Name": "string",
  "Type": "string",
  "SoftwareVersion": "string",
  "CreatedDate": "2019-08-24T14:15:22Z",
  "LastContactedTime": "2019-08-24T14:15:22Z",
  "ModifiedDate": "2019-08-24T14:15:22Z",
  "ModifiedBy": "string",
  "ModifiedByType": 1,
  "Status": 1,
  "StatusDescription": "string",
  "SystemDiagnosticsStreamId": "string",
  "Components": [
    {
      "Id": "string",
      "ComponentType": "string",
      "DeviceStatusStreamId": "string",
      "NextHealthMessageExpectedStreamId": "string",
      "DiagnosticsStreams": [
        {
          "Id": "string",
          "NamespaceId": "string",
          "TypeId": "string"
        }
      ],
      "Status": 1,
      "StatusDescription": "string",
      "Errors": [
        "string"
      ]
    }
  ],
  "Tags": [
    "string"
  ],
  "IsVisible": true
}

`Show Or Hide System`

Reactivates a specific System.

Request

PUT /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/SoftwareManagement/Systems/{edgeSystemId}

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string edgeSystemId
Edge System identifier.

Request Body

object to reactivate.

{
  "Id": "string",
  "DeviceName": "string",
  "Name": "string",
  "Type": "string",
  "SoftwareVersion": "string",
  "CreatedDate": "2019-08-24T14:15:22Z",
  "LastContactedTime": "2019-08-24T14:15:22Z",
  "ModifiedDate": "2019-08-24T14:15:22Z",
  "ModifiedBy": "string",
  "ModifiedByType": 1,
  "Status": 1,
  "StatusDescription": "string",
  "SystemDiagnosticsStreamId": "string",
  "Components": [
    {
      "Id": "string",
      "ComponentType": "string",
      "DeviceStatusStreamId": "string",
      "NextHealthMessageExpectedStreamId": "string",
      "DiagnosticsStreams": [
        {
          "Id": "string",
          "NamespaceId": "string",
          "TypeId": "string"
        }
      ],
      "Status": 1,
      "StatusDescription": "string",
      "Errors": [
        "string"
      ]
    }
  ],
  "Tags": [
    "string"
  ],
  "IsVisible": true
}

Response

Status Code	Body Type	Description
200	None	Success.
204	None	No content.
400	ErrorResponse	None
401	ErrorResponse	Unauthorized.
404	ErrorResponse	None
500	ErrorResponse	Internal server error.

`List Tags`

Returns a list of tags present on Edge Systems.

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/SoftwareManagement/Tags

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

Response

Status Code	Body Type	Description
200	Inline	List of tags
401	ErrorResponse	Unauthorized.
500	ErrorResponse	Internal server error.

Response Headers

Status	Header	Type	Description
200	Total-Count	integer	The total number of tags.

`Update Tags`

Creates or updates the tags of a specific Edge System.

Request

PUT /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/SoftwareManagement/Systems/{edgeSystemId}/Tags

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string edgeSystemId
Edge System identifier.

Request Body

Serialized list of tags.

[
  "string"
]

Response

Status Code	Body Type	Description
204	None	No content.
401	ErrorResponse	Unauthorized.
500	ErrorResponse	Internal server error.

`Get Configuration`

Returns an Edge System Configuration.

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/SoftwareManagement/Systems/{edgeSystemId}/Configuration

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string edgeSystemId
Edge System identifier used as blob name in the storage account.

Response

Status Code	Body Type	Description
200	Inline	Configuration for the specified Edge System.
400	ErrorResponse	Missing or invalid inputs.
401	ErrorResponse	Unauthorized.
404	ErrorResponse	Configuration not found.
500	ErrorResponse	Internal server error.

`Create Configuration`

Creates an Edge System Configuration in the storage account. Does not save any secrets supplied as part of the edge system configuration.

Request

POST /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/SoftwareManagement/Systems/{edgeSystemId}/Configuration

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string edgeSystemId
Edge System identifier used as blob name in the storage account.

Response

Status Code	Body Type	Description
201	Inline	Configuration created.
400	ErrorResponse	Missing or invalid inputs.
401	ErrorResponse	Unauthorized.
409	ErrorResponse	Conflict.
500	ErrorResponse	Internal server error.

`Update Configuration`

Updates an Edge System Configuration. Does not save any secrets supplied as part of the edge system configuration.

Request

PUT /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/SoftwareManagement/Systems/{edgeSystemId}/Configuration

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string edgeSystemId
Edge System identifier used as blob name in the storage account.

Response

Status Code	Body Type	Description
204	None	No content.
400	ErrorResponse	Missing or invalid inputs.
401	ErrorResponse	Unauthorized.
500	ErrorResponse	Internal server error.

`Delete Configuration`

Deletes an Edge System Configuration.

Request

DELETE /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/SoftwareManagement/Systems/{edgeSystemId}/Configuration

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string edgeSystemId
Edge System identifier used as blob name in the storage account.

Response

Status Code	Body Type	Description
204	None	No content.
400	ErrorResponse	Missing or invalid inputs.
401	ErrorResponse	Unauthorized.
404	ErrorResponse	Configuration not found.
500	ErrorResponse	Internal server error.

Definitions

ErrorResponse

Properties

Property Name	Data Type	Required	Nullable	Description
OperationId	string	true	false	None
Error	string	true	false	None
Reason	string	true	false	None
Resolution	string	true	false	None
DynamicProperties	object	false	true	None

{
  "OperationId": "string",
  "Error": "string",
  "Reason": "string",
  "Resolution": "string",
  "DynamicProperties": {
    "property1": null,
    "property2": null
  },
  "property1": null,
  "property2": null
}

EdgeSystem

Properties

Property Name	Data Type	Required	Nullable	Description
Id	string	false	true	Edge system unique identifier.
DeviceName	string	false	true	Device name for this edge system.
Name	string	false	true	Edge system name.
Type	string	false	true	Type name for this edge system.
SoftwareVersion	string	false	true	Version for this edge system.
CreatedDate	date-time	false	false	Time at which the edge system was created.
LastContactedTime	date-time	false	false	Time at which the edge system was last contacted.
ModifiedDate	date-time	false	true	Time at which the edge system was last modified.
ModifiedBy	string	false	true	Identifier for who modified the edge system most recently.
ModifiedByType	TrusteeType	false	true	Type identifier for who modified the edge system most recently.
Status	StatusCategory	false	false	Value of the component's status for the component with the highest priority status.
StatusDescription	string	false	true	Value of the component's status description for the component with the highest priority status description.
SystemDiagnosticsStreamId	string	false	true	System diagnostics stream identifier for this edge system.
Components	[Component]	false	true	List of components for this edge system.
Tags	string[]	false	true	List of tags for this edge system.
IsVisible	boolean	false	false	Identifier iindicated if the system should be visible to the user/client.

{
  "Id": "string",
  "DeviceName": "string",
  "Name": "string",
  "Type": "string",
  "SoftwareVersion": "string",
  "CreatedDate": "2019-08-24T14:15:22Z",
  "LastContactedTime": "2019-08-24T14:15:22Z",
  "ModifiedDate": "2019-08-24T14:15:22Z",
  "ModifiedBy": "string",
  "ModifiedByType": 1,
  "Status": 1,
  "StatusDescription": "string",
  "SystemDiagnosticsStreamId": "string",
  "Components": [
    {
      "Id": "string",
      "ComponentType": "string",
      "DeviceStatusStreamId": "string",
      "NextHealthMessageExpectedStreamId": "string",
      "DiagnosticsStreams": [
        {
          "Id": "string",
          "NamespaceId": "string",
          "TypeId": "string"
        }
      ],
      "Status": 1,
      "StatusDescription": "string",
      "Errors": [
        "string"
      ]
    }
  ],
  "Tags": [
    "string"
  ],
  "IsVisible": true
}

TrusteeType

Enumerated Values

Property	Value
User	1
Client	2
Role	3

StatusCategory

Enumerated Values

Property	Value
Bad	1
Warning	2
Discovered	3
Good	4
Stopped	5

Component

Properties

Property Name	Data Type	Required	Nullable	Description
Id	string	false	true	Component unique identifier.
ComponentType	string	false	true	Type name for this component.
DeviceStatusStreamId	string	false	true	Stream identifier used to retrieve the component's status.
NextHealthMessageExpectedStreamId	string	false	true	Stream identifier used to retrieve the next health message expected time.
DiagnosticsStreams	[DiagnosticsStream]	false	true	List of diagnostics streams.
Status	StatusCategory	false	false	Last known status for this component.
StatusDescription	string	false	true	Last known status description for this component.
Errors	string[]	false	true	List of errors for this component.

{
  "Id": "string",
  "ComponentType": "string",
  "DeviceStatusStreamId": "string",
  "NextHealthMessageExpectedStreamId": "string",
  "DiagnosticsStreams": [
    {
      "Id": "string",
      "NamespaceId": "string",
      "TypeId": "string"
    }
  ],
  "Status": 1,
  "StatusDescription": "string",
  "Errors": [
    "string"
  ]
}

DiagnosticsStream

Properties

Property Name	Data Type	Required	Nullable	Description
Id	string	false	true	Unique identifier for this diagnostics stream.
NamespaceId	string	false	true	Namespace identifier for this diagnostics stream.
TypeId	string	false	true	Type name for this diagnostics stream.

{
  "Id": "string",
  "NamespaceId": "string",
  "TypeId": "string"
}

CONNECT data services developer documentation

Edge System

List Edge Systems

Request

Parameters

Response

Response Headers

Example response body

Get Edge Systems Summary

Request

Parameters

Response

Response Headers

Get Edge System

Request

Parameters

Response

Example response body

Show Or Hide System

Request

Parameters

Request Body

Response

List Tags

Request

Parameters

Response

Response Headers

Update Tags

Request

Parameters

Request Body

Response

Get Configuration

Request

Parameters

Response

Create Configuration

Request

Parameters

Response

Update Configuration

Request

Parameters

Response

Delete Configuration

Request

Parameters

Response

Definitions

ErrorResponse

Properties

EdgeSystem

Properties

TrusteeType

Enumerated Values

StatusCategory

Enumerated Values

Component

Properties

DiagnosticsStream

Properties

In This Topic

Related Links

`List Edge Systems`

`Get Edge Systems Summary`

`Get Edge System`

`Show Or Hide System`

`List Tags`

`Update Tags`

`Get Configuration`

`Create Configuration`

`Update Configuration`

`Delete Configuration`