Patch persisted grid settings for a trusted related-table Form item context.

PATCH

/api/workspace/entity/{entityIdOrKey}/ui/form/{formSurfaceId}/items/{formItemId}/related-table/grid-settings

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Patch,
    RequestUri = new Uri("https://example.com/api/workspace/entity/example/ui/form/example/items/example/related-table/grid-settings?instanceId=example&expectedContextRevision=example"),
    Content = new StringContent("{ \"ExpectedRowVersion\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"ExpectedContainerSurfaceId\": \"example\", \"ExpectedTableSurfaceId\": \"example\", \"Fields\": [ 0 ], \"ColumnLayout\": { \"Columns\": [ { \"ColId\": \"example\", \"Width\": 1, \"Pinned\": \"example\", \"Hide\": true } ], \"ColumnOrder\": [ \"example\" ] }, \"Sort\": [ { \"Field\": { \"FieldId\": \"example\", \"FieldKey\": \"example\", \"Special\": 0, \"StatementId\": \"example\", \"StatementKey\": \"example\", \"ObjectContextFactId\": \"example\", \"ObjectContextFactFilterKey\": \"example\" }, \"Target\": { \"Path\": [ { \"FieldId\": \"example\", \"FieldKey\": \"example\", \"Special\": 0, \"StatementId\": \"example\", \"StatementKey\": \"example\", \"ObjectContextFactId\": \"example\", \"ObjectContextFactFilterKey\": \"example\" } ] }, \"Direction\": 0 } ] }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
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/entity/example/ui/form/example/items/example/related-table/grid-settings?instanceId=example&expectedContextRevision=example';
const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: '{"ExpectedRowVersion":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","ExpectedContainerSurfaceId":"example","ExpectedTableSurfaceId":"example","Fields":[0],"ColumnLayout":{"Columns":[{"ColId":"example","Width":1,"Pinned":"example","Hide":true}],"ColumnOrder":["example"]},"Sort":[{"Field":{"FieldId":"example","FieldKey":"example","Special":0,"StatementId":"example","StatementKey":"example","ObjectContextFactId":"example","ObjectContextFactFilterKey":"example"},"Target":{"Path":[{"FieldId":"example","FieldKey":"example","Special":0,"StatementId":"example","StatementKey":"example","ObjectContextFactId":"example","ObjectContextFactFilterKey":"example"}]},"Direction":0}]}'
};

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

curl --request PATCH \
  --url 'https://example.com/api/workspace/entity/example/ui/form/example/items/example/related-table/grid-settings?instanceId=example&expectedContextRevision=example' \
  --header 'Content-Type: application/json' \
  --data '{ "ExpectedRowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "ExpectedContainerSurfaceId": "example", "ExpectedTableSurfaceId": "example", "Fields": [ 0 ], "ColumnLayout": { "Columns": [ { "ColId": "example", "Width": 1, "Pinned": "example", "Hide": true } ], "ColumnOrder": [ "example" ] }, "Sort": [ { "Field": { "FieldId": "example", "FieldKey": "example", "Special": 0, "StatementId": "example", "StatementKey": "example", "ObjectContextFactId": "example", "ObjectContextFactFilterKey": "example" }, "Target": { "Path": [ { "FieldId": "example", "FieldKey": "example", "Special": 0, "StatementId": "example", "StatementKey": "example", "ObjectContextFactId": "example", "ObjectContextFactFilterKey": "example" } ] }, "Direction": 0 } ] }'

Authorizations

None

Parameters

Path Parameters

entityIdOrKey

required

string

formSurfaceId

required

string

formItemId

required

string

Query Parameters

instanceId

required

string

expectedContextRevision

required

string

access_token

string

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

Request Body

Field-masked patch for the current user’s host-neutral table settings.

object

ExpectedRowVersion

required

Last row version returned by the server. Use System.Guid.Empty when no settings row exists.

string format: uuid

ExpectedContainerSurfaceId

Optional Entity List Page identity captured by the grid-settings preflight. Hosted writes fail closed when the route now resolves to a different container.

