Return typed page-generator, entity-field, working-page, and optional runtime-menu capabilities.

GET

/api/workspace/admin/ui-project/page-generators/catalog

curl --request GET \
  --url https://example.com/api/workspace/admin/ui-project/page-generators/catalog

Authorizations

• None

Parameters

Query Parameters

revisionId

string

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

Catalog used to configure the page wizard.

object

BaseRevisionId

string

nullable

BaseSourceChecksum

string

nullable

Generators

Array<object>

nullable

One supported deterministic page generator.

object

Kind

integer format: int32

Allowed values: 0 1 2 3

NameKey

string

nullable

DescriptionKey

string

nullable

ExternalApiPresets

Array<object>

nullable

One supported external API example preset.

object

Preset

integer format: int32

Allowed values: 0

NameKey

string

nullable

DescriptionKey

string

nullable

ProviderUrl

string

nullable

DefaultBaseCurrency

string

nullable

DefaultQuoteCurrencies

Array<string>

nullable

Entities

Array<object>

nullable

Safe generator capability projection for one Entity Definition.

object

Id

string

nullable

Key

string

nullable

DisplayNameSingular

string

nullable

DisplayNamePlural

string

nullable

SearchConfigured

boolean

Fields

Array<object>

nullable

Safe generator capability projection for one Entity Definition field.

object

Id

string

nullable

Key

string

nullable

DisplayName

string

nullable

FieldType

integer format: int32

Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

CanUseAsListColumn

boolean

CanUseAsQuickFilter

boolean

CanSort

boolean

CanUseOnDetailsPage

boolean

SelectOptions

Array<object>

nullable

One display-safe Select option exposed to the generator.

object

Key

string

nullable

Value

string

nullable

Pages

Array<object>

nullable

One page declared by the selected working source revision.

object

Key

string

nullable

TitleKey

string

nullable

Icon

string

nullable

Layout

integer format: int32

Allowed values: 0 1

RoutePath

string

nullable

RouteParameters

Array<string>

nullable

EntityDefinitionId

string

nullable

RuntimeMenus

Array<object>

nullable

One runtime menu available for optional root-leaf placement.

object

Id

string

nullable

Name

string

nullable

CanPlaceInRuntimeMenu

boolean

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": {
    "Generators": [
      {
        "Kind": 0
      }
    ],
    "ExternalApiPresets": [
      {
        "Preset": 0
      }
    ],
    "Entities": [
      {
        "Fields": [
          {
            "FieldType": 0
          }
        ]
      }
    ],
    "Pages": [
      {
        "Layout": 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"
}

409

Conflict

Media typeapplication/json

object

Data

Catalog used to configure the page wizard.

object

BaseRevisionId

string

nullable

BaseSourceChecksum

string

nullable

Generators

Array<object>

nullable

One supported deterministic page generator.

object

Kind

integer format: int32

Allowed values: 0 1 2 3

NameKey

string

nullable

DescriptionKey

string

nullable

ExternalApiPresets

Array<object>

nullable

One supported external API example preset.

object

Preset

integer format: int32

Allowed values: 0

NameKey

string

nullable

DescriptionKey

string

nullable

ProviderUrl

string

nullable

DefaultBaseCurrency

string

nullable

DefaultQuoteCurrencies

Array<string>

nullable

Entities

Array<object>

nullable

Safe generator capability projection for one Entity Definition.

object

Id

string

nullable

Key

string

nullable

DisplayNameSingular

string

nullable

DisplayNamePlural

string

nullable

SearchConfigured

boolean

Fields

Array<object>

nullable

Safe generator capability projection for one Entity Definition field.

object

Id

string

nullable

Key

string

nullable

DisplayName

string

nullable

FieldType

integer format: int32

Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

CanUseAsListColumn

boolean

CanUseAsQuickFilter

boolean

CanSort

boolean

CanUseOnDetailsPage

boolean

SelectOptions

Array<object>

nullable

One display-safe Select option exposed to the generator.

object

Key

string

nullable

Value

string

nullable

Pages

Array<object>

nullable

One page declared by the selected working source revision.

object

Key

string

nullable

TitleKey

string

nullable

Icon

string

nullable

Layout

integer format: int32

Allowed values: 0 1

RoutePath

string

nullable

RouteParameters

Array<string>

nullable

EntityDefinitionId

string

nullable

RuntimeMenus

Array<object>

nullable

One runtime menu available for optional root-leaf placement.

object

Id

string

nullable

Name

string

nullable

CanPlaceInRuntimeMenu

boolean

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": {
    "Generators": [
      {
        "Kind": 0
      }
    ],
    "ExternalApiPresets": [
      {
        "Preset": 0
      }
    ],
    "Entities": [
      {
        "Fields": [
          {
            "FieldType": 0
          }
        ]
      }
    ],
    "Pages": [
      {
        "Layout": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}