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

Authorizations

X-API-KEY
string
header
required

Path Parameters

id
string
required

Response

200 - application/json

Property definition

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