string

nullable

ExpectedTableSurfaceId

Optional Table Surface identity captured by the grid-settings preflight. Writes fail closed when the current host, picker, or Lookup resolves to a different table.

string

nullable

Fields

required

Members changed by this patch. Members outside this mask remain unchanged.

Array<integer>

nullable

Allowed values: 0 1

ColumnLayout

Column layout member of a grid-settings patch.

object

Columns

Column layout entries captured from the grid.

Array<object>

nullable

Patch value for one runtime grid column.

object

ColId

Runtime table column identifier.

string

nullable

Width

Column width in pixels.

integer format: int32

nullable

Pinned

Pinned side: left, right, or null.

string

nullable

Hide

Whether the column is hidden.

boolean

ColumnOrder

Column order captured from the grid.

Array<string>

nullable

Sort

Explicit sort when Moltaro.Entity.Ui.Requests.EntityTableUserGridSettingsPatchFieldEnum.Sort is masked, or null/empty to clear only the explicit sort override.

Array<object>

nullable

One sort item in the runtime list query.

object

Field

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object

FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string

nullable

FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string

nullable

Special

integer format: int32

Allowed values: 0 1

StatementId

Statement identifier resolved through the runtime statement index.

string

nullable

StatementKey

Statement key resolved through the runtime normalized-key index.

string

nullable

ObjectContextFactId

Configured object-context fact identifier.

string

nullable

ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string

nullable

Target

Typed server-side sort target. The first segment belongs to the queried entity; every intermediate segment must be a readable, sortable primary-table reference.

object

Path

Ordered path of one to four segments ending in a sortable field or system field. Each segment may contain an ID, a key, or both; an ID/key mismatch is rejected.

Array<object>

nullable

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object

FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string

nullable

FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string

nullable

Special

integer format: int32

Allowed values: 0 1

StatementId

Statement identifier resolved through the runtime statement index.

string

nullable

StatementKey

Statement key resolved through the runtime normalized-key index.

string

nullable

ObjectContextFactId

Configured object-context fact identifier.

string

nullable

ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string

nullable

Direction

integer format: int32

Allowed values: 0 1

Field-masked patch for the current user’s host-neutral table settings.

object

ExpectedRowVersion

required

Last row version returned by the server. Use System.Guid.Empty when no settings row exists.

string format: uuid

ExpectedContainerSurfaceId

Optional Entity List Page identity captured by the grid-settings preflight. Hosted writes fail closed when the route now resolves to a different container.

string

nullable

ExpectedTableSurfaceId

Optional Table Surface identity captured by the grid-settings preflight. Writes fail closed when the current host, picker, or Lookup resolves to a different table.

string

nullable

Fields

required

Members changed by this patch. Members outside this mask remain unchanged.

Array<integer>

nullable

Allowed values: 0 1

ColumnLayout

Column layout member of a grid-settings patch.

object

Columns

Column layout entries captured from the grid.

Array<object>

nullable

Patch value for one runtime grid column.

object

ColId

Runtime table column identifier.

string

nullable

Width

Column width in pixels.

integer format: int32

nullable

Pinned

Pinned side: left, right, or null.

string

nullable

Hide

Whether the column is hidden.

boolean

ColumnOrder

Column order captured from the grid.

Array<string>

nullable

Sort

Explicit sort when Moltaro.Entity.Ui.Requests.EntityTableUserGridSettingsPatchFieldEnum.Sort is masked, or null/empty to clear only the explicit sort override.

Array<object>

nullable

One sort item in the runtime list query.

object

Field

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object

FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string

nullable

FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string

nullable

Special

integer format: int32

Allowed values: 0 1

StatementId

Statement identifier resolved through the runtime statement index.

string

nullable

StatementKey

Statement key resolved through the runtime normalized-key index.

string

nullable

ObjectContextFactId

Configured object-context fact identifier.

string

nullable

ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string

nullable

Target

Typed server-side sort target. The first segment belongs to the queried entity; every intermediate segment must be a readable, sortable primary-table reference.

