POST /ariel/taggedfields

Edit online

Creates a new tagged field. To use this endpoint, you must have System Administrator or Security Admin permissions.

Creates a tagged field. To use this endpoint, you must have System Administrator or Security Admin permissions.

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

application/json

Table 2. POST /ariel/taggedfields request body details
Parameter Data Type MIME Type Description Sample

body

Object

application/json
The structure of the tagged field. The following fields can be set when creating a new tagged field:
  • name - String - The name of 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
  • private_enterprise_number - Integer - The Private Enterprise Number (e.g. IANA) for this tagged field.
  • element_id - Integer - The ID of the information element that this tagged field will represent. The element_id field combined with the private_enterprise_number field defines a particular portion of data within a QFlow record. The IANA standard information elements (with a private enterprise number greater than 0) are documented here: https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-information-elements.
  • 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.

{ "category_id": 42, "creation_date": 42, "description": "String", "element_id": 42, "is_array": true, "modified_date": 42, "name": "String", "private_enterprise_number": 42, "tag": 42, "type": "String", "uuid": "String" }
Table 3. POST /ariel/taggedfields response codes
HTTP Response Code Unique Code Description

201

The tagged field was created.

409

4000

A tagged field already exists with this private_enterprise_number and element_id.

409

4001

A tagged field already exists with this name.

422

4002

You must specify the private_enterprise_number parameter.

422

4003

The specified private_enterprise_number cannot be negative.

422

4004

You must specify the element_id parameter.

422

4005

You must specify the category_id parameter.

422

4006

The specified category ID is invalid.

422

4007

You must specify the name parameter.

422

4008

The specified name must be between 1 and 255 (inclusive) characters.

422

4009

You must specify the type parameter.

422

4010

The specified type is invalid.

422

4011

You must specify the is_array parameter.

500

1023

An error occurred while creating the new tagged field.

Response Description

201 response with the new tagged field structure. Location header set to the URL of the new tagged field ID.
  • 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"
}