INC Platform - Resource Management

Query Device Additional Information Definitions

Query all device additional information definitions.

Interface URI

/plat/res/devAppend/getAllDefine

Access Method

HTTP
GET
Parameters
None

Return Values

Status Codes
  • 200 (OK): Success.
Message Body
        	
<list>
 
<devAppendDefine> 
 <id>1</id>
 <appendId>3</appendId>
 <fieldName>weight(kg)</fieldName>
 <fieldNotEmpty>true</fieldNotEmpty>
 <fieldType>1</fieldType>
 <fieldMax>110</fieldMax>
 <fieldMin>0</fieldMin>
 <defaultValue>0</defaultValue>
 <fieldPriority>2</fieldPriority>
</devAppendDefine>    
...
</list>
Element Description
Subelements for device additional information
id Device additional information ID.
Integer type. Required. No default value.
appendId Device additional information appendId.
Integer type. Required. No default value.
fieldName Device additional information name.
String type. Required. No default value.
fieldNotEmpty Whether the value can be empty.
Boolean type. Required. No default value.
fieldType Type of the input value.
Integer type. 1: Integer. 2: Decimal. 3: Alphanumeric value. 4: Character. 5: Options.
fieldMin Minimum value.
Integer type. Available only when fieldType is set to 1 or 2.
fieldMax Maximum value.
Integer type. Available only when fieldType is set to 1 or 2.
defaultValue Default value.
Varies by fieldType. The default value can be empty when fieldNotEmpty is set to true.
fieldPriority Priority. The priority has a default value.
Integer type. If you do not configure the priority, the system assigns the default value.
options Options.
Character string list that stores data when fieldType is set to 5.

Example

Query and list all device additional information definitions.

Request
GET http://host:8080/imcrs/plat/res/devAppend/getAllDefine
accept: application/xml
...
Response
HTTP/1.1 200 OKContent-Type: application/xml

...
<list>
 
<devAppendDefine> 
 <id>12</id>
 <appendId>3</appendId>
 <fieldName>weight(kg)</fieldName>
 <fieldNotEmpty>true</fieldNotEmpty>
 <fieldType>1</fieldType>
 <fieldMax>110</fieldMax>
 <fieldMin>0</fieldMin>
 <defaultValue>0</defaultValue>
 <fieldPriority>2</fieldPriority>
</devAppendDefine>    
...
</list>