Replace a saved view for a hosted table surface.

PUT

/api/workspace/entity/{entityIdOrKey}/ui/hosted/table/saved-views/{viewId}

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Put,
    RequestUri = new Uri("https://example.com/api/workspace/entity/example/ui/hosted/table/saved-views/example"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"ExpectedRowVersion\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"Name\": \"example\", \"Scope\": 0, \"ResponsibilityGroupId\": \"example\", \"QueryState\": { \"Search\": \"example\", \"TagIds\": [ \"example\" ], \"ArchiveMode\": 0, \"AdvancedFilter\": { \"Operator\": 0, \"Conditions\": [ { \"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\" } ] }, \"Operator\": 0, \"Values\": [ { \"Kind\": 0, \"Value\": \"example\", \"Variable\": 0 } ], \"RowsFilter\": {}, \"Spatial\": { \"ShapeKind\": 0, \"Center\": { \"Latitude\": 1, \"Longitude\": 1, \"FullAddress\": \"example\" }, \"RadiusKm\": 1, \"BoundingBox\": { \"SouthWest\": { \"Latitude\": 1, \"Longitude\": 1, \"FullAddress\": \"example\" }, \"NorthEast\": { \"Latitude\": 1, \"Longitude\": 1, \"FullAddress\": \"example\" } }, \"Polygon\": [ { \"Latitude\": 1, \"Longitude\": 1, \"FullAddress\": \"example\" } ] } } ], \"Groups\": [] }, \"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 } ], \"PageSize\": 1 }, \"Columns\": [ { \"ColId\": \"example\", \"Pinned\": \"example\", \"Hide\": true } ], \"ColumnOrder\": [ \"example\" ] }")
    {
        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/hosted/table/saved-views/example';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"ExpectedRowVersion":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","Name":"example","Scope":0,"ResponsibilityGroupId":"example","QueryState":{"Search":"example","TagIds":["example"],"ArchiveMode":0,"AdvancedFilter":{"Operator":0,"Conditions":[{"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"}]},"Operator":0,"Values":[{"Kind":0,"Value":"example","Variable":0}],"RowsFilter":{},"Spatial":{"ShapeKind":0,"Center":{"Latitude":1,"Longitude":1,"FullAddress":"example"},"RadiusKm":1,"BoundingBox":{"SouthWest":{"Latitude":1,"Longitude":1,"FullAddress":"example"},"NorthEast":{"Latitude":1,"Longitude":1,"FullAddress":"example"}},"Polygon":[{"Latitude":1,"Longitude":1,"FullAddress":"example"}]}}],"Groups":[]},"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}],"PageSize":1},"Columns":[{"ColId":"example","Pinned":"example","Hide":true}],"ColumnOrder":["example"]}'
};

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

curl --request PUT \
  --url https://example.com/api/workspace/entity/example/ui/hosted/table/saved-views/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "ExpectedRowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "Name": "example", "Scope": 0, "ResponsibilityGroupId": "example", "QueryState": { "Search": "example", "TagIds": [ "example" ], "ArchiveMode": 0, "AdvancedFilter": { "Operator": 0, "Conditions": [ { "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" } ] }, "Operator": 0, "Values": [ { "Kind": 0, "Value": "example", "Variable": 0 } ], "RowsFilter": {}, "Spatial": { "ShapeKind": 0, "Center": { "Latitude": 1, "Longitude": 1, "FullAddress": "example" }, "RadiusKm": 1, "BoundingBox": { "SouthWest": { "Latitude": 1, "Longitude": 1, "FullAddress": "example" }, "NorthEast": { "Latitude": 1, "Longitude": 1, "FullAddress": "example" } }, "Polygon": [ { "Latitude": 1, "Longitude": 1, "FullAddress": "example" } ] } } ], "Groups": [] }, "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 } ], "PageSize": 1 }, "Columns": [ { "ColId": "example", "Pinned": "example", "Hide": true } ], "ColumnOrder": [ "example" ] }'

