GET /ariel/taggedfields

Gets the list of tagged fields.

Gets the list of tagged fields.

Table 1. GET /ariel/taggedfields resource details
MIME Type

application/json

Table 2. GET /ariel/taggedfields request parameter details
Parameter Type Optionality Data Type MIME Type Description

Range

header

Optional

String

text/plain

Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.

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.

filter

query

Optional

String

text/plain

Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.

sort

query

Optional

String

text/plain

Optional - This parameter is used to sort the elements in a list.

Table 3. GET /ariel/taggedfields response codes
HTTP Response Code Unique Code Description

200

An array of tagged fields.

422

1005

A field request parameter is not valid.

422

1010

Invalid filter criteria supplied.

422

1015

The sort field or order is not valid.

500

1020

An error occurred while retrieving the tagged fields.

Response Description

An array of tagged fields. The category_id field is used as the default sort input in ascending order. A tagged field object contains the following fields:
  • 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"
    }
]