Delete the explicit field UI preferences row and fall back to platform defaults.

DELETE

/api/workspace/admin/entity-definitions/{entityDefinitionId}/fields/{fieldId}/ui

curl --request DELETE \
  --url https://example.com/api/workspace/admin/entity-definitions/example/fields/example/ui \
  --header 'Content-Type: application/json' \
  --data '{ "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Authorizations

• None

Parameters

Path Parameters

entityDefinitionId

required

string

fieldId

required

string

Query Parameters

access_token

string

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

Request Body

Request payload to delete explicit field UI preferences.

object

RowVersion

Expected explicit row version when deleting an existing override.

string format: uuid

nullable

Example^generated

{
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Request payload to delete explicit field UI preferences.

object

RowVersion

Expected explicit row version when deleting an existing override.

string format: uuid

nullable

Example^generated

{
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Request payload to delete explicit field UI preferences.

object

RowVersion

Expected explicit row version when deleting an existing override.

string format: uuid

nullable

Example^generated

{
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

200

OK

Media typeapplication/json

object

Data

Effective admin-facing field UI preferences for one field.

object

HasOverride

Whether an explicit preference row exists for the field.

boolean

ReferenceInputType

integer format: int32

Allowed values: 0 1 2 3

ReferenceRendererType

integer format: int32

Allowed values: 0 1

ReferenceLookupRenderType

integer format: int32

Allowed values: 0 1

ReferencePath

Effective breadcrumb reference path.

Array<string>

nullable

RowVersion

Explicit row version when an override exists.

string format: uuid

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": {
    "ReferenceInputType": 0,
    "ReferenceRendererType": 0,
    "ReferenceLookupRenderType": 0
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Bad Request

Media typeapplication/json

object

Data

Effective admin-facing field UI preferences for one field.

object

HasOverride

Whether an explicit preference row exists for the field.

boolean

ReferenceInputType

integer format: int32

Allowed values: 0 1 2 3

ReferenceRendererType

integer format: int32

Allowed values: 0 1

ReferenceLookupRenderType

integer format: int32

Allowed values: 0 1

ReferencePath

Effective breadcrumb reference path.

Array<string>

nullable

RowVersion

Explicit row version when an override exists.

string format: uuid

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": {
    "ReferenceInputType": 0,
    "ReferenceRendererType": 0,
    "ReferenceLookupRenderType": 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"
}

404

Not Found

Media typeapplication/json

object

Data

Effective admin-facing field UI preferences for one field.

object

HasOverride

Whether an explicit preference row exists for the field.

boolean

ReferenceInputType

integer format: int32

Allowed values: 0 1 2 3

ReferenceRendererType

integer format: int32

Allowed values: 0 1

ReferenceLookupRenderType

integer format: int32

Allowed values: 0 1

ReferencePath

Effective breadcrumb reference path.

Array<string>

nullable

RowVersion

Explicit row version when an override exists.

string format: uuid

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": {
    "ReferenceInputType": 0,
    "ReferenceRendererType": 0,
    "ReferenceLookupRenderType": 0
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

409

Conflict

Media typeapplication/json

object

Data

Effective admin-facing field UI preferences for one field.

object

HasOverride

Whether an explicit preference row exists for the field.

boolean

ReferenceInputType

integer format: int32

Allowed values: 0 1 2 3

ReferenceRendererType

integer format: int32

Allowed values: 0 1

ReferenceLookupRenderType

integer format: int32

Allowed values: 0 1

ReferencePath

Effective breadcrumb reference path.

Array<string>

nullable

RowVersion

Explicit row version when an override exists.

string format: uuid

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": {
    "ReferenceInputType": 0,
    "ReferenceRendererType": 0,
    "ReferenceLookupRenderType": 0
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}