Authorizations

WorkspaceBearer

Parameters

Path Parameters

entityIdOrKey

required

string

viewId

required

string

Query Parameters

hostSurface

string

surfaceKey

string

access_token

string

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

Request Body

Request payload to replace a named runtime entity table saved view.

object

ExpectedRowVersion

required

Last row version returned by the server.

string format: uuid

Name

Saved view display name.

string

nullable

Scope

integer format: int32

Allowed values: 0 1 2

ResponsibilityGroupId

Responsibility group identifier for team views.

string

nullable

QueryState

Reproducible query state captured by an entity table saved view or share link.

object

Search

Optional configured search term.

string

nullable

TagIds

Selected tag identifiers.

Array<string>

nullable

ArchiveMode

integer format: int32

Allowed values: 0 1 2

AdvancedFilter

One nested logical filter group.

object

Operator

integer format: int32

Allowed values: 0 1

Conditions

Direct conditions inside this group.

Array<object>

nullable

One leaf condition in the runtime list query tree.

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 condition target. The first segment belongs to the queried entity; every intermediate segment must be a readable primary-table reference, and the terminal segment determines the field type, supported operators, and operand shape.

object

Path

Ordered path of one to six segments. Each segment may contain an ID, a key, or both; when both are supplied they must resolve to the same field in the entity reached by the preceding segment.

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

Operator

integer format: int32

Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32

Values

Operand list for the selected operator.

Array<object>

nullable

One query operand.

object

Kind

integer format: int32

Allowed values: 0 1

Value

Literal JSON value used when Moltaro.Entity.Instances.Requests.EntityInstanceQueryOperandRequest.Kind is Moltaro.Enums.EntityInstanceQueryOperandKindEnum.Value. Select and enum fields accept the string option key; numeric enum ordinals and display labels are not operands.

nullable

Variable

integer format: int32

Allowed values: 0 1

RowsFilter

object recursive

Spatial

Spatial operand for address-style runtime query conditions.

object

ShapeKind

integer format: int32

Allowed values: 0 1 2

Center

Geographic point in WGS84 coordinates.

object

Latitude

Latitude in decimal degrees.

number format: double

Longitude

Longitude in decimal degrees.

number format: double

FullAddress

Optional display address selected by the user.

string

nullable

RadiusKm

Radius in kilometers for radius-based queries.

number format: double

nullable

BoundingBox

Reserved WGS84 bounding box for future spatial queries.

object

SouthWest

Geographic point in WGS84 coordinates.

object

Latitude

Latitude in decimal degrees.

number format: double

Longitude

Longitude in decimal degrees.

number format: double

FullAddress

Optional display address selected by the user.

string

nullable

NorthEast

Geographic point in WGS84 coordinates.

object

Latitude

Latitude in decimal degrees.

number format: double

Longitude

Longitude in decimal degrees.

number format: double

FullAddress

Optional display address selected by the user.

string

nullable

Polygon

Reserved polygon payload for future spatial queries.

Array<object>

nullable

Geographic point in WGS84 coordinates.

object

Latitude

Latitude in decimal degrees.

number format: double

Longitude

Longitude in decimal degrees.

number format: double

FullAddress

Optional display address selected by the user.

string

nullable

Groups

Array<object> recursive

Sort

Selected sort rules.

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

PageSize

Selected page size.

integer format: int32

Columns

Captured column visibility and pinning.

Array<object>

nullable

Request payload for one saved-view column layout entry.

object

ColId

Runtime table column identifier.

string

nullable

Pinned

Pinned side: left, right, or null.

string

nullable

Hide

Whether the column is hidden.

boolean

ColumnOrder

Captured column order.

Array<string>

nullable

Request payload to replace a named runtime entity table saved view.

object

ExpectedRowVersion

required

Last row version returned by the server.

string format: uuid

