GET public/v2/streams/{streamKey}

Return a specific stream

Request Information

URI Parameters

NameDescriptionTypeAdditional information
streamKey

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

BitPool.Base.Entities.BitStreamEntity
NameDescriptionTypeAdditional information
StreamKey

globally unique identifier

None.

LocalIndex

string

None.

Name

string

None.

Description

string

None.

RegistrationDate

date

None.

LastTimestamp

date

None.

FirstTimestamp

date

None.

LastValue

decimal number

None.

FirstValue

decimal number

None.

PoolKey

globally unique identifier

None.

Public

boolean

None.

Virtual

boolean

None.

VirtualType

BitPool.Base.Enums.StreamVirtualType

None.

Recalculate

boolean

None.

Weather

boolean

None.

Owner

boolean

None.

StreamLogsCount

integer

None.

PostProcessingType

BitPool.Base.Enums.PostProcessingType

None.

DataType

BitPool.Base.Enums.StreamDataType

None.

Response Formats

application/json, text/json

Sample:
{
  "StreamKey": "0ed05add-6d0e-4f11-bad5-a9f10e3d0555",
  "LocalIndex": "sample string 2",
  "Name": "sample string 3",
  "Description": "sample string 4",
  "RegistrationDate": "2019-05-19T19:41:08.631+00:00",
  "LastTimestamp": "2019-05-19T19:41:08.631+00:00",
  "FirstTimestamp": "2019-05-19T19:41:08.631+00:00",
  "LastValue": 1.1,
  "FirstValue": 1.1,
  "PoolKey": "688db8aa-38a0-4017-b971-140a81e44c9f",
  "Public": true,
  "Virtual": true,
  "VirtualType": "Default",
  "Recalculate": true,
  "Weather": true,
  "Owner": true,
  "StreamLogsCount": 12,
  "PostProcessingType": "None",
  "DataType": "Double"
}

application/xml, text/xml

Sample:
<BitStreamEntity>
  <StreamKey>0ed05add-6d0e-4f11-bad5-a9f10e3d0555</StreamKey>
  <LocalIndex>sample string 2</LocalIndex>
  <Name>sample string 3</Name>
  <Description>sample string 4</Description>
  <RegistrationDate>2019-05-19T19:41:08.6310311+00:00</RegistrationDate>
  <LastTimestamp>2019-05-19T19:41:08.6310311+00:00</LastTimestamp>
  <FirstTimestamp>2019-05-19T19:41:08.6310311+00:00</FirstTimestamp>
  <LastValue>1.1</LastValue>
  <FirstValue>1.1</FirstValue>
  <PoolKey>688db8aa-38a0-4017-b971-140a81e44c9f</PoolKey>
  <Public>true</Public>
  <Virtual>true</Virtual>
  <VirtualType>Default</VirtualType>
  <Recalculate>true</Recalculate>
  <Weather>true</Weather>
  <Owner>true</Owner>
  <StreamLogsCount>12</StreamLogsCount>
  <PostProcessingType>None</PostProcessingType>
  <DataType>Double</DataType>
</BitStreamEntity>