Skip to content

Create one JSON export profile for the Sprint 2 export editor.

POST
/api/workspace/admin/entity-definitions/{entityDefinitionId}/data-transfer-profiles/json-export
curl --request POST \
--url https://example.com/api/workspace/admin/entity-definitions/example/data-transfer-profiles/json-export \
--header 'Content-Type: application/json' \
--data '{ "Name": "example", "Key": "example", "IdentityMode": 0, "IdentityFieldId": "example", "SelectedFieldIds": [ "example" ], "ReferenceResolvers": [ { "EntityFieldDefinitionId": "example", "Resolvers": [ { "ResolverMode": 0, "TargetFieldId": "example" } ] } ], "Description": "example" }'
  • None
entityDefinitionId
required
string
access_token
string

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

Request payload to create one JSON export profile slice.

object
Name
required

User-facing profile name.

string
Key
required

Stable technical profile key.

string
IdentityMode
integer format: int32
Allowed values: 0 1 2
IdentityFieldId

Optional identity field identifier.

string
nullable
SelectedFieldIds
required

Ordered export-selected entity field identifiers.

Array<string>
ReferenceResolvers
required

Resolver configuration keyed by entity field definition identifier.

Array<object>

JSON export resolver configuration owned by one entity field definition.

object
EntityFieldDefinitionId
required

Owning entity field definition identifier.

string
Resolvers
required

Ordered resolver rows owned by this field.

Array<object>

One ordered JSON export resolver row for a reference-family field.

object
ResolverMode
integer format: int32
Allowed values: 0 1 2
TargetFieldId

Optional target field identifier when the mode is Moltaro.Enums.EntityDataTransferResolverModeEnum.Field.

string
nullable
Description

Optional user-facing workflow description.

string
nullable

OK

Media typeapplication/json
object
Data

Detailed metadata for one entity data transfer profile.

object
Id

Profile identifier.

string
nullable
EntityDefinitionId

Owning entity definition identifier.

string
nullable
Name

User-facing profile name.

string
nullable
Key

Stable technical profile key.

string
nullable
Direction
integer format: int32
Allowed values: 0 1 2
Format
integer format: int32
Allowed values: 0 1
IdentityMode
integer format: int32
Allowed values: 0 1 2
IdentityFieldId

Optional identity field identifier.

string
nullable
ImportMode
integer format: int32
Allowed values: 0 1 2
Fields

Configured profile fields.

Array<object>
nullable

One configured entity data transfer profile field.

object
Id

Profile field identifier.

string
nullable
ProfileId

Owning profile identifier.

string
nullable
EntityFieldDefinitionId

Referenced entity field definition identifier.

string
nullable
EntityDefinitionTableId

Owning entity definition table identifier.

string
nullable
FieldKey

Referenced field key.

string
nullable
FieldDisplayName

Referenced field display name.

string
nullable
FieldType
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
IncludeInExport

Whether the field participates in export.

boolean
IncludeInImport

Whether the field participates in import.

boolean
TableHandlingMode
integer format: int32
Allowed values: 0 1
SortOrder

Sort order inside the profile field list.

integer format: int32
RowVersion

Concurrency token.

string format: uuid
ReferenceResolvers

Configured reference resolvers.

Array<object>
nullable

One configured reference resolver for a profile field.

object
Id

Resolver identifier.

string
nullable
ProfileFieldId

Owning profile field identifier.

string
nullable
ResolverMode
integer format: int32
Allowed values: 0 1 2
TargetFieldId

Optional target field identifier.

string
nullable
TargetFieldKey

Optional target field key.

string
nullable
TargetFieldDisplayName

Optional target field display name.

string
nullable
TargetDecision
integer format: int32
Allowed values: 0 1 2 3 4 5
SortOrder

Sort order inside the profile field resolver list.

integer format: int32
RowVersion

Concurrency token.

string format: uuid
RowVersion

Concurrency token.

string format: uuid
Description

