Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
A successful response.
The response of a call to ChannelService_GetChannel.
curl --request GET \
--url https://your-sift-api-url.com/api/v2/channels/{channelId} \
--header 'Authorization: Bearer <token>'{
"channel": {
"channelId": "<string>",
"name": "<string>",
"component": "<string>",
"assetId": "<string>",
"description": "<string>",
"unitId": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"modifiedDate": "2023-11-07T05:31:56Z",
"createdByUserId": "<string>",
"modifiedByUserId": "<string>",
"organizationId": "<string>",
"dataType": "CHANNEL_DATA_TYPE_UNSPECIFIED",
"enumTypes": [
{
"name": "<string>",
"key": 123,
"isSigned": true
}
],
"bitFieldElements": [
{
"name": "<string>",
"index": 123,
"bitCount": 123
}
],
"metadata": [
{
"key": {
"name": "<string>",
"type": "METADATA_KEY_TYPE_UNSPECIFIED",
"archivedDate": "2023-11-07T05:31:56Z"
},
"stringValue": "<string>",
"numberValue": 123,
"booleanValue": true,
"archivedDate": "2023-11-07T05:31:56Z"
}
]
}
}Retrieve a channel.
curl --request GET \
--url https://your-sift-api-url.com/api/v2/channels/{channelId} \
--header 'Authorization: Bearer <token>'{
"channel": {
"channelId": "<string>",
"name": "<string>",
"component": "<string>",
"assetId": "<string>",
"description": "<string>",
"unitId": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"modifiedDate": "2023-11-07T05:31:56Z",
"createdByUserId": "<string>",
"modifiedByUserId": "<string>",
"organizationId": "<string>",
"dataType": "CHANNEL_DATA_TYPE_UNSPECIFIED",
"enumTypes": [
{
"name": "<string>",
"key": 123,
"isSigned": true
}
],
"bitFieldElements": [
{
"name": "<string>",
"index": 123,
"bitCount": 123
}
],
"metadata": [
{
"key": {
"name": "<string>",
"type": "METADATA_KEY_TYPE_UNSPECIFIED",
"archivedDate": "2023-11-07T05:31:56Z"
},
"stringValue": "<string>",
"numberValue": 123,
"booleanValue": true,
"archivedDate": "2023-11-07T05:31:56Z"
}
]
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
A successful response.
The response of a call to ChannelService_GetChannel.
Show child attributes
Was this page helpful?