FIC Gateway

This page describes operations you can perform on fic_gateways. List, and get details for.

List Fic Gateway

List all visible fic_gateways.

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{endpoint}/v2.0/fic_gateways

HTTP Request Parameters

Parameter

Style

Type

Format

Enumeration

Description

Required

description

query

string

-

-

Description of the FIC Gateway resource

no

fic_service_id

query

string

hyph-uuid-or-empty

-

FIC Service instantiated by this Gateway

no

id

query

string

-

-

Unique ID of the FIC Gateway resource

no

name

query

string

-

-

Name of the FIC Gateway resource

no

qos_option_id

query

string

hyph-uuid-or-empty

-

Quality of Service options selected for this Gateway

no

status

query

string

-

-

The FIC Gateway status.

no

tenant_id

query

string

non-hyph-uuid

-

Tenant ID of the owner (UUID)

no

Response

HTTP Response Code List

Response Code

Description

200

OK

400

Bad Request

401

UnAuthorized

404

Not Found

500

Internal Server Error

HTTP Response Parameters

Parameter

Type

Format

Description

fic_gateways

array<object>

datatype_fic_gateway

-

description

string

-

Description of the FIC Gateway resource

fic_service_id

string

hyph-uuid-or-empty

FIC Service instantiated by this Gateway

id

string

-

Unique ID of the FIC Gateway resource

name

string

-

Name of the FIC Gateway resource

qos_option_id

string

hyph-uuid-or-empty

Quality of Service options selected for this Gateway

status

string

-

The FIC Gateway status.

tenant_id

string

non-hyph-uuid

Tenant ID of the owner (UUID)

Examples

Sample Request Body

This operation does not send a request body.

Sample Response Body

{
  "fic_gateways": [
    {
      "description": "fic_gateway_inet_test, 10M-BE, member role",
      "fic_service_id": "d4006e79-9f60-4b72-9f86-5f6ef8b4e9e9",
      "id": "07f97269-e616-4dff-a73f-ca80bc5682dc",
      "name": "lab3-test-member-user-fic-gateway",
      "qos_option_id": "e41f6a2f-e197-41c8-9f71-ef19cfd2a85a",
      "status": "ACTIVE",
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
    },
    {
      "description": "",
      "fic_service_id": "d4006e79-9f60-4b72-9f86-5f6ef8b4e9e9",
      "id": "4c842674-60e4-48eb-b5a3-b902f832d0af",
      "name": "N000001996_V15000001",
      "qos_option_id": "aa776ce4-08a8-4cc1-9a2c-bb95e547916b",
      "status": "ACTIVE",
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
    }
  ]
}

Show Fic Gateway

Show details for fic_gateway.

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{endpoint}/v2.0/fic_gateways/{fic_gateway_id}

HTTP Request Parameters

Parameter

Style

Type

Format

Enumeration

Description

Required

fic_gateway_id

URI

string

hyph-uuid

-

Unique ID of the FIC Gateway resource

yes

Response

HTTP Response Code List

Response Code

Description

200

OK

400

Bad Request

401

UnAuthorized

404

Not Found

500

Internal Server Error

HTTP Response Parameters

Parameter

Type

Format

Description

fic_gateway

object

datatype_fic_gateway

-

description

string

-

Description of the FIC Gateway resource

fic_service_id

string

hyph-uuid-or-empty

FIC Service instantiated by this Gateway

id

string

-

Unique ID of the FIC Gateway resource

name

string

-

Name of the FIC Gateway resource

qos_option_id

string

hyph-uuid-or-empty

Quality of Service options selected for this Gateway

status

string

-

The FIC Gateway status.

tenant_id

string

non-hyph-uuid

Tenant ID of the owner (UUID)

Examples

Sample Request Body

This operation does not send a request body.

Sample Response Body

{
  "fic_gateway": {
    "description": "fic_gateway_inet_test, 10M-BE, member role",
    "fic_service_id": "d4006e79-9f60-4b72-9f86-5f6ef8b4e9e9",
    "id": "07f97269-e616-4dff-a73f-ca80bc5682dc",
    "name": "lab3-test-member-user-fic-gateway",
    "qos_option_id": "e41f6a2f-e197-41c8-9f71-ef19cfd2a85a",
    "status": "ACTIVE",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}