Return persisted grid settings for a trusted related-table Form item context.
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Get, RequestUri = new Uri("https://example.com/api/workspace/entity/example/ui/form/example/items/example/related-table/grid-settings?instanceId=example&expectedContextRevision=example"),};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: '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/entity/example/ui/form/example/items/example/related-table/grid-settings?instanceId=example&expectedContextRevision=example'Authorizations
Section titled “Authorizations”- None
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Query Parameters
Section titled “Query Parameters”Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.
Responses
Section titled “Responses”OK
object
Per-user runtime grid settings for one resolved table surface.
object
Entity definition identifier.
Resolved table surface identifier.
Whether a user-specific layout row exists.
Persisted settings row version, or System.Guid.Empty when absent.
Persisted column layout entries.
One persisted runtime grid column layout entry.
object
Runtime table column identifier.
Column width in pixels.
Pinned side: left, right, or null.
Whether the column is hidden.
Persisted column order.
Explicit per-user sort override, or null when normal defaults apply.
One sort item in the runtime list query.
object
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
Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.
Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.
Statement identifier resolved through the runtime statement index.
Statement key resolved through the runtime normalized-key index.
Configured object-context fact identifier.
Provider-owned object-context fact filter facet key.
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
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.
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
Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.
Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.
Statement identifier resolved through the runtime statement index.
Statement key resolved through the runtime normalized-key index.
Configured object-context fact identifier.
Provider-owned object-context fact filter facet key.
object
object
object
object
Example
{ "Data": { "SortOverride": [ { "Field": { "Special": 0 }, "Target": { "Path": [ { "Special": 0 } ] }, "Direction": 0 } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Bad Request
object
Per-user runtime grid settings for one resolved table surface.
object
Entity definition identifier.
Resolved table surface identifier.
Whether a user-specific layout row exists.
Persisted settings row version, or System.Guid.Empty when absent.
Persisted column layout entries.
One persisted runtime grid column layout entry.
object
Runtime table column identifier.
Column width in pixels.
Pinned side: left, right, or null.
Whether the column is hidden.
Persisted column order.
Explicit per-user sort override, or null when normal defaults apply.
One sort item in the runtime list query.
object
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
Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.
Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.
Statement identifier resolved through the runtime statement index.
Statement key resolved through the runtime normalized-key index.
Configured object-context fact identifier.
Provider-owned object-context fact filter facet key.
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
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.
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
Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.
Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.
Statement identifier resolved through the runtime statement index.
Statement key resolved through the runtime normalized-key index.
Configured object-context fact identifier.
Provider-owned object-context fact filter facet key.
object
object
object
object
Example
{ "Data": { "SortOverride": [ { "Field": { "Special": 0 }, "Target": { "Path": [ { "Special": 0 } ] }, "Direction": 0 } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Forbidden
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Not Found
object
Per-user runtime grid settings for one resolved table surface.
object
Entity definition identifier.
Resolved table surface identifier.
Whether a user-specific layout row exists.
Persisted settings row version, or System.Guid.Empty when absent.
Persisted column layout entries.
One persisted runtime grid column layout entry.
object
Runtime table column identifier.
Column width in pixels.
Pinned side: left, right, or null.
Whether the column is hidden.
Persisted column order.
Explicit per-user sort override, or null when normal defaults apply.
One sort item in the runtime list query.
object
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
Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.
Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.
Statement identifier resolved through the runtime statement index.
Statement key resolved through the runtime normalized-key index.
Configured object-context fact identifier.
Provider-owned object-context fact filter facet key.
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
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.
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
Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.
Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.
Statement identifier resolved through the runtime statement index.
Statement key resolved through the runtime normalized-key index.
Configured object-context fact identifier.
Provider-owned object-context fact filter facet key.
object
object
object
object
Example
{ "Data": { "SortOverride": [ { "Field": { "Special": 0 }, "Target": { "Path": [ { "Special": 0 } ] }, "Direction": 0 } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Conflict
object
Per-user runtime grid settings for one resolved table surface.
object
Entity definition identifier.
Resolved table surface identifier.
Whether a user-specific layout row exists.
Persisted settings row version, or System.Guid.Empty when absent.
Persisted column layout entries.
One persisted runtime grid column layout entry.
object
Runtime table column identifier.
Column width in pixels.
Pinned side: left, right, or null.
Whether the column is hidden.
Persisted column order.
Explicit per-user sort override, or null when normal defaults apply.
One sort item in the runtime list query.
object
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
Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.
Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.
Statement identifier resolved through the runtime statement index.
Statement key resolved through the runtime normalized-key index.
Configured object-context fact identifier.
Provider-owned object-context fact filter facet key.
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
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.
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
Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.
Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.
Statement identifier resolved through the runtime statement index.
Statement key resolved through the runtime normalized-key index.
Configured object-context fact identifier.
Provider-owned object-context fact filter facet key.
object
object
object
object
Example
{ "Data": { "SortOverride": [ { "Field": { "Special": 0 }, "Target": { "Path": [ { "Special": 0 } ] }, "Direction": 0 } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}