Raw Value Select

MachLake에 입력된 원시 센서 데이터를 얻기 위한 API이다.

HTTP Request

GET https://${CloudVendor}.${CountryCode}.machlake.com/lakes/${lake_id}/values/raw
Content-Type: application/json; charset=utf8
x-api-key: {API Key}

Parameters

Optional	Type	Description	Example
tag_name	string	tag name with , separator	&tag_name=tag1,tag2,tag3
start_time	string	start time of select (MUST be eralier than end_time) type 1 : time string format start_time=2018-01-16 14:40:05 000 or start_time=2018-01-16 14:40:05.000 type 2 : timestamp (second or millisecond) start_time=1618813188 or start_time=1618813188123	&start_time=2018-01-16 14:40:05 000 or &start_time=2018-01-16 14:40:05.000 or &start_time=1618813188 or &start_time=1618813188123 datetime in parameter is supported only up to millisecond
separator	string	separator for tag_name, columns, and_condition	&separator=\| (default : ,)
value_return_form	int	result set format	0 : separate standard (default) or 1 : merged standard
and_condition	string	filtering condition (need escape sequence) column name is wrapped in double quotes	&and_condition=”value” > 345,”name” = 'sjkim'
end_time	string	end time of select (MUST be later than start_time) same as start_time	same as start_time
date_format	string	date format of select time or timestamp type ("SECOND", "MILLISECOND", "MICROSECOND", "NANOSECOND")	&date_format=YYYY-MM-DD HH24:MI:SS or &date_format=MILLISECOND (default : YYYY-MM-DD HH24:MI:SS)
offset	int	count of skip	&offset=500
limit	int	count of display	&limit=1000 (default : Restricted by 'lake tier' by lake tier)
columns	string	columns to filter out	&columns=value,value2 (default : value) name, time is the default choice
aliases	string	columns to be aliased (Must be blank or equal to columns,)	&aliases=myvalue,myvalue2 Can not be use alias for name and time.
direction	int	ascend or descent by time	&direction=0 : ascend (default) or &direction=1 : descend

Request Example

GET https://aws1.us.machlake.com/lakes/xbacd1234/values/raw?tag_name=tag_01&start_time=2021-07-06 12:12:22&end_time=2021-07-06 12:12:27&columns=VALUE&aliases=MyVal&separator=,&limit=1000&value_return_form=0
Content-Type: application/json; charset=utf8
x-api-key: {API Key}

Response Example

Status 200

// return format = 0
{
    "status": "success",
    "data": {
        "calc_mode": "raw",
        "columns": [
            {"name": "TIME", "type": 5, "length": 4096},
            {"name": "MyVal", "type": 20, "length": 17}
        ],
        "samples": [
            {
                "tag_name": "tag_01",
                "data": [
                    {"MyVal": 1234, "TIME": "2021-07-06 12:12:22"},
                    {"MyVal": 2345, "TIME": "2021-07-06 12:12:23"},
                    {"MyVal": 2346, "TIME": "2021-07-06 12:12:24"},
                    {"MyVal": 1625, "TIME": "2021-07-06 12:12:25"}
                ]
            }
        ]
    }
}

// return format = 1
{
    "status": "success",
    "data": {
        "calc_mode": "raw",
        "columns": [
            {"name": "TIME", "type": 5, "length": 4096},
            {"name": "MyVal", "type": 20, "length": 17}
        ],
        "samples": [
            {
                "tag_name": "tag_01",
                "data": {
                    "MyVal": [
                        1234,
                        2345,
                        2346,
                        1625
                    ],
                    "TIME": [
                        "2021-07-06 12:12:22",
                        "2021-07-06 12:12:23",
                        "2021-07-06 12:12:24",
                        "2021-07-06 12:12:25"
                    ]
                }
            }
        ]
    }
}

Sample Code

In this sample, try to show variety parameter combination, but can’t show all combination, but should find parameter option from using this sample

window(batch)

linux(shell)

javascript

python