:::

API 介面說明

歡迎使用 SensorThings API 教學服務,以下說明將幫助您了解 API 各項介面功能,如果有任何疑問,歡迎您留言給我們,我們會儘速回答相關問題。

URI結構


OGC SensorThings API 服務將相同類型的實體分組為實體集合。每個實體都有唯一的標識符和一對多屬性。此外,如果實體與其他實體集合中的實體保持關係,則這種類型的關係用導航屬性(即 navigationLinkassociationLink )表示。

因此,為了對資源執行查詢,第一步是通過 URI 尋址目標資源。這裡有使用三個主要組成部分的 URI,即:(1)網路服務之 URI,(2)資源的路徑,以及(3)查詢選項。另外,服務之 URI 由兩部分組成:(1)SensorThings 服務的位置和(2)版本號。

版本號的格式如下所示:
V1.0V主要版本號 .次要版本號
URI結構

通過在服務 URI 之後附加資源路徑,客戶端可以處理不同類型的資源,例如實體集合,實體,屬性或導航屬性。最後,客戶端可以在資源路徑之後應用查詢選項來進一步處理已處理的資源,例如按屬性進行排序或按條件進行篩選。

資源路徑


資源路徑位於服務 URI 後面,可用於指定不同的資源。 ▸▸ 點擊此處查詢使用方式。

查詢運算符


客戶向 OGC SensorThings API 服務發送 HTTP GET 請求以獲取數據。URL 的資源路徑指定了請求的目標。 查詢運算符前綴為美元($)字符,並在請求 URI 中的問號()後面指定為鍵值對。

許多 OGC SensorThings API 的查詢選項都是根據 OData 的查詢選項進行調整的,其他查詢運算符可以通過查詢選項指定,顯示如下。

查詢選項


$select$expand 系統查詢選項使客戶端能夠指定要包含在回應中的一組屬性。
OGC SensorThings API 適用於許多 OData 的系統查詢選項及其使用情況。這些查詢選項允許優化請求。
服務請求的結果根據查詢選項按以下順序進行評估。

在應用任何服務驅動的分頁之前:
$filter
$count
$orderby
$skip
$top

在應用任何服務驅動的分頁之後:
$expand
$select