Skip to main content
POST
/
data_stream_property_definitions
Create a property definition
curl --request POST \
  --url https://api.endclose.com/v1/data_stream_property_definitions \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "key": "<string>",
  "name": "<string>",
  "type": "number",
  "data_stream_key": "<string>",
  "id": 123,
  "optional": false
}
'
{
  "key": "<string>",
  "name": "<string>",
  "type": "number",
  "data_stream_key": "<string>",
  "id": 123,
  "optional": false
}

Authorizations

​
X-API-KEY
string
header
required

Body

application/json
​
key
string
required
​
name
string
required
​
type
enum<string>
required
Available options:
number,
date,
datetime,
string
​
data_stream_key
string
required

Must match an existing DataStream.key

​
id
integer
​
optional
boolean
default:false

Response

201 - application/json

Property definition created

​
key
string
required
​
name
string
required
​
type
enum<string>
required
Available options:
number,
date,
datetime,
string
​
data_stream_key
string
required

Must match an existing DataStream.key

​
id
integer
​
optional
boolean
default:false