Return the explicit drawer host-surface configuration.

GET

/api/workspace/admin/entity-definitions/{entityDefinitionId}/ui/drawer-surface/configuration

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/drawer-surface/configuration"),
};
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/drawer-surface/configuration';
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/drawer-surface/configuration

Authorizations

None

Parameters

Path Parameters

entityDefinitionId

required

string

Query Parameters

surfaceKey

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

Admin-facing drawer host-surface configuration.

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

SurfaceId

Persisted drawer surface identifier.

string

nullable

Name

Drawer surface name.

string

nullable

Key

Stable drawer surface key.

string

nullable

IsDefault

Whether this drawer is the current default.

boolean

SummaryCardSelectors

Role-aware card surface selectors for drawer summary content.

Array<object>

nullable

Role-aware selector row used by hosted surfaces and lookup inputs.

object

Persisted selector row id. New client rows may send null.

string

nullable

Priority

Higher values are evaluated first.

integer format: int32

Mode

integer format: int32

Allowed values: 0 1

SurfaceKey

Custom surface key when Moltaro.Entity.Ui.Models.EntityUiSurfaceSelectorAdminModel.Mode is custom key.

string

nullable

RoleIds

Workspace role ids that may use the selector; empty means all roles.

Array<string>

nullable

EditFormSelectors

Role-aware form surface selectors for drawer edit flows.

Array<object>

nullable

Role-aware selector row used by hosted surfaces and lookup inputs.

object

Persisted selector row id. New client rows may send null.

string

nullable

Priority

Higher values are evaluated first.

integer format: int32

Mode

integer format: int32

Allowed values: 0 1

SurfaceKey

Custom surface key when Moltaro.Entity.Ui.Models.EntityUiSurfaceSelectorAdminModel.Mode is custom key.

string

nullable

RoleIds

Workspace role ids that may use the selector; empty means all roles.

Array<string>

nullable

DetailsPageSelectors

Role-aware details-page selectors for the drawer open action.

Array<object>

nullable

Role-aware selector row used by hosted surfaces and lookup inputs.

object

Persisted selector row id. New client rows may send null.

string

nullable

Priority

Higher values are evaluated first.

integer format: int32

Mode

integer format: int32

Allowed values: 0 1

SurfaceKey

Custom surface key when Moltaro.Entity.Ui.Models.EntityUiSurfaceSelectorAdminModel.Mode is custom key.

string

nullable

RoleIds

Workspace role ids that may use the selector; empty means all roles.

Array<string>

nullable

Sections

Configured related sections.

Array<object>

nullable

Explicit drawer related-section override keyed by a stable relation anchor.

object

Target

Stable relation target for details-page and drawer surface configurations.

object

SourceEntityDefinitionId

Source entity definition id for the related section.

string

nullable

SourceReferenceFieldId

Source reference field id for the related section.

string

nullable

Label

Override label, or null to use the surface default.

string

nullable

SortOrder

Override sort order, or null to use the surface default.

integer format: int32

nullable

Visible

Override visibility, or null to use the surface default.

boolean

nullable

DefaultPageSize

Override hosted table page size, or null to use the surface default.