Name

Saved view display name.

string

nullable

Scope

integer format: int32

Allowed values: 0 1 2

ResponsibilityGroupId

Responsibility group identifier for team views.

string

nullable

QueryState

Reproducible query state captured by an entity table saved view or share link.

object

Search

Optional configured search term.

string

nullable

TagIds

Selected tag identifiers.

Array<string>

nullable

ArchiveMode

integer format: int32

Allowed values: 0 1 2

AdvancedFilter

One nested logical filter group.

object

Operator

integer format: int32

Allowed values: 0 1

Conditions

Direct conditions inside this group.

Array<object>

nullable

One leaf condition in the runtime list query tree.

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

object

Path

Ordered path of one to six segments. Each segment may contain an ID, a key, or both; when both are supplied they must resolve to the same field in the entity reached by the preceding segment.

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

Operator

integer format: int32

Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32

Values

Operand list for the selected operator.

Array<object>

nullable

One query operand.

object

Kind

integer format: int32

Allowed values: 0 1

Value

nullable

Variable

integer format: int32

Allowed values: 0 1

RowsFilter

object recursive

Spatial

Spatial operand for address-style runtime query conditions.

object

ShapeKind

integer format: int32

Allowed values: 0 1 2

Center

Geographic point in WGS84 coordinates.

object

Latitude

Latitude in decimal degrees.

number format: double

Longitude

Longitude in decimal degrees.

number format: double

FullAddress

Optional display address selected by the user.

string

nullable

RadiusKm

Radius in kilometers for radius-based queries.

number format: double

nullable

BoundingBox

Reserved WGS84 bounding box for future spatial queries.

object

SouthWest

Geographic point in WGS84 coordinates.

object

Latitude

Latitude in decimal degrees.

number format: double

Longitude

Longitude in decimal degrees.

number format: double

FullAddress

Optional display address selected by the user.

string

nullable

NorthEast

Geographic point in WGS84 coordinates.

object

Latitude

Latitude in decimal degrees.

number format: double

Longitude

Longitude in decimal degrees.

number format: double

FullAddress

Optional display address selected by the user.

string

nullable

Polygon

Reserved polygon payload for future spatial queries.

Array<object>

nullable

Geographic point in WGS84 coordinates.

object

Latitude

Latitude in decimal degrees.

number format: double

Longitude

Longitude in decimal degrees.

number format: double

FullAddress

Optional display address selected by the user.

string

nullable

Groups

Array<object> recursive

Sort

Selected sort rules.

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

PageSize

Selected page size.

integer format: int32

Columns

Captured column visibility and pinning.

Array<object>

nullable

Request payload for one saved-view column layout entry.

object

ColId

Runtime table column identifier.

string

nullable

Pinned

Pinned side: left, right, or null.

string

nullable

Hide

Whether the column is hidden.

boolean

ColumnOrder

Captured column order.

Array<string>

nullable

Request payload to replace a named runtime entity table saved view.

object

ExpectedRowVersion

required

Last row version returned by the server.

string format: uuid

Name

Saved view display name.

string

nullable

Scope

integer format: int32

Allowed values: 0 1 2

ResponsibilityGroupId

Responsibility group identifier for team views.

string

nullable

QueryState

Reproducible query state captured by an entity table saved view or share link.

object

Search

Optional configured search term.

string

nullable

TagIds

Selected tag identifiers.

Array<string>

nullable

ArchiveMode

integer format: int32

Allowed values: 0 1 2

AdvancedFilter

One nested logical filter group.

object

Operator

integer format: int32

Allowed values: 0 1

Conditions

Direct conditions inside this group.

Array<object>

nullable

One leaf condition in the runtime list query tree.

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

object

Path

Ordered path of one to six segments. Each segment may contain an ID, a key, or both; when both are supplied they must resolve to the same field in the entity reached by the preceding segment.

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

Operator

integer format: int32

Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32

