Export CSV ZIP.
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Post, RequestUri = new Uri("https://example.com/api/workspace/entity/example/data-transfer/export/csv-zip"), Content = new StringContent("{ \"ProfileId\": \"example\", \"Query\": { \"Page\": 1, \"PageSize\": 1, \"ArchiveMode\": 0, \"Filter\": { \"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\": {}, \"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 } ], \"Include\": [ { \"Path\": [ \"example\" ] } ], \"QueryStateSource\": 0, \"BaseSort\": [ { \"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 } ], \"ExpectedContainerSurfaceId\": \"example\", \"ExpectedTableSurfaceId\": \"example\" }, \"SelectedInstanceIds\": [ \"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/data-transfer/export/csv-zip';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"ProfileId":"example","Query":{"Page":1,"PageSize":1,"ArchiveMode":0,"Filter":{"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":{},"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}],"Include":[{"Path":["example"]}],"QueryStateSource":0,"BaseSort":[{"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}],"ExpectedContainerSurfaceId":"example","ExpectedTableSurfaceId":"example"},"SelectedInstanceIds":["example"]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/workspace/entity/example/data-transfer/export/csv-zip \ --header 'Content-Type: application/json' \ --data '{ "ProfileId": "example", "Query": { "Page": 1, "PageSize": 1, "ArchiveMode": 0, "Filter": { "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": {}, "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 } ], "Include": [ { "Path": [ "example" ] } ], "QueryStateSource": 0, "BaseSort": [ { "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 } ], "ExpectedContainerSurfaceId": "example", "ExpectedTableSurfaceId": "example" }, "SelectedInstanceIds": [ "example" ] }'Exports matching entity instances as a CSV ZIP package using one data transfer profile.
Authorizations
Section titled “Authorizations”- None
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Entity definition identifier or normalized entity key.
Query Parameters
Section titled “Query Parameters”Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.
Request Body
Section titled “Request Body”Profile identifier and current entity instance list query.
Request payload for exporting entity instances through one data transfer profile.
object
Data transfer profile identifier.
Request payload for runtime entity-instance list queries and table bootstrap queries.
object
One-based page number. Values below 1 are normalized to 1.
Requested page size. The default is 25 and the maximum is 250.
One nested logical filter group.
object
Direct conditions inside this group.
One leaf condition in the runtime list query tree.
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 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
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.
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.
Operand list for the selected operator.
One query operand.
object
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.
object
Spatial operand for address-style runtime query conditions.
object
Geographic point in WGS84 coordinates.
object
Latitude in decimal degrees.
Longitude in decimal degrees.
Optional display address selected by the user.
Radius in kilometers for radius-based queries.
Reserved WGS84 bounding box for future spatial queries.
object
Geographic point in WGS84 coordinates.
object
Latitude in decimal degrees.
Longitude in decimal degrees.
Optional display address selected by the user.
Geographic point in WGS84 coordinates.
object
Latitude in decimal degrees.
Longitude in decimal degrees.
Optional display address selected by the user.
Reserved polygon payload for future spatial queries.
Geographic point in WGS84 coordinates.
object
Latitude in decimal degrees.
Longitude in decimal degrees.
Optional display address selected by the user.
Optional multi-level sort list. Supports up to three sort items.
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.
Optional reference include paths materialized into reference projected values.
One post-load reference include path.
object
Runtime field key path segments. Paths resolve through primary-table reference fields only.
Sort owned by the complete saved/global/share query state. Moltaro.Entity.Instances.Requests.EntityInstanceListQueryRequest.Sort remains the current explicit user request and therefore has higher precedence. Ordinary list APIs ignore this value.
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.
Optional Entity List Page identity captured by a UI preflight. Hosted table endpoints reject the request when the route now resolves to a different container, including when that replacement still selects the same Table Surface. An empty value explicitly expects no resolved container; null disables the check for older clients and non-hosted requests.
Optional Table Surface identity captured by a UI preflight. Hosted table and generic Reference picker endpoints reject the request when the host now resolves to a different table, so a filter scoped to one surface is never executed against another. An empty value explicitly expects no resolved table; null disables the check for older clients. Ordinary list APIs ignore this value.
Optional explicit selected-row scope for export. When supplied, the server exports only those accessible ids inside the query context.
Request payload for exporting entity instances through one data transfer profile.
object
Data transfer profile identifier.
Request payload for runtime entity-instance list queries and table bootstrap queries.
object
One-based page number. Values below 1 are normalized to 1.
Requested page size. The default is 25 and the maximum is 250.
One nested logical filter group.
object
Direct conditions inside this group.
One leaf condition in the runtime list query tree.
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 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
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.
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.
Operand list for the selected operator.
One query operand.
object
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.
object
Spatial operand for address-style runtime query conditions.
object
Geographic point in WGS84 coordinates.
object
Latitude in decimal degrees.
Longitude in decimal degrees.
Optional display address selected by the user.
Radius in kilometers for radius-based queries.
Reserved WGS84 bounding box for future spatial queries.
object
Geographic point in WGS84 coordinates.
object
Latitude in decimal degrees.
Longitude in decimal degrees.
Optional display address selected by the user.
Geographic point in WGS84 coordinates.
object
Latitude in decimal degrees.
Longitude in decimal degrees.
Optional display address selected by the user.
Reserved polygon payload for future spatial queries.
Geographic point in WGS84 coordinates.
object
Latitude in decimal degrees.
Longitude in decimal degrees.
Optional display address selected by the user.
Optional multi-level sort list. Supports up to three sort items.
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.
Optional reference include paths materialized into reference projected values.
One post-load reference include path.
object
Runtime field key path segments. Paths resolve through primary-table reference fields only.
Sort owned by the complete saved/global/share query state. Moltaro.Entity.Instances.Requests.EntityInstanceListQueryRequest.Sort remains the current explicit user request and therefore has higher precedence. Ordinary list APIs ignore this value.
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.
Optional Entity List Page identity captured by a UI preflight. Hosted table endpoints reject the request when the route now resolves to a different container, including when that replacement still selects the same Table Surface. An empty value explicitly expects no resolved container; null disables the check for older clients and non-hosted requests.
Optional Table Surface identity captured by a UI preflight. Hosted table and generic Reference picker endpoints reject the request when the host now resolves to a different table, so a filter scoped to one surface is never executed against another. An empty value explicitly expects no resolved table; null disables the check for older clients. Ordinary list APIs ignore this value.
Optional explicit selected-row scope for export. When supplied, the server exports only those accessible ids inside the query context.
Request payload for exporting entity instances through one data transfer profile.
object
Data transfer profile identifier.
Request payload for runtime entity-instance list queries and table bootstrap queries.
object
One-based page number. Values below 1 are normalized to 1.
Requested page size. The default is 25 and the maximum is 250.
One nested logical filter group.
object
Direct conditions inside this group.
One leaf condition in the runtime list query tree.
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 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
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.
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.
Operand list for the selected operator.
One query operand.
object
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.
object
Spatial operand for address-style runtime query conditions.
object
Geographic point in WGS84 coordinates.
object
Latitude in decimal degrees.
Longitude in decimal degrees.
Optional display address selected by the user.
Radius in kilometers for radius-based queries.
Reserved WGS84 bounding box for future spatial queries.
object
Geographic point in WGS84 coordinates.
object
Latitude in decimal degrees.
Longitude in decimal degrees.
Optional display address selected by the user.
Geographic point in WGS84 coordinates.
object
Latitude in decimal degrees.
Longitude in decimal degrees.
Optional display address selected by the user.
Reserved polygon payload for future spatial queries.
Geographic point in WGS84 coordinates.
object
Latitude in decimal degrees.
Longitude in decimal degrees.
Optional display address selected by the user.
Optional multi-level sort list. Supports up to three sort items.
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.
Optional reference include paths materialized into reference projected values.
One post-load reference include path.
object
Runtime field key path segments. Paths resolve through primary-table reference fields only.
Sort owned by the complete saved/global/share query state. Moltaro.Entity.Instances.Requests.EntityInstanceListQueryRequest.Sort remains the current explicit user request and therefore has higher precedence. Ordinary list APIs ignore this value.
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.
Optional Entity List Page identity captured by a UI preflight. Hosted table endpoints reject the request when the route now resolves to a different container, including when that replacement still selects the same Table Surface. An empty value explicitly expects no resolved container; null disables the check for older clients and non-hosted requests.
Optional Table Surface identity captured by a UI preflight. Hosted table and generic Reference picker endpoints reject the request when the host now resolves to a different table, so a filter scoped to one surface is never executed against another. An empty value explicitly expects no resolved table; null disables the check for older clients. Ordinary list APIs ignore this value.
Optional explicit selected-row scope for export. When supplied, the server exports only those accessible ids inside the query context.
Responses
Section titled “Responses”OK
Bad Request
object
Generated CSV ZIP export file content.
object
Download file name.
Download content type.
Serialized ZIP bytes.
object
object
object
object
object
Generated CSV ZIP export file content.
object
Download file name.
Download content type.
Serialized ZIP bytes.
object
object
object
object
Example
{ "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}object
Generated CSV ZIP export file content.
object
Download file name.
Download content type.
Serialized ZIP bytes.
object
object
object
object
Example
{ "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Forbidden
object
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Not Found
object
Generated CSV ZIP export file content.
object
Download file name.
Download content type.
Serialized ZIP bytes.
object
object
object
object
object
Generated CSV ZIP export file content.
object
Download file name.
Download content type.
Serialized ZIP bytes.
object
object
object
object
Example
{ "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}object
Generated CSV ZIP export file content.
object
Download file name.
Download content type.
Serialized ZIP bytes.
object
object
object
object
Example
{ "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Conflict
object
Generated CSV ZIP export file content.
object
Download file name.
Download content type.
Serialized ZIP bytes.
object
object
object
object
object
Generated CSV ZIP export file content.
object
Download file name.
Download content type.
Serialized ZIP bytes.
object
object
object
object
Example
{ "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}object
Generated CSV ZIP export file content.
object
Download file name.
Download content type.
Serialized ZIP bytes.
object
object
object
object
Example
{ "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}