Optional user-facing workflow description.

string
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": {
"Direction": 0,
"Format": 0,
"IdentityMode": 0,
"ImportMode": 0,
"Fields": [
{
"FieldType": 0,
"TableHandlingMode": 0
}
],
"ReferenceResolvers": [
{
"ResolverMode": 0,
"TargetDecision": 0
}
]
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Bad Request

Media typeapplication/json
object
Data

Detailed metadata for one entity data transfer profile.

object
Id

Profile identifier.

string
nullable
EntityDefinitionId

Owning entity definition identifier.

string
nullable
Name

User-facing profile name.

string
nullable
Key

Stable technical profile key.

string
nullable
Direction
integer format: int32
Allowed values: 0 1 2
Format
integer format: int32
Allowed values: 0 1
IdentityMode
integer format: int32
Allowed values: 0 1 2
IdentityFieldId

Optional identity field identifier.

string
nullable
ImportMode
integer format: int32
Allowed values: 0 1 2
Fields

Configured profile fields.

Array<object>
nullable

One configured entity data transfer profile field.

object
Id

Profile field identifier.

string
nullable
ProfileId

Owning profile identifier.

string
nullable
EntityFieldDefinitionId

Referenced entity field definition identifier.

string
nullable
EntityDefinitionTableId

Owning entity definition table identifier.

string
nullable
FieldKey

Referenced field key.

string
nullable
FieldDisplayName

Referenced field display name.

string
nullable
FieldType
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
IncludeInExport

Whether the field participates in export.

boolean
IncludeInImport

Whether the field participates in import.

boolean
TableHandlingMode
integer format: int32
Allowed values: 0 1
SortOrder

Sort order inside the profile field list.

integer format: int32
RowVersion

Concurrency token.

string format: uuid
ReferenceResolvers

Configured reference resolvers.

Array<object>
nullable

One configured reference resolver for a profile field.

object
Id

Resolver identifier.

string
nullable
ProfileFieldId

Owning profile field identifier.

string
nullable
ResolverMode
integer format: int32
Allowed values: 0 1 2
TargetFieldId

Optional target field identifier.

string
nullable
TargetFieldKey

Optional target field key.

string
nullable
TargetFieldDisplayName

Optional target field display name.

string
nullable
TargetDecision
integer format: int32
Allowed values: 0 1 2 3 4 5
SortOrder

Sort order inside the profile field resolver list.

integer format: int32
RowVersion

Concurrency token.

string format: uuid
RowVersion

Concurrency token.

string format: uuid
Description

Optional user-facing workflow description.

string
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": {
"Direction": 0,
"Format": 0,
"IdentityMode": 0,
"ImportMode": 0,
"Fields": [
{
"FieldType": 0,
"TableHandlingMode": 0
}
],
"ReferenceResolvers": [
{
"ResolverMode": 0,
"TargetDecision": 0
}
]
},
"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

Detailed metadata for one entity data transfer profile.

object
Id

Profile identifier.

string
nullable
EntityDefinitionId

Owning entity definition identifier.

string
nullable
Name

User-facing profile name.

string
nullable
Key

Stable technical profile key.

string
nullable
Direction
integer format: int32
Allowed values: 0 1 2
Format
integer format: int32
Allowed values: 0 1
IdentityMode
integer format: int32
Allowed values: 0 1 2
IdentityFieldId

Optional identity field identifier.

string
nullable
ImportMode
integer format: int32
Allowed values: 0 1 2
Fields

Configured profile fields.

Array<object>
nullable

One configured entity data transfer profile field.

object
Id

Profile field identifier.

string
nullable
ProfileId

Owning profile identifier.

string
nullable
EntityFieldDefinitionId

Referenced entity field definition identifier.

string
nullable
EntityDefinitionTableId

Owning entity definition table identifier.

string
nullable
FieldKey

Referenced field key.

string
nullable
FieldDisplayName

Referenced field display name.

string
nullable
FieldType
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
IncludeInExport