Values

Operand list for the selected operator.

Array<object>

nullable

One query operand.

object

Kind

integer format: int32

Allowed values: 0 1

Value

nullable

Variable

integer format: int32

Allowed values: 0 1

RowsFilter

object recursive

Spatial

Spatial operand for address-style runtime query conditions.

object

ShapeKind

integer format: int32

Allowed values: 0 1 2

Center

Geographic point in WGS84 coordinates.

object

Latitude

Latitude in decimal degrees.

number format: double

Longitude

Longitude in decimal degrees.

number format: double

FullAddress

Optional display address selected by the user.

string

nullable

RadiusKm

Radius in kilometers for radius-based queries.

number format: double

nullable

BoundingBox

Reserved WGS84 bounding box for future spatial queries.

object

SouthWest

Geographic point in WGS84 coordinates.

object

Latitude

Latitude in decimal degrees.

number format: double

Longitude

Longitude in decimal degrees.

number format: double

FullAddress

Optional display address selected by the user.

string

nullable

NorthEast

Geographic point in WGS84 coordinates.

object

Latitude

Latitude in decimal degrees.

number format: double

Longitude

Longitude in decimal degrees.

number format: double

FullAddress

Optional display address selected by the user.

string

nullable

Polygon

Reserved polygon payload for future spatial queries.

Array<object>

nullable

Geographic point in WGS84 coordinates.

object

Latitude

Latitude in decimal degrees.

number format: double

Longitude

Longitude in decimal degrees.

number format: double

FullAddress

Optional display address selected by the user.

string

nullable

Groups

Array<object> recursive

Sort

Selected sort rules.

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

PageSize

Selected page size.

integer format: int32

Columns

Captured column visibility and pinning.

Array<object>

nullable

Request payload for one saved-view column layout entry.

object

ColId

Runtime table column identifier.

string

nullable

Pinned

Pinned side: left, right, or null.

string

nullable

Hide

Whether the column is hidden.

boolean

ColumnOrder

Captured column order.

Array<string>

nullable

Responses

200

application/json

object

Data

Named runtime view for an entity table surface.

object

Saved view identifier.

string

nullable

EntityDefinitionId

Entity definition identifier.

string

nullable

TableSurfaceId

Resolved table surface identifier.

string

nullable

Scope

integer format: int32

Allowed values: 0 1 2

OwnerUserId

User that owns the view row.

string

nullable

ResponsibilityGroupId

Responsibility group identifier for team views.

string

nullable

ResponsibilityGroupName

Responsibility group display name for team views.

string

nullable

Name

Saved view display name.

string

nullable

IsGlobalDefault

Whether this global view is the default for the table surface.

boolean

QueryState

Reproducible query state captured by an entity table saved view or share link.

object

Search

Optional configured search term.

string

nullable

TagIds

Selected tag identifiers.

Array<string>

nullable

ArchiveMode

integer format: int32

Allowed values: 0 1 2

AdvancedFilter

One nested logical filter group.

object

Operator

integer format: int32

Allowed values: 0 1

Conditions

Direct conditions inside this group.

Array<object>

nullable

One leaf condition in the runtime list query tree.

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

object

Path

Ordered path of one to six segments. Each segment may contain an ID, a key, or both; when both are supplied they must resolve to the same field in the entity reached by the preceding segment.

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

Operator

integer format: int32

Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32

Values

Operand list for the selected operator.

Array<object>

nullable

One query operand.

object

Kind

integer format: int32

Allowed values: 0 1

Value

nullable

Variable

integer format: int32

Allowed values: 0 1

RowsFilter

object recursive

Spatial

Spatial operand for address-style runtime query conditions.

object

ShapeKind

integer format: int32

Allowed values: 0 1 2

Center

Geographic point in WGS84 coordinates.

object

Latitude

Latitude in decimal degrees.

number format: double

Longitude

Longitude in decimal degrees.

