Search Thing Model¶
Search thing models via the orgId
.
Operation Permissions¶
Required Authorization |
Required Operation Permission |
---|---|
Model Management |
Read |
Request Format¶
POST https://{apigw-address}/model-service/v2.1/thing-models?action=search
Request Parameters (URI)¶
Name |
Location (Path/Query) |
Mandatory/Optional |
Data Type |
Description |
---|---|---|---|---|
orgId |
Query |
Mandatory |
String |
The organization ID which the asset belongs to. How to get orgId>> |
scope |
Query |
Optional |
Integer |
|
Request Parameters (Body)¶
Name |
Mandatory/Optional |
Data Type |
Description |
---|---|---|---|
expression |
Optional |
String |
The query expression, which supports sql-like query. The fields that are supported for query include: |
projection |
Optional |
Projection Struct |
Enables you to crop the data result set returned in the request if needed. Only the specified fields will be returned in the data result set if this parameter is used. Otherwise all fields are returned. The supported fields are: |
pagination |
Optional |
Pagination Request Struct |
Lists the paging requirements in a request. When not specified, 10 records are displayed per page by default. Note that if the |
Response Parameters¶
Name |
Data Type |
Description |
---|---|---|
data |
Array of ThingModel Structs |
A list of the thing models returned. For details of a Thingmodel Struct, see ThingModel Struct . |
ThingModel Struct ¶
Name |
Data Type |
Description |
---|---|---|
modelId |
String |
The model ID which the asset belongs to. |
modelIdPath |
String |
The model ID path. |
orgId |
String |
The organization ID which the asset belongs to. |
name |
StringI18n |
The model name. |
desc |
String |
The model description. |
tags |
Map |
User-defined tags. (The Key and Value are of String type.) |
attributes |
Map |
The key is the static attribute ID, of String type, and the value is of the |
measurepoints |
Map |
The key is the measurement point ID, of String type, and the value is of the |
services |
Map |
The key is the service ID, of String type, and the value is of the |
events |
Map |
The key is the event ID, of String type, and the value is of the |
ThingAttribute Struct ¶
Name |
Data Type |
Description |
---|---|---|
identifier |
String |
The attribute ID. |
dataType |
String |
The data type. E.g.: ARRAY, BOOL, DATE, ENUM, INT, FLOAT, DOUBLE, STRUCT, STRING, TIMESTAMP, FILE |
dataDefinition |
String |
The data definition of the |
isRequired |
Boolean |
If true, the value of this attribute must be set when the asset is instantiated; otherwise the asset will return a validation failure error when it is created. |
defaultValue |
As defined in the thing model |
The default value of the attribute. If the attribute has no default value, |
name |
StringI18n |
The attribute name. |
desc |
String |
The attribute description. |
tags |
Map |
User-defined tags. (The Key and Value are of String type.) |
isStdElement |
Boolean |
|
stdElementId |
String |
The URN of the element if If |
unit |
Unit Struct |
For more information, see Unit Struct . |
ThingMeasurepoint Struct ¶
Name |
Data Type |
Description |
---|---|---|
identifier |
String |
The ID of the measurement point. |
dataType |
String |
Data type. E.g.: ARRAY, BOOL, DATE, ENUM, INT, FLOAT, DOUBLE, STRUCT, STRING, TIMESTAMP, FILE |
dataDefinition |
String |
The data definition of the |
name |
StringI18n |
The measurement point name. |
desc |
String |
The measurement point description. |
tags |
Map |
User-defined tags. (The Key and Value are of String type.) |
isStdElement |
Boolean |
|
stdElementId |
String |
The URN of the element if If |
hasQuality |
Boolean |
|
signalType |
String |
The signal/point type. E.g.: Generic, AI, PI, DI |
unit |
Unit Struct |
For more information, see Unit Struct . |
ThingService Struct ¶
Name |
Data Type |
Description |
---|---|---|
identifier |
String |
The service ID. |
name |
StringI18n |
The service name. |
desc |
String |
The service description. |
tags |
Map |
User-defined tags. (The Key and Value are of String type.) |
isStdElement |
Boolean |
|
stdElementId |
String |
The URN of the element if If |
intputData |
ThingDatapoint Struct |
The service’s input parameters list. For more information, see ThingDatapoint Struct . |
outputData |
ThingDatapoint Struct |
The service’s returned parameters list. For more information, see ThingDatapoint Struct . |
callType |
String |
The calling type. This parameter will be deprecated.
|
ThingEvent Struct ¶
Name |
Data Type |
Description |
---|---|---|
identifier |
String |
The event ID. |
name |
StringI18n |
The event name. |
desc |
String |
The event description. |
tags |
Map |
User-defined tags. (The Key and Value are of String type.) |
isStdElement |
Boolean |
|
stdElementId |
String |
The URN of the element if If |
outputData |
ThingDatapoint Struct |
The event’s returned parameters list. For more information, see ThingDatapoint Struct |
eventType |
String |
Event type. E.g.: INFO, WARN, ERROR |
ThingDatapoint Struct ¶
Name |
Data Type |
Description |
---|---|---|
identifier |
String |
The data point ID. |
dataType |
String |
Data type. E.g.: ARRAY, BOOL, DATE, ENUM, INT, FLOAT, DOUBLE, STRUCT, STRING, TIMESTAMP, FILE |
dataDefinition |
String |
The data definition of the |
name |
StringI18n |
The data point name. |
desc |
String |
The data point description. |
tags |
Map |
User-defined tags. (The Key and Value are of String type.) |
isStdElement |
Boolean |
|
stdElementId |
String |
The URN of the element if If |
unit |
Unit Struct |
For more information, see Unit Struct |
Unit Struct ¶
Name |
Data Type |
Description |
---|---|---|
unitId |
String |
The unit ID. |
multiplier |
String |
The multiplier of the unit. For more information, see Multiplier |
Multiplier ¶
The multiplier of the unit can take the following values:
YOTTA ,//Y 10^24
ZETTA ,//Z 10^21
EXA ,//E 10^18
PETA ,//P 10^15
TERA ,//T 10^12
GIGA ,//G 10^9
MEGA ,//M 10^6
KILO ,//k 10^3
HECTO ,//h 10^2
DECA ,//da 10^1
ONE ,// 10^0
DECI ,//d 10^-1
CENTI ,//c 10^-2
MILLI ,//m 10^-3
MICRO ,//μ 10^-6
NANO ,//n 10^-9
PICO ,//p 10^-12
FEMTO ,//f 10^-15
ATTO ,//a 10^-18
ZEPTO ,//z 10^-21
YOCTO ,//y 10^-24
Error Codes¶
Samples¶
Request Sample¶
url: https://{apigw-address}/model-service/v2.1/thing-models?action=search&orgId=yourOrgId&scope=1
method: POST
requestBody:
{
"expression": "modelId in ( \"planet\", \"noiseSensor\" )",
"pagination": {
"pageNo": 1,
"pageSize": 10
},
"orgId": "yourOrgId"
}
Return Sample¶
{
"code":0,
"msg":"OK",
"requestId":"c6594307-bc30-4380-9869-b8a88b9494de",
"data":[
{
"modelId":"planet",
"modelIdPath":"/planet",
"orgId":"yourOrgId",
"name":{
"defaultValue":"planet",
"i18nValue":{
"en_US":"planet"
}
},
"desc":"test",
"tags":{
},
"attributes":{
"starsystem":{
"identifier":"starsystem",
"name":{
"defaultValue":"star system",
"i18nValue":{
"en_US":"star system"
}
},
"desc":"",
"tags":{
},
"stdElementId":"urn:user:modelelement:std:atom-property-int:1.0",
"isStdElement":true,
"dataType":"STRING",
"unit":null,
"isRequired":false,
"defaultValue":null
}
},
"measurepoints":{
"temperature":{
"identifier":"temperature",
"name":{
"defaultValue":"temperature",
"i18nValue":{
"en_US":"temperature"
}
},
"desc":"temperature",
"tags":{
},
"stdElementId":"urn:user:modelelement:std:atom-property-int:1.0",
"isStdElement":true,
"dataType":"FLOAT",
"hasQuality":false,
"signalType":"Generic",
"unit":{
"unitId":"°C",
"multiplier":"ONE"
}
}
},
"services":{
"speedup":{
"identifier":"speedup",
"name":{
"defaultValue":"speedup",
"i18nValue":{
"en_US":"speedup"
}
},
"desc":"t",
"tags":{
},
"outputData":[
{
"identifier":"delta",
"name":{
"defaultValue":"delta",
"i18nValue":{
"en_US":"delta"
}
},
"desc":"",
"tags":{
},
"dataType":"INT",
"unit":null
}
],
"inputData":[
{
"identifier":"delta",
"name":{
"defaultValue":"delta",
"i18nValue":{
"en_US":"delta"
}
},
"desc":"",
"tags":{
},
"dataType":"INT",
"unit":{
"unitId":"rpm",
"multiplier":"ONE"
}
}
],
"callType":"ASYNC"
}
},
"events":{
"alert":{
"identifier":"alert",
"name":{
"defaultValue":"alert",
"i18nValue":{
"en_US":"alert"
}
},
"desc":"e",
"tags":{
},
"outputData":[
{
"identifier":"event1",
"name":{
"defaultValue":"event1",
"i18nValue":{
"en_US":"event1"
}
},
"desc":"",
"tags":{
},
"dataType":"INT",
"unit":null
}
],
"eventType":"ERROR"
}
}
},
{
"modelId":"noiseSensor",
"modelIdPath":"/noiseSensor",
"orgId":"yourOrgId",
"name":{
"defaultValue":"Noise Sensor",
"i18nValue":{
"en_US":"Noise Sensor"
}
},
"desc":"Noise Sensor",
"tags":{
},
"attributes":{
},
"measurepoints":{
},
"services":{
},
"events":{
}
}
],
"pagination":{
"pageNo":1,
"pageSize":10,
"totalSize":2
}
}
Java SDK Sample¶
public class SearchThingModel {
private static String accessKey = "yourAppAccessKey";
private static String secretKey = "yourAppSecretKey";
private static String orgId = "yourOrgId";
private static String url = "https://{apigw-address}";
public static void main(String[] args) {
SearchThingModelRequest request = new SearchThingModelRequest();
request.setOrgId(orgId);
request.setExpression("modelId in ( \"planet\" )");
Projection projection = new Projection();
projection.add("modelId");
projection.add("name");
request.setProjection(projection);
SearchThingModelResponse response = Poseidon.config(PConfig.init().appKey(accessKey).appSecret(secretKey).debug())
.url(url)
.getResponse(request, request.getResponseClass());
System.out.println(response.getData());
}
}