List configured catalog definitions.

GET

/api/workspace/admin/catalogs

curl --request GET \
  --url https://example.com/api/workspace/admin/catalogs \
  --header 'Authorization: Bearer <token>'

Authorizations

• WorkspaceBearer

Parameters

Query Parameters

access_token

string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Responses

200

OK

Media typeapplication/json

object

Data

Array<object>

nullable

One catalog definition row for admin lists.

object

Id

Catalog definition identifier.

string

nullable

Key

Stable catalog key.

string

nullable

DisplayName

Catalog display name.

string

nullable

Description

Optional free-form description.

string

nullable

Kind

integer format: int32

Allowed values: 0 1 2

SecurityMode

integer format: int32

Allowed values: 0 1

CatalogAdministratorRoles

Roles allowed to read and administer the catalog tree at runtime.

Array<object>

nullable

One role allowed to administer root catalog folders at runtime.

object

RoleId

Role identifier.

string

nullable

RoleName

Role display name.

string

nullable

CatalogReaderRoles

Roles allowed to read the catalog at runtime.

Array<object>

nullable

One role allowed to read a catalog at runtime.

object

RoleId

Role identifier.

string

nullable

RoleName

Role display name.

string

nullable

TargetEntityDefinitionCount

Number of entity definitions admitted into the catalog.

integer format: int32

RowVersion

Concurrency token.

string format: uuid

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": [
    {
      "Kind": 0,
      "SecurityMode": 0
    }
  ],
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Forbidden

Media typeapplication/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}