number format: double

FullAddress

Optional display address selected by the user.

string

nullable

RadiusKm

Radius in kilometers for radius-based queries.

number format: double

nullable

BoundingBox

Reserved WGS84 bounding box for future spatial queries.

object

SouthWest

Geographic point in WGS84 coordinates.

object

Latitude

Latitude in decimal degrees.

number format: double

Longitude

Longitude in decimal degrees.

number format: double

FullAddress

Optional display address selected by the user.

string

nullable

NorthEast

Geographic point in WGS84 coordinates.

object

Latitude

Latitude in decimal degrees.

number format: double

Longitude

Longitude in decimal degrees.

number format: double

FullAddress

Optional display address selected by the user.

string

nullable

Polygon

Reserved polygon payload for future spatial queries.

Array<object>

nullable

Geographic point in WGS84 coordinates.

object

Latitude

Latitude in decimal degrees.

number format: double

Longitude

Longitude in decimal degrees.

number format: double

FullAddress

Optional display address selected by the user.

string

nullable

Groups

Array<object> recursive

Sort

Selected sort rules.

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

PageSize

Selected page size.

integer format: int32

Columns

Captured column visibility and pinning.

Array<object>

nullable

One column-layout entry captured by an entity table saved view.

object

ColId

Runtime table column identifier.

string

nullable

Pinned

Pinned side: left, right, or null.

string

nullable

Hide

Whether the column is hidden.

boolean

ColumnOrder

Captured column order.

Array<string>

nullable

CanUpdate

Whether the current user can update this view.

boolean

CanDelete

Whether the current user can delete this view.

boolean

CanSetGlobalDefault

Whether the current user can mark this view as the global default.

boolean

RowVersion

Persisted row version.

string format: uuid

CreatedAt

Creation timestamp.

string format: date-time

ModifiedAt

Last modification timestamp.

