Return the read-only surface catalog for one surface type.

GET

/api/workspace/admin/entity-definitions/{entityDefinitionId}/ui/catalog

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://example.com/api/workspace/admin/entity-definitions/example/ui/catalog"),
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://example.com/api/workspace/admin/entity-definitions/example/ui/catalog';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/workspace/admin/entity-definitions/example/ui/catalog

Authorizations

None

Parameters

Path Parameters

entityDefinitionId

required

string

Query Parameters

surfaceType

string

access_token

string

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

Responses

200

application/json

object

Data

Read-only admin catalog for one UI surface type.

object

Meta

Minimal runtime entity metadata used by explicit UI surfaces.

object

EntityDefinitionId

Entity definition identifier.

string

nullable

Name

Internal entity key used by runtime routes.

string

nullable

DisplayNameSingular

User-facing singular name.

string

nullable

DisplayNamePlural

User-facing plural name.

string

nullable

CommentsEnabled

Whether entity comments are enabled.

boolean

AttachmentsEnabled

Whether entity attachments are enabled.

boolean

TagsEnabled

Whether entity tags are enabled.

boolean

FullTextSearchAvailable

Whether runtime configured search is available for the definition.

boolean

Statements

Runtime-exposed statements for this entity.

Array<object>

nullable

Runtime statement descriptor exposed to clients together with predicate payloads.

object

Statement identifier.

string

nullable

Name

Stable technical statement key.

string

nullable

DisplayName

User-facing statement label.

string

nullable

RuleEvaluationContext

Rule evaluation context shared with fast UI runtime evaluation.

object

CurrentUserId

Current workspace user identifier.

string

nullable

CurrentLocalDate

Workspace-local current date in ISO format.

string

nullable

TimeZone

Workspace time zone identifier.

string

nullable

GeneratedAtUtc

UTC instant when the context was generated.

string format: date-time

nullable

NextLocalMidnightUtc

UTC instant for the next midnight in the workspace time zone.

string format: date-time

nullable

ContextValues

Owner-scoped runtime values available to rule plans.

object

key

additional properties

object

IsProjection

Whether the entity is an enabled Projection Entity.

boolean

SurfaceType

integer format: int32

Allowed values: 0 1 2 3 4 5

CustomSurfaces

Existing explicit surfaces for the selected surface type.

Array<object>

nullable

One surface metadata entry inside the admin catalog.

object

SurfaceId

Persisted surface identifier.

string

nullable

SurfaceType

integer format: int32

Allowed values: 0 1 2 3 4 5

Name

Surface name.

string

nullable

Key

Surface key.

string

nullable

IsDefault

Whether this surface is currently resolved as the default for its type.

boolean

IsTreeView

Whether this Table Surface is configured as a Parent Tree View.

boolean

Source

integer format: int32

Allowed values: 0 1

SourceNetPackageId

Stable NET package root id when this surface is package-owned.

string

nullable

SourcePackageId

NET package artifact id when this surface is package-owned.

string

nullable

SourceStableId

Stable package surface id when this surface is package-owned.

string

