Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

CONNECT data services developer documentation

Edge System Type

  • Last UpdatedJan 24, 2024
  • 3 minute read

List Types

Returns a list of supported Edge System types.

Request

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

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

Response

Status Code Body Type Description
200 Inline List of types in alphabetical order.
401 ErrorResponse Unauthorized.
403 ErrorResponse Forbidden.
500 ErrorResponse Internal server error.

List Type

Returns a supported Edge System type.

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/SoftwareManagement/Types/{edgeSystemTypeId}

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string edgeSystemTypeId
Edge System Type identifier.

Response

Status Code Body Type Description
200 Inline A supported Edge System type.
401 ErrorResponse Unauthorized.
404 ErrorResponse Client or tenant not found.
500 ErrorResponse Internal server error.

List Type Versions

Returns a list of an Edge System's supported versions.

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/SoftwareManagement/Types/{edgeSystemTypeId}/Versions

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string edgeSystemTypeId
Edge System Type identifier.

Response

Status Code Body Type Description
200 Inline List of versions of a supported Edge System.
401 ErrorResponse Unauthorized.
404 ErrorResponse Client or tenant not found.
500 ErrorResponse Internal server error.

List Type Version

Returns a supported Edge System version.

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/SoftwareManagement/Types/{edgeSystemTypeId}/Versions/{edgeSystemTypeVersion}

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string edgeSystemTypeId
Edge System Type identifier.

string edgeSystemTypeVersion
EdgeSystem Type Version identifier.

Response

Status Code Body Type Description
200 Inline Version information of an Edge System type.
401 ErrorResponse Unauthorized.
404 ErrorResponse Client or tenant not found.
500 ErrorResponse Internal server error.

List Type Version Dynamic Properties

Returns the template properties of a supported version of a supported Edge System type.

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/SoftwareManagement/Types/{edgeSystemTypeId}/Versions/{edgeSystemTypeVersion}/dynamicproperties

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string edgeSystemTypeId
Edge System Type identifier.

string edgeSystemTypeVersion
=Edge System Type Version identifier.

Response

Status Code Body Type Description
200 DynamicProperty[] List of template properties of a specific version of an Edge System type.
401 ErrorResponse Unauthorized.
404 ErrorResponse Unauthorized.
500 ErrorResponse Internal server error.

Example response body

200 Response (DynamicProperty[])

[
  {
    "Name": "string",
    "Type": "Secret"
  }
]

List Type Version Configuration Schema

Returns the configuration schema of a supported version of a supported Edge System type.

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/SoftwareManagement/Types/{edgeSystemTypeId}/Versions/{edgeSystemTypeVersion}/configurationschema

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string edgeSystemTypeId
Edge System Type identifier.

string edgeSystemTypeVersion
Edge System Version identifier.

Response

Status Code Body Type Description
200 Inline Configuration schema of a specific version of an Edge System type.
401 ErrorResponse Unauthorized.
404 ErrorResponse Client or tenant not found.
500 ErrorResponse Internal server error.

List Type Version Default Configuration (defaultconfig path)

Returns the default configuration of a supported version of a supported Edge System type.

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/SoftwareManagement/Types/{edgeSystemTypeId}/Versions/{edgeSystemTypeVersion}/defaultconfig

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string edgeSystemTypeId
Edge System Type identifier.

string edgeSystemTypeVersion
Edge System Version identifier.

Response

Status Code Body Type Description
200 Inline Default configuration of a specific version of an Edge System type.
401 ErrorResponse Unauthorized.
404 ErrorResponse Client or tenant not found.
500 ErrorResponse Internal server error.

List Type Version Default Configuration (defaultconfiguration path)

Returns the default configuration of a supported version of a supported Edge System type.

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/SoftwareManagement/Types/{edgeSystemTypeId}/Versions/{edgeSystemTypeVersion}/defaultconfiguration

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string edgeSystemTypeId
Edge System Type identifier.

string edgeSystemTypeVersion
Edge System Version identifier.

Response

Status Code Body Type Description
200 Inline Default configuration of a specific version of an Edge System type.
401 ErrorResponse Unauthorized.
404 ErrorResponse Client or tenant 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
}


DynamicProperty

Properties

Property Name Data Type Required Nullable Description
Name string false true None
Type DynamicPropertyType false false None
{
  "Name": "string",
  "Type": "Secret"
}


DynamicPropertyType

Enumerated Values

Property Value
Secret Secret

In This Topic
Related Links
TitleResults for “How to create a CRG?”Also Available in