Skip to content

Export JSON.

POST
/api/workspace/entity/{entityIdOrKey}/data-transfer/export/json
curl --request POST \
--url https://example.com/api/workspace/entity/example/data-transfer/export/json \
--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" ] } ] }, "SelectedInstanceIds": [ "example" ] }'

Exports matching entity instances as a JSON file using one data transfer profile.

  • None
entityIdOrKey
required
string

Entity definition identifier or normalized entity key.

access_token
string

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

Profile identifier and current entity instance list query.

Request payload for exporting entity instances through one data transfer profile.

object
ProfileId

Data transfer profile identifier.

string
nullable
Query

Request payload for runtime entity-instance list queries and table bootstrap queries.

object
Page

One-based page number. Values below 1 are normalized to 1.

integer format: int32
PageSize

Requested page size. The default is 25 and the maximum is 250.

integer format: int32
ArchiveMode
integer format: int32
Allowed values: 0 1 2
Filter

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.

object
FieldId

Field identifier or backend-issued synthetic system-field identifier.

string
nullable
FieldKey

Field key resolved through the runtime normalized-key index.

string
nullable
Special
integer format: int32
Allowed values: 0
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 condition target path. Intermediate path segments must be reference fields.

object
Path

Ordered field path from the queried entity to the terminal field.

Array<object>
nullable

Reference to a runtime field by identifier, normalized key, or special query field.

object
FieldId

Field identifier or backend-issued synthetic system-field identifier.

string
nullable
FieldKey

Field key resolved through the runtime normalized-key index.

string
nullable
Special
integer format: int32
Allowed values: 0
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
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.

object
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

Optional multi-level sort list. Supports up to three sort items.

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.

object
FieldId

Field identifier or backend-issued synthetic system-field identifier.

string
nullable
FieldKey

Field key resolved through the runtime normalized-key index.

string
nullable
Special
integer format: int32
Allowed values: 0
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 target path for a runtime list query sort item.

object
Path

Reference path from the queried entity to the sortable terminal field or system field.

Array<object>
nullable

Reference to a runtime field by identifier, normalized key, or special query field.

object
FieldId

Field identifier or backend-issued synthetic system-field identifier.

string
nullable
FieldKey

Field key resolved through the runtime normalized-key index.

string
nullable
Special
integer format: int32
Allowed values: 0
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
Include

Optional reference include paths materialized into reference projected values.

Array<object>
nullable

One post-load reference include path.

object
Path

Runtime field key path segments. Paths resolve through primary-table reference fields only.

Array<string>
nullable
SelectedInstanceIds

Optional explicit selected-row scope for export. When supplied, the server exports only those accessible ids inside the query context.

Array<string>
nullable

OK

Bad Request

Media typeapplication/json
object
Data

Generated JSON export file content.

object
FileName

Download file name.

string
nullable
ContentType

Download content type.

string
nullable
Content

Serialized JSON bytes.

string format: byte
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
{
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Forbidden

Media typeapplication/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Not Found

Media typeapplication/json
object
Data

Generated JSON export file content.

object
FileName

Download file name.

string
nullable
ContentType

Download content type.

string
nullable
Content

Serialized JSON bytes.

string format: byte
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
{
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Conflict

Media typeapplication/json
object
Data

Generated JSON export file content.

object
FileName

Download file name.

string
nullable
ContentType

Download content type.

string
nullable
Content

Serialized JSON bytes.

string format: byte
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
{
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}