string format: date-time

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": {
    "Scope": 0,
    "QueryState": {
      "ArchiveMode": 0,
      "AdvancedFilter": {
        "Operator": 0,
        "Conditions": [
          {
            "Field": {
              "Special": 0
            },
            "Target": {
              "Path": [
                {
                  "Special": 0
                }
              ]
            },
            "Operator": 0,
            "Values": [
              {
                "Kind": 0,
                "Variable": 0
              }
            ],
            "Spatial": {
              "ShapeKind": 0
            }
          }
        ]
      },
      "Sort": [
        {
          "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

Named runtime view for an entity table surface.

object

Saved view identifier.

string

nullable

EntityDefinitionId

Entity definition identifier.

string

nullable

TableSurfaceId

Resolved table surface identifier.

string

nullable

Scope

integer format: int32

Allowed values: 0 1 2

OwnerUserId

User that owns the view row.

string

nullable

ResponsibilityGroupId

Responsibility group identifier for team views.

string

nullable

ResponsibilityGroupName

Responsibility group display name for team views.

string

nullable

Name

Saved view display name.

string

nullable

IsGlobalDefault

Whether this global view is the default for the table surface.

boolean

QueryState

Reproducible query state captured by an entity table saved view or share link.

object

Search

Optional configured search term.

string

nullable

TagIds

Selected tag identifiers.

Array<string>

nullable

ArchiveMode

integer format: int32

Allowed values: 0 1 2

AdvancedFilter

One nested logical filter group.

object

Operator

integer format: int32

Allowed values: 0 1

Conditions

Direct conditions inside this group.

Array<object>

nullable

One leaf condition in the runtime list query tree.

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

object

Path

Ordered path of one to six segments. Each segment may contain an ID, a key, or both; when both are supplied they must resolve to the same field in the entity reached by the preceding segment.

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

Operator

integer format: int32

Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32

Values

Operand list for the selected operator.

Array<object>

nullable

One query operand.

object

Kind

integer format: int32

Allowed values: 0 1

Value

nullable

Variable

integer format: int32

Allowed values: 0 1

RowsFilter

object recursive

Spatial

Spatial operand for address-style runtime query conditions.

object

ShapeKind

integer format: int32

Allowed values: 0 1 2

Center

Geographic point in WGS84 coordinates.

object

Latitude

Latitude in decimal degrees.

number format: double

Longitude

Longitude in decimal degrees.

number format: double

FullAddress

Optional display address selected by the user.

string

nullable

RadiusKm

Radius in kilometers for radius-based queries.

number format: double

nullable

BoundingBox

Reserved WGS84 bounding box for future spatial queries.

object

SouthWest

Geographic point in WGS84 coordinates.

object

Latitude

Latitude in decimal degrees.

number format: double

Longitude

Longitude in decimal degrees.

number format: double

FullAddress

Optional display address selected by the user.

string

nullable

NorthEast

Geographic point in WGS84 coordinates.

object

Latitude

Latitude in decimal degrees.

number format: double

Longitude

Longitude in decimal degrees.

number format: double

FullAddress

Optional display address selected by the user.

string

nullable

Polygon

Reserved polygon payload for future spatial queries.

Array<object>

nullable

Geographic point in WGS84 coordinates.

object

Latitude

Latitude in decimal degrees.

number format: double

Longitude

Longitude in decimal degrees.

number format: double

FullAddress

Optional display address selected by the user.

string

nullable

Groups

Array<object> recursive

Sort

Selected sort rules.

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

PageSize

Selected page size.

integer format: int32

Columns

Captured column visibility and pinning.

Array<object>

nullable

One column-layout entry captured by an entity table saved view.

object

ColId

Runtime table column identifier.

string

nullable

Pinned

Pinned side: left, right, or null.

string

nullable

Hide

Whether the column is hidden.

boolean

ColumnOrder

Captured column order.

Array<string>

nullable

CanUpdate

Whether the current user can update this view.

boolean

CanDelete

Whether the current user can delete this view.

boolean

CanSetGlobalDefault

Whether the current user can mark this view as the global default.

boolean

RowVersion

Persisted row version.

string format: uuid

CreatedAt

Creation timestamp.

string format: date-time

ModifiedAt

Last modification timestamp.

string format: date-time

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": {
    "Scope": 0,
    "QueryState": {
      "ArchiveMode": 0,
      "AdvancedFilter": {
        "Operator": 0,
        "Conditions": [
          {
            "Field": {
              "Special": 0
            },
            "Target": {
              "Path": [
                {
                  "Special": 0
                }
              ]
            },
            "Operator": 0,
            "Values": [
              {
                "Kind": 0,
                "Variable": 0
              }
            ],
            "Spatial": {
              "ShapeKind": 0
            }
          }
        ]
      },
      "Sort": [
        {
          "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

Named runtime view for an entity table surface.

object

Saved view identifier.

string

nullable

EntityDefinitionId

Entity definition identifier.

string

nullable

TableSurfaceId

Resolved table surface identifier.

string

nullable

Scope

integer format: int32

Allowed values: 0 1 2

OwnerUserId

User that owns the view row.

string

nullable

ResponsibilityGroupId

Responsibility group identifier for team views.

string

nullable

ResponsibilityGroupName

Responsibility group display name for team views.

string

nullable

Name

Saved view display name.

string

nullable

IsGlobalDefault

Whether this global view is the default for the table surface.

boolean

QueryState

Reproducible query state captured by an entity table saved view or share link.

object

Search

Optional configured search term.

string

nullable

TagIds

Selected tag identifiers.

Array<string>

nullable

ArchiveMode

integer format: int32

Allowed values: 0 1 2

AdvancedFilter

One nested logical filter group.

object

Operator

integer format: int32

Allowed values: 0 1

Conditions

Direct conditions inside this group.

Array<object>

nullable

One leaf condition in the runtime list query tree.

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

object

Path

Ordered path of one to six segments. Each segment may contain an ID, a key, or both; when both are supplied they must resolve to the same field in the entity reached by the preceding segment.

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

Operator

integer format: int32

Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32

Values

Operand list for the selected operator.

Array<object>

nullable

One query operand.

object

Kind

integer format: int32

Allowed values: 0 1

Value

nullable

Variable

integer format: int32

Allowed values: 0 1

RowsFilter

object recursive

Spatial

Spatial operand for address-style runtime query conditions.

object

ShapeKind

integer format: int32

Allowed values: 0 1 2

Center

Geographic point in WGS84 coordinates.

object

Latitude

Latitude in decimal degrees.

number format: double

Longitude

Longitude in decimal degrees.

number format: double

FullAddress

Optional display address selected by the user.

string

nullable

RadiusKm

Radius in kilometers for radius-based queries.

number format: double

nullable

BoundingBox

Reserved WGS84 bounding box for future spatial queries.

object

SouthWest

Geographic point in WGS84 coordinates.

object

Latitude

Latitude in decimal degrees.

number format: double

Longitude

Longitude in decimal degrees.

number format: double

FullAddress

Optional display address selected by the user.

string

nullable

NorthEast

Geographic point in WGS84 coordinates.

object

Latitude

Latitude in decimal degrees.

number format: double

Longitude

Longitude in decimal degrees.

number format: double

FullAddress

Optional display address selected by the user.

string

nullable

Polygon

Reserved polygon payload for future spatial queries.

Array<object>

nullable

Geographic point in WGS84 coordinates.

object

Latitude

Latitude in decimal degrees.

number format: double

Longitude

Longitude in decimal degrees.

number format: double

FullAddress

Optional display address selected by the user.

string

nullable

Groups

Array<object> recursive

Sort

Selected sort rules.

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

PageSize

Selected page size.

integer format: int32

Columns

Captured column visibility and pinning.

Array<object>

nullable

One column-layout entry captured by an entity table saved view.

object

ColId

Runtime table column identifier.

string

nullable

Pinned

Pinned side: left, right, or null.

string

nullable

Hide

Whether the column is hidden.

boolean

ColumnOrder

Captured column order.

Array<string>

nullable

CanUpdate

Whether the current user can update this view.

boolean

CanDelete

Whether the current user can delete this view.

boolean

CanSetGlobalDefault

Whether the current user can mark this view as the global default.

boolean

RowVersion

Persisted row version.

string format: uuid

CreatedAt

Creation timestamp.

string format: date-time

ModifiedAt

Last modification timestamp.

string format: date-time

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": {
    "Scope": 0,
    "QueryState": {
      "ArchiveMode": 0,
      "AdvancedFilter": {
        "Operator": 0,
        "Conditions": [
          {
            "Field": {
              "Special": 0
            },
            "Target": {
              "Path": [
                {
                  "Special": 0
                }
              ]
            },
            "Operator": 0,
            "Values": [
              {
                "Kind": 0,
                "Variable": 0
              }
            ],
            "Spatial": {
              "ShapeKind": 0
            }
          }
        ]
      },
      "Sort": [
        {
          "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

Named runtime view for an entity table surface.

object

Saved view identifier.

string

nullable

EntityDefinitionId

Entity definition identifier.

string

nullable

TableSurfaceId

Resolved table surface identifier.

string

nullable

Scope

integer format: int32

Allowed values: 0 1 2

OwnerUserId

User that owns the view row.

string

nullable

ResponsibilityGroupId

Responsibility group identifier for team views.

string

nullable

ResponsibilityGroupName

Responsibility group display name for team views.

string

nullable

Name

Saved view display name.

string

nullable

IsGlobalDefault

Whether this global view is the default for the table surface.

boolean

QueryState

Reproducible query state captured by an entity table saved view or share link.

object

Search

Optional configured search term.

string

nullable

TagIds

Selected tag identifiers.

Array<string>

nullable

ArchiveMode

integer format: int32

Allowed values: 0 1 2

AdvancedFilter

One nested logical filter group.

object

Operator

integer format: int32

Allowed values: 0 1

Conditions

Direct conditions inside this group.

Array<object>

nullable

One leaf condition in the runtime list query tree.

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

object

Path

Ordered path of one to six segments. Each segment may contain an ID, a key, or both; when both are supplied they must resolve to the same field in the entity reached by the preceding segment.

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

Operator

integer format: int32

Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32

Values

Operand list for the selected operator.

Array<object>

nullable

One query operand.

object

Kind

integer format: int32

Allowed values: 0 1

Value

nullable

Variable

integer format: int32

Allowed values: 0 1

RowsFilter

object recursive

Spatial

Spatial operand for address-style runtime query conditions.

object

ShapeKind

integer format: int32

Allowed values: 0 1 2

Center

Geographic point in WGS84 coordinates.

object

Latitude

Latitude in decimal degrees.

number format: double

Longitude

Longitude in decimal degrees.

number format: double

FullAddress

Optional display address selected by the user.

string

nullable

RadiusKm

Radius in kilometers for radius-based queries.

number format: double

nullable

BoundingBox

Reserved WGS84 bounding box for future spatial queries.

object

SouthWest

Geographic point in WGS84 coordinates.

object

Latitude

Latitude in decimal degrees.

number format: double

Longitude

Longitude in decimal degrees.

number format: double

FullAddress

Optional display address selected by the user.

string

nullable

NorthEast

Geographic point in WGS84 coordinates.

object

Latitude

Latitude in decimal degrees.

number format: double

Longitude

Longitude in decimal degrees.

number format: double

FullAddress

Optional display address selected by the user.

string

nullable

Polygon

Reserved polygon payload for future spatial queries.

Array<object>

nullable

Geographic point in WGS84 coordinates.

object

Latitude

Latitude in decimal degrees.

number format: double

Longitude

Longitude in decimal degrees.

number format: double

FullAddress

Optional display address selected by the user.

string

nullable

Groups

Array<object> recursive

Sort

Selected sort rules.

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

PageSize

Selected page size.

integer format: int32

Columns

Captured column visibility and pinning.

Array<object>

nullable

One column-layout entry captured by an entity table saved view.

object

ColId

Runtime table column identifier.

string

nullable

Pinned

Pinned side: left, right, or null.

string

nullable

Hide

Whether the column is hidden.

boolean

ColumnOrder

Captured column order.

Array<string>

nullable

CanUpdate

Whether the current user can update this view.

boolean

CanDelete

Whether the current user can delete this view.

boolean

CanSetGlobalDefault

Whether the current user can mark this view as the global default.

boolean

RowVersion

Persisted row version.

string format: uuid

CreatedAt

Creation timestamp.

string format: date-time

ModifiedAt

Last modification timestamp.

string format: date-time

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": {
    "Scope": 0,
    "QueryState": {
      "ArchiveMode": 0,
      "AdvancedFilter": {
        "Operator": 0,
        "Conditions": [
          {
            "Field": {
              "Special": 0
            },
            "Target": {
              "Path": [
                {
                  "Special": 0
                }
              ]
            },
            "Operator": 0,
            "Values": [
              {
                "Kind": 0,
                "Variable": 0
              }
            ],
            "Spatial": {
              "ShapeKind": 0
            }
          }
        ]
      },
      "Sort": [
        {
          "Field": {
            "Special": 0
          },
          "Target": {
            "Path": [
              {
                "Special": 0
              }
            ]
          },
          "Direction": 0
        }
      ]
    }
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

Replace a saved view for a hosted table surface.

Authorizations

Parameters

Path Parameters

Query Parameters

Request Body

Responses

200

Example

400

Example

403

Examplegenerated

404

Example

409

Example

Example^generated