Query DB for Network Contexts (v2.0)

POST 
/v2.0/api/tenants/:tenant_id/networkcontexts/query

Query DB for limit number of network contexts that match the query parameters.

Request

Path Parameters

tenant_id stringrequired

The ID of the tenant.

application/json

Body

Details of the query for lan segment

description

The description of the LAN segment. Maz size = 256.

id string

The ID of the LAN segment.

name string

The name of the LAN segment. Max size = 128.

Responses

200

Successful Operation

application/json

Schema

Schema

count int32

The actual count.

deleted_count int64

The deleted number.

deleted_ids string[]

The deleted IDs.

description

Description of the query. Max size = 256.

id string

The ID.

next_query object

Details of the next query.

tenant_id string

The tenant ID.

total_count int64

Total number.

items NetworkContextQueryFilter[]
Array [
description
The description of the network context config. Maz size = 256.
id string
The ID of the network context.
name stringrequired
The name of the network context config. Max size = 128.
]

Example (from schema)

{
  "count": 0,
  "deleted_count": 0,
  "deleted_ids": [
    "string"
  ],
  "id": "string",
  "next_query": {},
  "tenant_id": "string",
  "total_count": 0,
  "items": [
    {
      "id": "string",
      "name": "string"
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "BAD_REQUEST"
      }
    ]
  }
}

Loading...