GET /ariel/flow_vlans/{id}

Retrieves a flow VLAN ID object by VLAN ID.

Retrieves a flow VLAN ID object by VLAN ID.

Table 1. GET /ariel/flow_vlans/{id} resource details
MIME Type

application/json

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

id

path

Required

Number (Integer)

text/plain

Required - The ID of the flow VLAN 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/flow_vlans/{id} response codes
HTTP Response Code Unique Code Description

200

The flow VLAN id object was retrieved.

404

1010

No flow VLAN was found for the provided flow VLAN ID.

500

1011

An error occurred while the flow VLAN field was being retrieved.

Response Description

The flow VLAN ID after it is retrieved. 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
}