POST public/v2/streams/{streamKey}/additional

Request Information

URI Parameters

NameDescriptionTypeAdditional information
streamKey

globally unique identifier

Required

Body Parameters

BitPool.Base.DTO.StreamAdditionalDto
NameDescriptionTypeAdditional information
SourceDeviceVendor

string

None.

SourceDeviceModel

string

None.

IsAccumulating

boolean

None.

AggregateType

BitPool.Base.Enums.AggregateType

None.

Calculation

string

None.

Units

BitPool.Base.Enums.Units

None.

TargetUsage

decimal number

None.

UpperThreshold15m

decimal number

None.

ChangeOfValue

boolean

None.

SpikeThreshold

decimal number

None.

Request Formats

application/json, text/json

Sample:
{
  "SourceDeviceVendor": "sample string 1",
  "SourceDeviceModel": "sample string 2",
  "IsAccumulating": true,
  "AggregateType": "None",
  "Calculation": "sample string 4",
  "Units": "None",
  "TargetUsage": 5.1,
  "UpperThreshold15m": 1.1,
  "ChangeOfValue": true,
  "SpikeThreshold": 1.1
}

application/xml, text/xml

Sample:
<StreamAdditionalDto>
  <SourceDeviceVendor>sample string 1</SourceDeviceVendor>
  <SourceDeviceModel>sample string 2</SourceDeviceModel>
  <IsAccumulating>true</IsAccumulating>
  <AggregateType>None</AggregateType>
  <Calculation>sample string 4</Calculation>
  <Units>None</Units>
  <TargetUsage>5.1</TargetUsage>
  <UpperThreshold15m>1.1</UpperThreshold15m>
  <ChangeOfValue>true</ChangeOfValue>
  <SpikeThreshold>1.1</SpikeThreshold>
</StreamAdditionalDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

string

Response Formats

application/json, text/json

Sample:
"sample string 1"

application/xml, text/xml

Sample:
<string>sample string 1</string>