Whether the field participates in export.

boolean
IncludeInImport

Whether the field participates in import.

boolean
TableHandlingMode
integer format: int32
Allowed values: 0 1
SortOrder

Sort order inside the profile field list.

integer format: int32
RowVersion

Concurrency token.

string format: uuid
ReferenceResolvers

Configured reference resolvers.

Array<object>
nullable

One configured reference resolver for a profile field.

object
Id

Resolver identifier.

string
nullable
ProfileFieldId

Owning profile field identifier.

string
nullable
ResolverMode
integer format: int32
Allowed values: 0 1 2
TargetFieldId

Optional target field identifier.

string
nullable
TargetFieldKey

Optional target field key.

string
nullable
TargetFieldDisplayName

Optional target field display name.

string
nullable
TargetDecision
integer format: int32
Allowed values: 0 1 2 3 4 5
SortOrder

Sort order inside the profile field resolver list.

integer format: int32
RowVersion

Concurrency token.

string format: uuid
RowVersion

Concurrency token.

string format: uuid
Description

Optional user-facing workflow description.

string
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": {
"Direction": 0,
"Format": 0,
"IdentityMode": 0,
"ImportMode": 0,
"Fields": [
{
"FieldType": 0,
"TableHandlingMode": 0
}
],
"ReferenceResolvers": [
{
"ResolverMode": 0,
"TargetDecision": 0
}
]
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Conflict

Media typeapplication/json
object
Data

Detailed metadata for one entity data transfer profile.

object
Id

Profile identifier.

string
nullable
EntityDefinitionId

Owning entity definition identifier.

string
nullable
Name

User-facing profile name.

string
nullable
Key

Stable technical profile key.

string
nullable
Direction
integer format: int32
Allowed values: 0 1 2
Format
integer format: int32
Allowed values: 0 1
IdentityMode
integer format: int32
Allowed values: 0 1 2
IdentityFieldId

Optional identity field identifier.

string
nullable
ImportMode
integer format: int32
Allowed values: 0 1 2
Fields

Configured profile fields.

Array<object>
nullable

One configured entity data transfer profile field.

object
Id

Profile field identifier.

string
nullable
ProfileId

Owning profile identifier.

string
nullable
EntityFieldDefinitionId

Referenced entity field definition identifier.

string
nullable
EntityDefinitionTableId

Owning entity definition table identifier.

string
nullable
FieldKey

Referenced field key.

string
nullable
FieldDisplayName

Referenced field display name.

string
nullable
FieldType
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
IncludeInExport

Whether the field participates in export.

boolean
IncludeInImport

Whether the field participates in import.

boolean
TableHandlingMode
integer format: int32
Allowed values: 0 1
SortOrder

Sort order inside the profile field list.

integer format: int32
RowVersion

Concurrency token.

string format: uuid
ReferenceResolvers

Configured reference resolvers.

Array<object>
nullable

One configured reference resolver for a profile field.

object
Id

Resolver identifier.

string
nullable
ProfileFieldId

Owning profile field identifier.

string
nullable
ResolverMode
integer format: int32
Allowed values: 0 1 2
TargetFieldId

Optional target field identifier.

string
nullable
TargetFieldKey

Optional target field key.

string
nullable
TargetFieldDisplayName

Optional target field display name.

string
nullable
TargetDecision
integer format: int32
Allowed values: 0 1 2 3 4 5
SortOrder

Sort order inside the profile field resolver list.

integer format: int32
RowVersion

Concurrency token.

string format: uuid
RowVersion

Concurrency token.

string format: uuid
Description

Optional user-facing workflow description.

string
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": {
"Direction": 0,
"Format": 0,
"IdentityMode": 0,
"ImportMode": 0,
"Fields": [
{
"FieldType": 0,
"TableHandlingMode": 0
}
],
"ReferenceResolvers": [
{
"ResolverMode": 0,
"TargetDecision": 0
}
]
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}