integer format: int32

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,
    "SummaryCardSelectors": [
      {
        "Mode": 0
      }
    ],
    "EditFormSelectors": [
      {
        "Mode": 0
      }
    ],
    "DetailsPageSelectors": [
      {
        "Mode": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Bad Request

application/json

object

Data

Admin-facing drawer host-surface configuration.

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

SurfaceId

Persisted drawer surface identifier.

string

nullable

Name

Drawer surface name.

string

nullable

Key

Stable drawer surface key.

string

nullable

IsDefault

Whether this drawer is the current default.

boolean

SummaryCardSelectors

Role-aware card surface selectors for drawer summary content.

Array<object>

nullable

Role-aware selector row used by hosted surfaces and lookup inputs.

object

Persisted selector row id. New client rows may send null.

string

nullable

Priority

Higher values are evaluated first.

integer format: int32

Mode

integer format: int32

Allowed values: 0 1

SurfaceKey

Custom surface key when Moltaro.Entity.Ui.Models.EntityUiSurfaceSelectorAdminModel.Mode is custom key.

string

nullable

RoleIds

Workspace role ids that may use the selector; empty means all roles.

Array<string>

nullable

EditFormSelectors

Role-aware form surface selectors for drawer edit flows.

Array<object>

nullable

Role-aware selector row used by hosted surfaces and lookup inputs.

object

Persisted selector row id. New client rows may send null.

string

nullable

Priority

Higher values are evaluated first.

integer format: int32

Mode

integer format: int32

Allowed values: 0 1

SurfaceKey

Custom surface key when Moltaro.Entity.Ui.Models.EntityUiSurfaceSelectorAdminModel.Mode is custom key.

string

nullable

RoleIds

Workspace role ids that may use the selector; empty means all roles.

Array<string>

nullable

DetailsPageSelectors

Role-aware details-page selectors for the drawer open action.

Array<object>

nullable

Role-aware selector row used by hosted surfaces and lookup inputs.

object

Persisted selector row id. New client rows may send null.

string

nullable

Priority

Higher values are evaluated first.

integer format: int32

Mode

integer format: int32

Allowed values: 0 1

SurfaceKey

Custom surface key when Moltaro.Entity.Ui.Models.EntityUiSurfaceSelectorAdminModel.Mode is custom key.

string

nullable

RoleIds

Workspace role ids that may use the selector; empty means all roles.

Array<string>

nullable

Sections

Configured related sections.

Array<object>

nullable

Explicit drawer related-section override keyed by a stable relation anchor.

object

Target

Stable relation target for details-page and drawer surface configurations.

object

SourceEntityDefinitionId

Source entity definition id for the related section.

string

nullable

SourceReferenceFieldId

Source reference field id for the related section.

string

nullable

Label

Override label, or null to use the surface default.

string

nullable

SortOrder

Override sort order, or null to use the surface default.

integer format: int32

nullable

Visible

Override visibility, or null to use the surface default.

boolean

nullable

DefaultPageSize

Override hosted table page size, or null to use the surface default.

integer format: int32

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,
    "SummaryCardSelectors": [
      {
        "Mode": 0
      }
    ],
    "EditFormSelectors": [
      {
        "Mode": 0
      }
    ],
    "DetailsPageSelectors": [
      {
        "Mode": 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

Admin-facing drawer host-surface configuration.

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

SurfaceId

Persisted drawer surface identifier.

string

nullable

Name

Drawer surface name.

string

nullable

Key

Stable drawer surface key.

string

nullable

IsDefault

Whether this drawer is the current default.

boolean

SummaryCardSelectors

Role-aware card surface selectors for drawer summary content.

Array<object>

nullable

Role-aware selector row used by hosted surfaces and lookup inputs.

object

Persisted selector row id. New client rows may send null.

string

nullable

Priority

Higher values are evaluated first.

integer format: int32

Mode

integer format: int32

Allowed values: 0 1

SurfaceKey

Custom surface key when Moltaro.Entity.Ui.Models.EntityUiSurfaceSelectorAdminModel.Mode is custom key.

string

nullable

RoleIds

Workspace role ids that may use the selector; empty means all roles.

Array<string>

nullable

EditFormSelectors

Role-aware form surface selectors for drawer edit flows.

Array<object>

nullable

Role-aware selector row used by hosted surfaces and lookup inputs.

object

Persisted selector row id. New client rows may send null.

string

nullable

Priority

Higher values are evaluated first.

integer format: int32

Mode

integer format: int32

Allowed values: 0 1

SurfaceKey

Custom surface key when Moltaro.Entity.Ui.Models.EntityUiSurfaceSelectorAdminModel.Mode is custom key.

string

nullable

RoleIds

Workspace role ids that may use the selector; empty means all roles.

Array<string>

nullable

DetailsPageSelectors

Role-aware details-page selectors for the drawer open action.

Array<object>

nullable

Role-aware selector row used by hosted surfaces and lookup inputs.

object

Persisted selector row id. New client rows may send null.

string

nullable

Priority

Higher values are evaluated first.

integer format: int32

Mode

integer format: int32

Allowed values: 0 1

SurfaceKey

Custom surface key when Moltaro.Entity.Ui.Models.EntityUiSurfaceSelectorAdminModel.Mode is custom key.

string

nullable

RoleIds

Workspace role ids that may use the selector; empty means all roles.

Array<string>

nullable

Sections

Configured related sections.

Array<object>

nullable

Explicit drawer related-section override keyed by a stable relation anchor.

object

Target

Stable relation target for details-page and drawer surface configurations.

object

SourceEntityDefinitionId

Source entity definition id for the related section.

string

nullable

SourceReferenceFieldId

Source reference field id for the related section.

string

nullable

Label

Override label, or null to use the surface default.

string

nullable

SortOrder

Override sort order, or null to use the surface default.

integer format: int32

nullable

Visible

Override visibility, or null to use the surface default.

boolean

nullable

DefaultPageSize

Override hosted table page size, or null to use the surface default.

integer format: int32

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,
    "SummaryCardSelectors": [
      {
        "Mode": 0
      }
    ],
    "EditFormSelectors": [
      {
        "Mode": 0
      }
    ],
    "DetailsPageSelectors": [
      {
        "Mode": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

Return the explicit drawer host-surface configuration.

Authorizations

Parameters

Path Parameters

Query Parameters

Responses

200

Example

400

Example

403

Examplegenerated

404

Example

Example^generated