API DocsRESTChannel service

GetChannel

Retrieve a channel.

GET
/api/v2/channels/{channelId}

Path Parameters

channelId
Required
string

curl -X GET "<API_URL>/api/v2/channels/string" \
  -H "Authorization: Bearer <API_KEY>"

A successful response.

{
  "channel": {
    "channelId": "string",
    "name": "string",
    "component": "string",
    "assetId": "string",
    "description": "string",
    "unitId": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "modifiedDate": "2019-08-24T14:15:22Z",
    "createdByUserId": "string",
    "modifiedByUserId": "string",
    "organizationId": "string",
    "dataType": "CHANNEL_DATA_TYPE_UNSPECIFIED",
    "enumTypes": [
      {
        "name": "string",
        "key": 0
      }
    ],
    "bitFieldElements": [
      {
        "name": "string",
        "index": 0,
        "bitCount": 0
      }
    ]
  }
}