nullable

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": {
    "SurfaceType": 0,
    "CustomSurfaces": [
      {
        "SurfaceType": 0,
        "Source": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Bad Request

application/json

object

Data

Read-only admin catalog for one UI surface type.

object

Meta

Minimal runtime entity metadata used by explicit UI surfaces.

object

EntityDefinitionId

Entity definition identifier.

string

nullable

Name

Internal entity key used by runtime routes.

string

nullable

DisplayNameSingular

User-facing singular name.

string

nullable

DisplayNamePlural

User-facing plural name.

string

nullable

CommentsEnabled

Whether entity comments are enabled.

boolean

AttachmentsEnabled

Whether entity attachments are enabled.

boolean

TagsEnabled

Whether entity tags are enabled.

boolean

FullTextSearchAvailable

Whether runtime configured search is available for the definition.

boolean

Statements

Runtime-exposed statements for this entity.

Array<object>

nullable

Runtime statement descriptor exposed to clients together with predicate payloads.

object

Statement identifier.

string

nullable

Name

Stable technical statement key.

string

nullable

DisplayName

User-facing statement label.

string

nullable

RuleEvaluationContext

Rule evaluation context shared with fast UI runtime evaluation.

object

CurrentUserId

Current workspace user identifier.

string

nullable

CurrentLocalDate

Workspace-local current date in ISO format.

string

nullable

TimeZone

Workspace time zone identifier.

string

nullable

GeneratedAtUtc

UTC instant when the context was generated.

string format: date-time

nullable

NextLocalMidnightUtc

UTC instant for the next midnight in the workspace time zone.

string format: date-time

nullable

ContextValues

Owner-scoped runtime values available to rule plans.

object

key

additional properties

object

IsProjection

Whether the entity is an enabled Projection Entity.

boolean

SurfaceType

integer format: int32

Allowed values: 0 1 2 3 4 5

CustomSurfaces

Existing explicit surfaces for the selected surface type.

Array<object>

nullable

One surface metadata entry inside the admin catalog.

object

SurfaceId

Persisted surface identifier.

string

nullable

SurfaceType

integer format: int32

Allowed values: 0 1 2 3 4 5

Name

Surface name.

string

nullable

Key

Surface key.

string

nullable

IsDefault

Whether this surface is currently resolved as the default for its type.

boolean

IsTreeView

Whether this Table Surface is configured as a Parent Tree View.

boolean

Source

integer format: int32

Allowed values: 0 1

SourceNetPackageId

Stable NET package root id when this surface is package-owned.

string

nullable

SourcePackageId

NET package artifact id when this surface is package-owned.

string

nullable

SourceStableId

Stable package surface id when this surface is package-owned.

string

nullable

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": {
    "SurfaceType": 0,
    "CustomSurfaces": [
      {
        "SurfaceType": 0,
        "Source": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Forbidden

application/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"
}

404

Not Found

application/json

object

Data

Read-only admin catalog for one UI surface type.

object

Meta

Minimal runtime entity metadata used by explicit UI surfaces.

object

EntityDefinitionId

Entity definition identifier.

string

nullable

Name

Internal entity key used by runtime routes.

string

nullable

DisplayNameSingular

User-facing singular name.

string

nullable

DisplayNamePlural

User-facing plural name.

string

nullable

CommentsEnabled

Whether entity comments are enabled.

boolean

AttachmentsEnabled

Whether entity attachments are enabled.

boolean

TagsEnabled

Whether entity tags are enabled.

boolean

FullTextSearchAvailable

Whether runtime configured search is available for the definition.

boolean

Statements

Runtime-exposed statements for this entity.

Array<object>

nullable

Runtime statement descriptor exposed to clients together with predicate payloads.

object

Statement identifier.

string

nullable

Name

Stable technical statement key.

string

nullable

DisplayName

User-facing statement label.

string

nullable

RuleEvaluationContext

Rule evaluation context shared with fast UI runtime evaluation.

object

CurrentUserId

Current workspace user identifier.

string

nullable

CurrentLocalDate

Workspace-local current date in ISO format.

string

nullable

TimeZone

Workspace time zone identifier.

string

nullable

GeneratedAtUtc

UTC instant when the context was generated.

string format: date-time

nullable

NextLocalMidnightUtc

UTC instant for the next midnight in the workspace time zone.

string format: date-time

nullable

ContextValues

Owner-scoped runtime values available to rule plans.

object

key

additional properties

object

IsProjection

Whether the entity is an enabled Projection Entity.

boolean

SurfaceType

integer format: int32

Allowed values: 0 1 2 3 4 5

CustomSurfaces

Existing explicit surfaces for the selected surface type.

Array<object>

nullable

One surface metadata entry inside the admin catalog.

object

SurfaceId

Persisted surface identifier.

string

nullable

SurfaceType

integer format: int32

Allowed values: 0 1 2 3 4 5

Name

Surface name.

string

nullable

Key

Surface key.

string

nullable

IsDefault

Whether this surface is currently resolved as the default for its type.

boolean

IsTreeView

Whether this Table Surface is configured as a Parent Tree View.

boolean

Source

integer format: int32

Allowed values: 0 1

SourceNetPackageId

Stable NET package root id when this surface is package-owned.

string

nullable

SourcePackageId

NET package artifact id when this surface is package-owned.

string

nullable

SourceStableId

Stable package surface id when this surface is package-owned.

string

nullable

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": {
    "SurfaceType": 0,
    "CustomSurfaces": [
      {
        "SurfaceType": 0,
        "Source": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

Return the read-only surface catalog for one surface type.

Authorizations

Parameters

Path Parameters

Query Parameters

Responses

200

Example

400

Example

403

Examplegenerated

404

Example

Example^generated