GET /ariel/taggedfields

Retrieves a list of available tagged fields for Ariel catalog.

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
catalog	query	Optional	String	text/plain	Optional. The name of the Ariel database that contains the tagged fields that you want to retrieve.
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.

Table 3. GET /ariel/taggedfields response codes
HTTP Response Code	Unique Code	Description
200		The tagged field list was retrieved.
404	1002	The catalog does not exist
500	1020	Internal server error

Response Description

The list of available tagged fields.

Response Sample


[
    {
        "array": true,
        "catalog": "String",
        "created": 42,
        "deleted": true,
        "description": "String",
        "format_class_name": "String",
        "format_params": [
            "String"
        ],
        "modified": 42,
        "name": "String",
        "nullable": true,
        "tag": 42,
        "type": "String <one of: NULL, STRUCT, Byte, Short, Integer, Long, UnsignedByte, UnsignedShort, UnsignedInt, UnsignedLong, BigInteger, Double, Float, Port, Host, HostV4V6, HostV6, MACAddress, String, ByteArray, UnsignedIntHex, Boolean, Binary>"
    }
]