Query DB for Tenant Extensions (v2.0)

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

Query DB for limit number of tenant extensions that match the query params.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

application/json

Body

Tenant details

conf objectrequired
disabled boolean

List the disabled extensions.

id string

The ID.

name stringrequired

The name of the extension. Max size = 128.

namespace stringrequired

The extension namespace. Values = ^[a-z][a-z0-9/]*[a-z0-9]+$.

tenant_id stringrequired

The tenant ID.

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 ExtensionQueryFilter[]
Array [
conf objectrequired
disabled boolean
List the disabled extensions.
id string
The ID.
name stringrequired
The name of the extension. Max size = 128.
namespace stringrequired
The extension namespace. Values = ^[a-z][a-z0-9/]*[a-z0-9]+$.
tenant_id stringrequired
The tenant ID.
]

Example (from schema)

{
  "count": 0,
  "deleted_count": 0,
  "deleted_ids": [
    "string"
  ],
  "id": "string",
  "next_query": {},
  "tenant_id": "string",
  "total_count": 0,
  "items": [
    {
      "conf": {},
      "disabled": true,
      "id": "string",
      "name": "string",
      "namespace": "string",
      "tenant_id": "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...