From a1ee05735671d09201c83c5285ee06df472548b7 Mon Sep 17 00:00:00 2001 From: Angie Chiu Date: Tue, 5 Jan 2016 16:21:01 +0800 Subject: [PATCH] MCS-2769 API reference retrieve datapoint zh_cn update --- .../en/api_references/retrieve_datapoint.md | 28 ++++----- .../api_references/retrieve_datapoint.md | 61 ++++++------------- .../api_references/retrieve_datapoint.md | 27 ++++---- 3 files changed, 41 insertions(+), 75 deletions(-) diff --git a/content/en/api_references/retrieve_datapoint.md b/content/en/api_references/retrieve_datapoint.md index b20b911..f855d42 100755 --- a/content/en/api_references/retrieve_datapoint.md +++ b/content/en/api_references/retrieve_datapoint.md @@ -20,29 +20,25 @@ The API will by default assume the json format, if you want to use the csv, plea The API enables you to retrieve four kinds of data: * To get the last data point: - - - - `https://api.mediatek.com/mcs/v2/devices/:deviceId/datachannels/:datachannelId/datapoints` +``` +https://api.mediatek.com/mcs/v2/devices/:deviceId/datachannels/:datachannelId/datapoints +``` * To get the data points within a time frame: - - - Use the `?start=:startTime&end=:endTime` at the end. - +``` +Use the `?start=:startTime&end=:endTime` at the end. +``` * To limit the number of data points that you will get (eg, if you enter the limit=5, you will get the first 5 data points.): - - - Use the `?limit=:limit`at the end. - +``` +Use the `?limit=:limit`at the end. +``` * To retrieve the data points from a specific point(eg, if you enter offset=5, you will not get the first 5 data points and start with 6th one): - - - Use the `?offset=:offset` at the end. - +``` +Use the `?offset=:offset` at the end. +``` You can choose to combine those conditions. diff --git a/content/zh-CN/api_references/retrieve_datapoint.md b/content/zh-CN/api_references/retrieve_datapoint.md index a0f5c09..9f7e71b 100755 --- a/content/zh-CN/api_references/retrieve_datapoint.md +++ b/content/zh-CN/api_references/retrieve_datapoint.md @@ -5,69 +5,42 @@ 使用**HTTPs GET** 来取得装置回传的资料点 +## 请求 URL + +使用 **HTTPs GET** 来取得装置回传的资料点 + + ## 请求 URL 读取特定资料通道中的资料点： ``` https://api.mediatek.com/mcs/v2/devices/:deviceId/datachannels/:datachannelId/datapoints?start=:startTime&end=:endTime&limit=:limit&offset=:offset - ``` API 请求默认值为 JSON 格式，如欲使用 CSV 格式，请在 API 请求 URL 最后端加上`.csv`。 - 使用此 API，您可以选择您要的资料范围： * 只读取最后一个资料点： +``` + https://api.mediatek.com/mcs/v2/devices/:deviceId/datachannels/:datachannelId/datapoints +``` - -* 读取一段时间范围内的资料点： - - - 在请求 url 尾端加上`?start=:startTime&end=:endTime` - - -* 限制您要读取的资料点数目(举例来说, 如果您输入 limit=5 , 则您会读取前五笔资料点): - - - 在请求 url 尾端加上 `?offset=:offset` - - -* 读取从某一个资料点受开始的资料(举例来说, 如果您输入 offset=5, 则您会读取第五笔资料点之后的所有资料点): - - - Use the `?offset=:offset` at the end. - - - -您亦可以将以上四种方式混合使用。 - -使用 **HTTPs GET** 来取得装置回传的资料点 - - -## 请求 URL - -读取特定资料通道中的资料点： -API 请求默认值为 JSON 格式，如欲使用 CSV 格式，请在 API 请求 URL 最后端加上`.csv`。 -使用此 API，您可以选择您要的资料范围： - -* 只读取最后一个资料点： * 读取一段时间范围内的资料点： - 在请求 url 尾端加上`?start=:startTime&end=:endTime` - +``` +在请求 url 尾端加上`?start=:startTime&end=:endTime` +``` * 限制您要读取的资料点数目(举例来说, 如果您输入 limit=5, 则您会读取前五笔资料点): - - - 在请求 url 尾端加上 `?limit=:limit` - +``` +在请求 url 尾端加上 `?limit=:limit` +``` * 读取从某一个资料点受开始的资料(举例来说, 如果您输入 offset=5, 则您会读取第五笔资料点之后的所有资料点): - - - 在请求 url 尾端加上 `?offset=:offset` - +``` +在请求 url 尾端加上 `?offset=:offset` +``` 您亦可以将以上四种方式混合使用。 diff --git a/content/zh-TW/api_references/retrieve_datapoint.md b/content/zh-TW/api_references/retrieve_datapoint.md index 76d6aa8..8b64b74 100755 --- a/content/zh-TW/api_references/retrieve_datapoint.md +++ b/content/zh-TW/api_references/retrieve_datapoint.md @@ -18,28 +18,25 @@ API 請求默認值為 JSON 格式，如欲使用 CSV 格式，請在 API 請求 使用此 API，您可以選擇您要的資料範圍： * 只讀取最後一個資料點： - - - `https://api.mediatek.com/mcs/v2/devices/:deviceId/datachannels/:datachannelId/datapoints` +``` +https://api.mediatek.com/mcs/v2/devices/:deviceId/datachannels/:datachannelId/datapoints +``` * 讀取一段時間範圍內的資料點： - - - 在請求url尾端加上`?start=:startTime&end=:endTime` - +``` +在請求url尾端加上`?start=:startTime&end=:endTime` +``` * 限制您要讀取的資料點數目 (舉例來說, 如果您輸入 limit=5, 則您會讀取前五筆資料點): - - - 在請求url尾端加上 `?limit=:limit` - +``` +在請求url尾端加上 `?limit=:limit` +``` * 讀取從某一個資料點受開始的資料(舉例來說, 如果您輸入 offset=5, 則您會讀取第五筆資料點之後的所有資料點): - - - 在請求url尾端加上 `?offset=:offset` - +``` +在請求url尾端加上 `?offset=:offset` +``` 您亦可以將以上四種方式混合使用。