GET /ariel/flow_vlans

Edit online

Retrieves a list of available flow VLAN IDs in the Ariel database.

Retrieves a list of available flow VLAN IDs in the Ariel database.

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

application/json

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

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.

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.

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.
Table 3. GET /ariel/flow_vlans response codes
HTTP Response Code Unique Code Description

200

The flow VLAN ID list was retrieved.

500

1000

An error occurred while the flow VLAN ID list was being retrieved.

Response Description

An array of flow VLAN ID objects. A flow VLAN ID object contains the following fields:
  • id - Long - The ID of the flow VLAN field.
  • enterprise_vlan_id - Short - The enterprise VLAN ID.
  • customer_vlan_id - Short - The customer VLAN ID.

Response Sample


[
    {
        "customer_vlan_id": 42,
        "enterprise_vlan_id": 42,
        "id": 42
    }
]