object

Path

Ordered path of one to four segments ending in a sortable field or system field. Each segment may contain an ID, a key, or both; an ID/key mismatch is rejected.

Array<object>

nullable

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object

FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string

nullable

FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string

nullable

Special

integer format: int32

Allowed values: 0 1

StatementId

Statement identifier resolved through the runtime statement index.

string

nullable

StatementKey

Statement key resolved through the runtime normalized-key index.

string

nullable

ObjectContextFactId

Configured object-context fact identifier.

string

nullable

ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string

nullable

Direction

integer format: int32

Allowed values: 0 1

Field-masked patch for the current user’s host-neutral table settings.

object

ExpectedRowVersion

required

Last row version returned by the server. Use System.Guid.Empty when no settings row exists.

string format: uuid

ExpectedContainerSurfaceId

Optional Entity List Page identity captured by the grid-settings preflight. Hosted writes fail closed when the route now resolves to a different container.

string

nullable

ExpectedTableSurfaceId

Optional Table Surface identity captured by the grid-settings preflight. Writes fail closed when the current host, picker, or Lookup resolves to a different table.

string

nullable

Fields

required

Members changed by this patch. Members outside this mask remain unchanged.

Array<integer>

nullable

Allowed values: 0 1

ColumnLayout

Column layout member of a grid-settings patch.

object

Columns

Column layout entries captured from the grid.

Array<object>

nullable

Patch value for one runtime grid column.

object

ColId

Runtime table column identifier.

string

nullable

Width

Column width in pixels.

integer format: int32

nullable

Pinned

Pinned side: left, right, or null.

string

nullable

Hide

Whether the column is hidden.

boolean

ColumnOrder

Column order captured from the grid.

Array<string>

nullable

Sort

Explicit sort when Moltaro.Entity.Ui.Requests.EntityTableUserGridSettingsPatchFieldEnum.Sort is masked, or null/empty to clear only the explicit sort override.

Array<object>

nullable

One sort item in the runtime list query.

object

Field

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object

FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string

nullable

FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string

nullable

Special

integer format: int32

Allowed values: 0 1

StatementId

Statement identifier resolved through the runtime statement index.

string

nullable

StatementKey

Statement key resolved through the runtime normalized-key index.

string

nullable

ObjectContextFactId

Configured object-context fact identifier.

string

nullable

ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string

nullable

Target

Typed server-side sort target. The first segment belongs to the queried entity; every intermediate segment must be a readable, sortable primary-table reference.

object

Path

Ordered path of one to four segments ending in a sortable field or system field. Each segment may contain an ID, a key, or both; an ID/key mismatch is rejected.

Array<object>

nullable

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object

FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string

nullable

FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string

nullable

Special

integer format: int32

Allowed values: 0 1

StatementId

Statement identifier resolved through the runtime statement index.

string

nullable

StatementKey

Statement key resolved through the runtime normalized-key index.

string

nullable

ObjectContextFactId

Configured object-context fact identifier.

string

nullable

ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string

nullable

Direction

integer format: int32

Allowed values: 0 1

Responses

200

application/json

object

Data

Per-user runtime grid settings for one resolved table surface.

object

EntityDefinitionId

Entity definition identifier.

string

nullable

TableSurfaceId

Resolved table surface identifier.

string

nullable

HasSettings

Whether a user-specific layout row exists.

boolean

RowVersion

Persisted settings row version, or System.Guid.Empty when absent.

string format: uuid

Columns

Persisted column layout entries.

Array<object>

nullable

One persisted runtime grid column layout entry.

object

ColId

Runtime table column identifier.

string

nullable

Width

Column width in pixels.

integer format: int32

nullable

Pinned

Pinned side: left, right, or null.

string

nullable

Hide

Whether the column is hidden.

boolean

ColumnOrder

Persisted column order.

Array<string>

nullable

SortOverride

Explicit per-user sort override, or null when normal defaults apply.

Array<object>

nullable

One sort item in the runtime list query.

