ON THIS PAGE
GET /ariel/taggedfields/{id}
SUMMARY Gets an individual tagged field.
Gets an individual tagged field.
MIME Type |
---|
application/json |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
id |
path |
Required |
Number (Integer) |
text/plain |
The ID of the tagged field that you want to get. |
fields |
query |
Optional |
String |
text/plain |
Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas. |
HTTP Response Code | Unique Code | Description |
---|---|---|
200 |
The tagged field with the specified ID. |
|
404 |
2000 |
The specified ID does not exist. |
422 |
1005 |
A field request parameter is not valid. |
500 |
1021 |
An error occurred while retrieving the tagged field. |
Response Description
- id - Long - The ID of the tagged field.
- tag - Integer - Unique number for this tagged field. This is a system-generated number produced from the private_enterprise_number and the element_id fields.
- name - String - The name of the tagged field.
- category_id - Integer - The ID of the logical group that this tagged field belongs to in the UI.
- is_array - Boolean - Specifies whether the tagged field is a list.
- description - String - (Optional) Description for the tagged field.
- type - String - The type of the tagged field. Possible values are: NULL, STRUCT, Byte, Short, Integer, Long, UnsignedByte, UnsignedShort, UnsignedInt, UnsignedLong, BigInteger, Double, Float, Port, Host, HostV4V6, HostV6, MACAddress, String, ByteArray, UnsignedIntHex, Boolean, Binary
- uuid - String - The ID for this tagged field, represented as a UUID.
- modified_date - Long - The time that the tagged field was last modified, specified in milliseconds since epoch.
- creation_date - Long - The time that the tagged field was created, specified in milliseconds since epoch.
Response Sample
{ "category_id": 42, "creation_date": 42, "description": "String", "id": 42, "is_array": true, "modified_date": 42, "name": "String", "tag": 42, "type": "String", "uuid": "String" }