object

Field

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object

FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string

nullable

FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string

nullable

Special

integer format: int32

Allowed values: 0 1

StatementId

Statement identifier resolved through the runtime statement index.

string

nullable

StatementKey

Statement key resolved through the runtime normalized-key index.

string

nullable

ObjectContextFactId

Configured object-context fact identifier.

string

nullable

ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string

nullable

Target

Typed server-side sort target. The first segment belongs to the queried entity; every intermediate segment must be a readable, sortable primary-table reference.

object

Path

Ordered path of one to four segments ending in a sortable field or system field. Each segment may contain an ID, a key, or both; an ID/key mismatch is rejected.

Array<object>

nullable

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object

FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string

nullable

FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string

nullable

Special

integer format: int32

Allowed values: 0 1

StatementId

Statement identifier resolved through the runtime statement index.

string

nullable

StatementKey

Statement key resolved through the runtime normalized-key index.

string

nullable

ObjectContextFactId

Configured object-context fact identifier.

string

nullable

ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string

nullable

Direction

integer format: int32

Allowed values: 0 1

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": {
    "SortOverride": [
      {
        "Field": {
          "Special": 0
        },
        "Target": {
          "Path": [
            {
              "Special": 0
            }
          ]
        },
        "Direction": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Bad Request

application/json

object

Data

Per-user runtime grid settings for one resolved table surface.

object

EntityDefinitionId

Entity definition identifier.

string

nullable

TableSurfaceId

Resolved table surface identifier.

string

nullable

HasSettings

Whether a user-specific layout row exists.

boolean

RowVersion

Persisted settings row version, or System.Guid.Empty when absent.

string format: uuid

Columns

Persisted column layout entries.

Array<object>

nullable

One persisted runtime grid column layout entry.

object

ColId

Runtime table column identifier.

string

nullable

Width

Column width in pixels.

integer format: int32

nullable

Pinned

Pinned side: left, right, or null.

string

nullable

Hide

Whether the column is hidden.

boolean

ColumnOrder

Persisted column order.

Array<string>

nullable

SortOverride

Explicit per-user sort override, or null when normal defaults apply.

Array<object>

nullable

One sort item in the runtime list query.

object

Field

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object

FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string

nullable

FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string

nullable

Special

integer format: int32

Allowed values: 0 1

StatementId

Statement identifier resolved through the runtime statement index.

string

nullable

StatementKey

Statement key resolved through the runtime normalized-key index.

string

nullable

ObjectContextFactId

Configured object-context fact identifier.

string

nullable

ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string

nullable

Target

Typed server-side sort target. The first segment belongs to the queried entity; every intermediate segment must be a readable, sortable primary-table reference.

object

Path

Ordered path of one to four segments ending in a sortable field or system field. Each segment may contain an ID, a key, or both; an ID/key mismatch is rejected.

Array<object>

nullable

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object

FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string

nullable

FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string

nullable

Special

integer format: int32

Allowed values: 0 1

StatementId

Statement identifier resolved through the runtime statement index.

string

nullable

StatementKey

Statement key resolved through the runtime normalized-key index.

string

nullable

ObjectContextFactId

Configured object-context fact identifier.

string

nullable

ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string

nullable

Direction

integer format: int32

Allowed values: 0 1

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": {
    "SortOverride": [
      {
        "Field": {
          "Special": 0
        },
        "Target": {
          "Path": [
            {
              "Special": 0
            }
          ]
        },
        "Direction": 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

Per-user runtime grid settings for one resolved table surface.

object

EntityDefinitionId

Entity definition identifier.

string

nullable

TableSurfaceId

Resolved table surface identifier.

string

nullable

HasSettings

Whether a user-specific layout row exists.

boolean

RowVersion

Persisted settings row version, or System.Guid.Empty when absent.

string format: uuid

Columns

Persisted column layout entries.

Array<object>

nullable

One persisted runtime grid column layout entry.

object

ColId

Runtime table column identifier.

string

nullable

Width

Column width in pixels.

integer format: int32

nullable

Pinned

Pinned side: left, right, or null.

string

nullable

Hide

Whether the column is hidden.

boolean

ColumnOrder

Persisted column order.

Array<string>

nullable

SortOverride

Explicit per-user sort override, or null when normal defaults apply.

Array<object>

nullable

One sort item in the runtime list query.

object

Field

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object

FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string

nullable

FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string

nullable

Special

integer format: int32

Allowed values: 0 1

StatementId

Statement identifier resolved through the runtime statement index.

string

nullable

StatementKey

Statement key resolved through the runtime normalized-key index.

string

nullable

ObjectContextFactId

Configured object-context fact identifier.

string

nullable

ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string

nullable

Target

Typed server-side sort target. The first segment belongs to the queried entity; every intermediate segment must be a readable, sortable primary-table reference.

object

Path

Ordered path of one to four segments ending in a sortable field or system field. Each segment may contain an ID, a key, or both; an ID/key mismatch is rejected.

Array<object>

nullable

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object

FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string

nullable

FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string

nullable

Special

integer format: int32

Allowed values: 0 1

StatementId

Statement identifier resolved through the runtime statement index.

string

nullable

StatementKey

Statement key resolved through the runtime normalized-key index.

string

nullable

ObjectContextFactId

Configured object-context fact identifier.

string

nullable

ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string

nullable

Direction

integer format: int32

Allowed values: 0 1

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": {
    "SortOverride": [
      {
        "Field": {
          "Special": 0
        },
        "Target": {
          "Path": [
            {
              "Special": 0
            }
          ]
        },
        "Direction": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

409

Conflict

application/json

object

Data

Per-user runtime grid settings for one resolved table surface.

object

EntityDefinitionId

Entity definition identifier.

string

nullable

TableSurfaceId

Resolved table surface identifier.

string

nullable

HasSettings

Whether a user-specific layout row exists.

boolean

RowVersion

Persisted settings row version, or System.Guid.Empty when absent.

string format: uuid

Columns

Persisted column layout entries.

Array<object>

nullable

One persisted runtime grid column layout entry.

object

ColId

Runtime table column identifier.

string

nullable

Width

Column width in pixels.

integer format: int32

nullable

Pinned

Pinned side: left, right, or null.

string

nullable

Hide

Whether the column is hidden.

boolean

ColumnOrder

Persisted column order.

Array<string>

nullable

SortOverride

Explicit per-user sort override, or null when normal defaults apply.

Array<object>

nullable

One sort item in the runtime list query.

object

Field

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object

FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string

nullable

FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string

nullable

Special

integer format: int32

Allowed values: 0 1

StatementId

Statement identifier resolved through the runtime statement index.

string

nullable

StatementKey

Statement key resolved through the runtime normalized-key index.

string

nullable

ObjectContextFactId

Configured object-context fact identifier.

string

nullable

ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string

nullable

Target

Typed server-side sort target. The first segment belongs to the queried entity; every intermediate segment must be a readable, sortable primary-table reference.

object

Path

Ordered path of one to four segments ending in a sortable field or system field. Each segment may contain an ID, a key, or both; an ID/key mismatch is rejected.

Array<object>

nullable

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object

FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string

nullable

FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string

nullable

Special

integer format: int32

Allowed values: 0 1

StatementId

Statement identifier resolved through the runtime statement index.

string

nullable

StatementKey

Statement key resolved through the runtime normalized-key index.

string

nullable

ObjectContextFactId

Configured object-context fact identifier.

string

nullable

ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string

nullable

Direction

integer format: int32

Allowed values: 0 1

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": {
    "SortOverride": [
      {
        "Field": {
          "Special": 0
        },
        "Target": {
          "Path": [
            {
              "Special": 0
            }
          ]
        },
        "Direction": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

Patch persisted grid settings for a trusted related-table Form item context.

Authorizations

Parameters

Path Parameters

Query Parameters

Request Body

Responses

200

Example

400

Example

403

Examplegenerated

404

Example

409

Example

Example^generated