Skip to content
MoltaroMoltaroMoltaro Docs

Save a Form: its root record and the child changes of its WithParent sections in one transaction.

POST
/api/workspace/entity/{entityIdOrKey}/ui/form/{formSurfaceId}/submissions
curl --request POST \
  --url https://example.com/api/workspace/entity/example/ui/form/example/submissions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "OperationKey": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "ExpectedRevision": "example", "Root": { "EntityInstanceId": "example", "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "Fields": { "additionalProperty": "example" }, "ResponsibilityCandidates": [ { "ResponsibilityKey": "example", "Subjects": [ { "SubjectType": "example", "SubjectId": "example", "EffectiveFrom": "2026-04-15T12:00:00Z", "EffectiveTo": "2026-04-15T12:00:00Z" } ] } ], "Resources": { "MarkdownDraftSessionId": "example", "MarkdownDestinationCreateNonce": "example", "FileUploadCreateKey": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }, "ObjectContextMembers": [ { "BindingId": "example", "BindingVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "SchemaVersion": "example", "Handle": { "Resource": { "ModuleKey": "example", "ResourceKind": "example", "ContextResourceId": "example", "ResourceObjectId": "example" }, "Version": "example" }, "Admit": true, "Members": [ { "MemberKey": "example", "Value": "example" } ] } ] }, "Sections": [ { "ItemId": "example", "Children": [ { "LocalId": "example", "Create": { "Fields": { "additionalProperty": "example" }, "ResponsibilityCandidates": [ { "ResponsibilityKey": "example", "Subjects": [ { "SubjectType": "example", "SubjectId": "example", "EffectiveFrom": "2026-04-15T12:00:00Z", "EffectiveTo": "2026-04-15T12:00:00Z" } ] } ], "Resources": { "MarkdownDraftSessionId": "example", "MarkdownDestinationCreateNonce": "example", "FileUploadCreateKey": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }, "ObjectContextMembers": [ { "BindingId": "example", "BindingVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "SchemaVersion": "example", "Handle": { "Resource": { "ModuleKey": "example", "ResourceKind": "example", "ContextResourceId": "example", "ResourceObjectId": "example" }, "Version": "example" }, "Admit": true, "Members": [ { "MemberKey": "example", "Value": "example" } ] } ] } } ], "HiddenPolicy": { "AffectedSetToken": "example", "Reason": "example" } } ], "Origin": { "SourceEntityDefinitionId": "example", "SourceEntityInstanceId": "example", "SourceInverseFieldId": "example" } }'

The root is a Create, an Update with its changed fields, or an Edit with empty Fields that only verifies the root. Every section names a WithParent related-table item of this Form; its children are Create, Update, Archive (an active child) or Delete (an archived child) actions, each with a client LocalId. The server resolves every relation and sets the Reference of each child to the root; the client never sends it. Everything commits or nothing does, with the caller’s own Entity Security for every record. A save that would write no record answers moltaro.ui.form.submission.nothingToSave.

Send one caller-generated OperationKey per logical save and reuse it only for an exact retry of the same body: a committed request answers its stored result with IsIdempotentReplay: true for seven days without writing again. ExpectedRevision is the Submission.Revision of the runtime Form; a changed Form, child Form, record type or role answers moltaro.ui.form.submission.revisionChanged. An error answer names the failing member in Field, the participant in Metadata.LocalId and its section in Metadata.ItemId. The body is limited to the host’s request size (413), and the number of written records (root, child actions, policy archives) to the host’s step limit, 100 by default. Markdown draft sessions and File upload keys travel in each participant’s Resources; the X-Moltaro-Markdown-* headers are refused here.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
entityIdOrKey
required
string

Root Entity definition identifier or key.

formSurfaceId
required
string

The Form surface.

Query Parameters

Section titled “Query Parameters”
access_token
string

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

Request Bodyrequired

Section titled “Request Bodyrequired”

The save.

Saves one native Form — its root record and the child changes of its WithParent related-table sections — in one transaction: everything commits or nothing does. The server resolves every section, relation and child Form from the configuration; the client never sends a child definition, an inverse binding or the child Reference.

object
OperationKey
required

Caller-generated UUID of this logical save; reused only for an exact retry of the same body.

string format: uuid
ExpectedRevision
required

The Submission.Revision of the runtime Form the draft was edited in.

string
Root
required

The root record. Create: EntityInstanceId and RowVersion are null. Edit: both are required and Fields holds the changed fields only; an empty Fields verifies the root without writing it.

object
EntityInstanceId

The edited root record; null for a Create.

string
nullable
RowVersion

Row version of the edited root the user saw; null for a Create.

string format: uuid
nullable
Fields
required

Primary field values keyed by stable field key; every supplied value needs its write right.

object
key
additional properties
ResponsibilityCandidates

Create only: StageOnCreate responsibility candidates.

Array<object>
nullable

Caller-proposed initial subjects of one responsibility of a created record.

object
ResponsibilityKey
required

Stable responsibility key.

string
Subjects
required

Proposed subjects.

Array<object>

One proposed responsibility subject.

object
SubjectType
required

Subject type, such as a user or a Workspace User Group.

string
SubjectId
required

Subject identifier.

string
EffectiveFrom
required

Start of the assignment.

string format: date-time
EffectiveTo

Optional end of the assignment.

string format: date-time
nullable
Resources

Draft resources of one participant. A new participant names its Markdown draft session, its destination create nonce and the create key of its direct File uploads; an existing participant names its Markdown draft session only. No value may appear on two participants.

object
MarkdownDraftSessionId

Markdown attachment draft session adopted by this record.

string
nullable
MarkdownDestinationCreateNonce

Create only: destination create nonce of that session.

string
nullable
FileUploadCreateKey

Create only: the CreateOperationKey of the direct File uploads of this record.

string format: uuid
nullable
ObjectContextMembers

Changed context members, shared by every occurrence of their binding in this record draft.

Array<object>
nullable

Values of one context binding in a record’s atomic Form save.

object
BindingId
required
string
BindingVersion
required
string format: uuid
SchemaVersion
required
string
Handle

The exact source instance the person edited; null for initial admission.

object
Resource
required

Transport identity of a context resource; resolution and authorization belong to its provider.

object
ModuleKey
required
string
ResourceKind
required
string
ContextResourceId
required
string
ResourceObjectId
required
string
Version
required
string
Admit
boolean
Members
required
Array<object>

A changed member. JSON null clears a value; omitting Value is invalid.

object
MemberKey
required
string
Value
required
Sections
required

Child changes per WithParent section, at most one entry per item; empty when only the root changes.

Array<object>

The child changes of one WithParent section.

object
ItemId
required

The WithParent item that owns the relation’s child draft (RelatedChild.SectionItemId of the runtime model), at most once per request; another item of the same relation is refused.

string
Children
required

Child actions; the order is kept in the answer.

Array
One of:

A new child record of the section.

object
LocalId
required

Client identity of the child in this save, unique ignoring case; not root and not starting with policy- (ignoring case). Errors of the child repeat it in Metadata.LocalId.

string
>= 1 characters <= 64 characters /^[A-Za-z0-9][A-Za-z0-9._-]*$/
Create
required

The values of a new child; the Reference to the parent is set by the server.

object
Fields
required

Primary field values keyed by stable field key.

object
key
additional properties
ResponsibilityCandidates

StageOnCreate responsibility candidates.

Array<object>
nullable

Caller-proposed initial subjects of one responsibility of a created record.

object
ResponsibilityKey
required

Stable responsibility key.

string
Subjects
required

Proposed subjects.

Array<object>

One proposed responsibility subject.

object
SubjectType
required

Subject type, such as a user or a Workspace User Group.

string
SubjectId
required

Subject identifier.

string
EffectiveFrom
required

Start of the assignment.

string format: date-time
EffectiveTo

Optional end of the assignment.

string format: date-time
nullable
Resources

Draft resources of one participant. A new participant names its Markdown draft session, its destination create nonce and the create key of its direct File uploads; an existing participant names its Markdown draft session only. No value may appear on two participants.

object
MarkdownDraftSessionId

Markdown attachment draft session adopted by this record.

string
nullable
MarkdownDestinationCreateNonce

Create only: destination create nonce of that session.

string
nullable
FileUploadCreateKey

Create only: the CreateOperationKey of the direct File uploads of this record.

string format: uuid
nullable
ObjectContextMembers

Initial context participation of this new child.

Array<object>
nullable

Values of one context binding in a record’s atomic Form save.

object
BindingId
required
string
BindingVersion
required
string format: uuid
SchemaVersion
required
string
Handle

The exact source instance the person edited; null for initial admission.

object
Resource
required

Transport identity of a context resource; resolution and authorization belong to its provider.

object
ModuleKey
required
string
ResourceKind
required
string
ContextResourceId
required
string
ResourceObjectId
required
string
Version
required
string
Admit
boolean
Members
required
Array<object>

A changed member. JSON null clears a value; omitting Value is invalid.

object
MemberKey
required
string
Value
required
HiddenPolicy

The confirmed Archive policy decision of a hidden section, taken from its preview.

object
AffectedSetToken
required

The token of the previewed active set.

string
Reason

Optional archive Reason recorded on every archived child.

string
nullable
Origin

The record a related-create is started from and the relation it is created under. The server sets the paired Reference of the new root to this record; a different client value for it is refused.

object
SourceEntityDefinitionId
required

Definition of the source record.

string
SourceEntityInstanceId
required

The source record.

string
SourceInverseFieldId
required

The InverseReference of the source definition whose paired Reference belongs to the root definition.

string
Examplegenerated
{
  "OperationKey": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "ExpectedRevision": "example",
  "Root": {
    "EntityInstanceId": "example",
    "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "Fields": {
      "additionalProperty": "example"
    },
    "ResponsibilityCandidates": [
      {
        "ResponsibilityKey": "example",
        "Subjects": [
          {
            "SubjectType": "example",
            "SubjectId": "example",
            "EffectiveFrom": "2026-04-15T12:00:00Z",
            "EffectiveTo": "2026-04-15T12:00:00Z"
          }
        ]
      }
    ],
    "Resources": {
      "MarkdownDraftSessionId": "example",
      "MarkdownDestinationCreateNonce": "example",
      "FileUploadCreateKey": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
    },
    "ObjectContextMembers": [
      {
        "BindingId": "example",
        "BindingVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "SchemaVersion": "example",
        "Handle": {
          "Resource": {
            "ModuleKey": "example",
            "ResourceKind": "example",
            "ContextResourceId": "example",
            "ResourceObjectId": "example"
          },
          "Version": "example"
        },
        "Admit": true,
        "Members": [
          {
            "MemberKey": "example",
            "Value": "example"
          }
        ]
      }
    ]
  },
  "Sections": [
    {
      "ItemId": "example",
      "Children": [
        {
          "LocalId": "example",
          "Create": {
            "Fields": {
              "additionalProperty": "example"
            },
            "ResponsibilityCandidates": [
              {
                "ResponsibilityKey": "example",
                "Subjects": [
                  {
                    "SubjectType": "example",
                    "SubjectId": "example",
                    "EffectiveFrom": "2026-04-15T12:00:00Z",
                    "EffectiveTo": "2026-04-15T12:00:00Z"
                  }
                ]
              }
            ],
            "Resources": {
              "MarkdownDraftSessionId": "example",
              "MarkdownDestinationCreateNonce": "example",
              "FileUploadCreateKey": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
            },
            "ObjectContextMembers": [
              {
                "BindingId": "example",
                "BindingVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
                "SchemaVersion": "example",
                "Handle": {
                  "Resource": {
                    "ModuleKey": "example",
                    "ResourceKind": "example",
                    "ContextResourceId": "example",
                    "ResourceObjectId": "example"
                  },
                  "Version": "example"
                },
                "Admit": true,
                "Members": [
                  {
                    "MemberKey": "example",
                    "Value": "example"
                  }
                ]
              }
            ]
          }
        }
      ],
      "HiddenPolicy": {
        "AffectedSetToken": "example",
        "Reason": "example"
      }
    }
  ],
  "Origin": {
    "SourceEntityDefinitionId": "example",
    "SourceEntityInstanceId": "example",
    "SourceInverseFieldId": "example"
  }
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
Data

The committed result; null when the answer is an error, which Errors then describes.

object
OperationKey
required

Operation key of the committed submission.

string format: uuid
CompletedAt
required

Captured completion instant of the commit.

string format: date-time
AuditCorrelationId
required

Audit correlation shared by every participant.

string
IsIdempotentReplay
required

Whether this answer returns the stored result of an earlier commit without another write.

boolean
Root
required

The outcome of one participant.

object
LocalId
required

root, the request LocalId of a child, or policy-<n> for an Archive policy item.

string
ItemId

The draft-owner item of a child’s section; null for the root.

string
nullable
Action
required

What a committed Form submission did with one participant.

integer format: int32
Allowed values: 0 1 2 3 4
Result
required
One of: discriminator: Kind

A record the caller can read: its identity and the row version the submission committed or verified.

object
EntityDefinitionId
required

Entity definition identifier.

string
EntityInstanceId
required

Entity record identifier.

string
RowVersion
required

Committed row version; for an unchanged root, the verified one.

string format: uuid
Kind
required
string
Allowed values: RecordIdentity
Children
required

Child participants in request order, then the archives of a confirmed Archive policy.

Array<object>

The outcome of one participant.

object
LocalId
required

root, the request LocalId of a child, or policy-<n> for an Archive policy item.

string
ItemId

The draft-owner item of a child’s section; null for the root.

string
nullable
Action
required

What a committed Form submission did with one participant.

integer format: int32
Allowed values: 0 1 2 3 4
Result
required
One of: discriminator: Kind

A record the caller can read: its identity and the row version the submission committed or verified.

object
EntityDefinitionId
required

Entity definition identifier.

string
EntityInstanceId
required

Entity record identifier.

string
RowVersion
required

Committed row version; for an unchanged root, the verified one.

string format: uuid
Kind
required
string
Allowed values: RecordIdentity
Kind
required
string
Allowed values: EntityFormSubmission
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": {
    "Root": {
      "Action": 0,
      "Result": {
        "Kind": "RecordIdentity"
      }
    },
    "Children": [
      {
        "Action": 0,
        "Result": {
          "Kind": "RecordIdentity"
        }
      }
    ],
    "Kind": "EntityFormSubmission"
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Section titled “400”

Bad Request

Media typeapplication/json
object
Data

The committed result; null when the answer is an error, which Errors then describes.

object
OperationKey
required

Operation key of the committed submission.

string format: uuid
CompletedAt
required

Captured completion instant of the commit.

string format: date-time
AuditCorrelationId
required

Audit correlation shared by every participant.

string
IsIdempotentReplay
required

Whether this answer returns the stored result of an earlier commit without another write.

boolean
Root
required

The outcome of one participant.

object
LocalId
required

root, the request LocalId of a child, or policy-<n> for an Archive policy item.

string
ItemId

The draft-owner item of a child’s section; null for the root.

string
nullable
Action
required

What a committed Form submission did with one participant.

integer format: int32
Allowed values: 0 1 2 3 4
Result
required
One of: discriminator: Kind

A record the caller can read: its identity and the row version the submission committed or verified.

object
EntityDefinitionId
required

Entity definition identifier.

string
EntityInstanceId
required

Entity record identifier.

string
RowVersion
required

Committed row version; for an unchanged root, the verified one.

string format: uuid
Kind
required
string
Allowed values: RecordIdentity
Children
required

Child participants in request order, then the archives of a confirmed Archive policy.

Array<object>

The outcome of one participant.

object
LocalId
required

root, the request LocalId of a child, or policy-<n> for an Archive policy item.

string
ItemId

The draft-owner item of a child’s section; null for the root.

string
nullable
Action
required

What a committed Form submission did with one participant.

integer format: int32
Allowed values: 0 1 2 3 4
Result
required
One of: discriminator: Kind

A record the caller can read: its identity and the row version the submission committed or verified.

object
EntityDefinitionId
required

Entity definition identifier.

string
EntityInstanceId
required

Entity record identifier.

string
RowVersion
required

Committed row version; for an unchanged root, the verified one.

string format: uuid
Kind
required
string
Allowed values: RecordIdentity
Kind
required
string
Allowed values: EntityFormSubmission
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": {
    "Root": {
      "Action": 0,
      "Result": {
        "Kind": "RecordIdentity"
      }
    },
    "Children": [
      {
        "Action": 0,
        "Result": {
          "Kind": "RecordIdentity"
        }
      }
    ],
    "Kind": "EntityFormSubmission"
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
Data

The committed result; null when the answer is an error, which Errors then describes.

object
OperationKey
required

Operation key of the committed submission.

string format: uuid
CompletedAt
required

Captured completion instant of the commit.

string format: date-time
AuditCorrelationId
required

Audit correlation shared by every participant.

string
IsIdempotentReplay
required

Whether this answer returns the stored result of an earlier commit without another write.

boolean
Root
required

The outcome of one participant.

object
LocalId
required

root, the request LocalId of a child, or policy-<n> for an Archive policy item.

string
ItemId

The draft-owner item of a child’s section; null for the root.

string
nullable
Action
required

What a committed Form submission did with one participant.

integer format: int32
Allowed values: 0 1 2 3 4
Result
required
One of: discriminator: Kind

A record the caller can read: its identity and the row version the submission committed or verified.

object
EntityDefinitionId
required

Entity definition identifier.

string
EntityInstanceId
required

Entity record identifier.

string
RowVersion
required

Committed row version; for an unchanged root, the verified one.

string format: uuid
Kind
required
string
Allowed values: RecordIdentity
Children
required

Child participants in request order, then the archives of a confirmed Archive policy.

Array<object>

The outcome of one participant.

object
LocalId
required

root, the request LocalId of a child, or policy-<n> for an Archive policy item.

string
ItemId

The draft-owner item of a child’s section; null for the root.

string
nullable
Action
required

What a committed Form submission did with one participant.

integer format: int32
Allowed values: 0 1 2 3 4
Result
required
One of: discriminator: Kind

A record the caller can read: its identity and the row version the submission committed or verified.

object
EntityDefinitionId
required

Entity definition identifier.

string
EntityInstanceId
required

Entity record identifier.

string
RowVersion
required

Committed row version; for an unchanged root, the verified one.

string format: uuid
Kind
required
string
Allowed values: RecordIdentity
Kind
required
string
Allowed values: EntityFormSubmission
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": {
    "Root": {
      "Action": 0,
      "Result": {
        "Kind": "RecordIdentity"
      }
    },
    "Children": [
      {
        "Action": 0,
        "Result": {
          "Kind": "RecordIdentity"
        }
      }
    ],
    "Kind": "EntityFormSubmission"
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

404

Section titled “404”

Not Found

Media typeapplication/json
object
Data

The committed result; null when the answer is an error, which Errors then describes.

object
OperationKey
required

Operation key of the committed submission.

string format: uuid
CompletedAt
required

Captured completion instant of the commit.

string format: date-time
AuditCorrelationId
required

Audit correlation shared by every participant.

string
IsIdempotentReplay
required

Whether this answer returns the stored result of an earlier commit without another write.

boolean
Root
required

The outcome of one participant.

object
LocalId
required

root, the request LocalId of a child, or policy-<n> for an Archive policy item.

string
ItemId

The draft-owner item of a child’s section; null for the root.

string
nullable
Action
required

What a committed Form submission did with one participant.

integer format: int32
Allowed values: 0 1 2 3 4
Result
required
One of: discriminator: Kind

A record the caller can read: its identity and the row version the submission committed or verified.

object
EntityDefinitionId
required

Entity definition identifier.

string
EntityInstanceId
required

Entity record identifier.

string
RowVersion
required

Committed row version; for an unchanged root, the verified one.

string format: uuid
Kind
required
string
Allowed values: RecordIdentity
Children
required

Child participants in request order, then the archives of a confirmed Archive policy.

Array<object>

The outcome of one participant.

object
LocalId
required

root, the request LocalId of a child, or policy-<n> for an Archive policy item.

string
ItemId

The draft-owner item of a child’s section; null for the root.

string
nullable
Action
required

What a committed Form submission did with one participant.

integer format: int32
Allowed values: 0 1 2 3 4
Result
required
One of: discriminator: Kind

A record the caller can read: its identity and the row version the submission committed or verified.

object
EntityDefinitionId
required

Entity definition identifier.

string
EntityInstanceId
required

Entity record identifier.

string
RowVersion
required

Committed row version; for an unchanged root, the verified one.

string format: uuid
Kind
required
string
Allowed values: RecordIdentity
Kind
required
string
Allowed values: EntityFormSubmission
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": {
    "Root": {
      "Action": 0,
      "Result": {
        "Kind": "RecordIdentity"
      }
    },
    "Children": [
      {
        "Action": 0,
        "Result": {
          "Kind": "RecordIdentity"
        }
      }
    ],
    "Kind": "EntityFormSubmission"
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

409

Section titled “409”

Conflict

Media typeapplication/json
object
Data

The committed result; null when the answer is an error, which Errors then describes.

object
OperationKey
required

Operation key of the committed submission.

string format: uuid
CompletedAt
required

Captured completion instant of the commit.

string format: date-time
AuditCorrelationId
required

Audit correlation shared by every participant.

string
IsIdempotentReplay
required

Whether this answer returns the stored result of an earlier commit without another write.

boolean
Root
required

The outcome of one participant.

object
LocalId
required

root, the request LocalId of a child, or policy-<n> for an Archive policy item.

string
ItemId

The draft-owner item of a child’s section; null for the root.

string
nullable
Action
required

What a committed Form submission did with one participant.

integer format: int32
Allowed values: 0 1 2 3 4
Result
required
One of: discriminator: Kind

A record the caller can read: its identity and the row version the submission committed or verified.

object
EntityDefinitionId
required

Entity definition identifier.

string
EntityInstanceId
required

Entity record identifier.

string
RowVersion
required

Committed row version; for an unchanged root, the verified one.

string format: uuid
Kind
required
string
Allowed values: RecordIdentity
Children
required

Child participants in request order, then the archives of a confirmed Archive policy.

Array<object>

The outcome of one participant.

object
LocalId
required

root, the request LocalId of a child, or policy-<n> for an Archive policy item.

string
ItemId

The draft-owner item of a child’s section; null for the root.

string
nullable
Action
required

What a committed Form submission did with one participant.

integer format: int32
Allowed values: 0 1 2 3 4
Result
required
One of: discriminator: Kind

A record the caller can read: its identity and the row version the submission committed or verified.

object
EntityDefinitionId
required

Entity definition identifier.

string
EntityInstanceId
required

Entity record identifier.

string
RowVersion
required

Committed row version; for an unchanged root, the verified one.

string format: uuid
Kind
required
string
Allowed values: RecordIdentity
Kind
required
string
Allowed values: EntityFormSubmission
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": {
    "Root": {
      "Action": 0,
      "Result": {
        "Kind": "RecordIdentity"
      }
    },
    "Children": [
      {
        "Action": 0,
        "Result": {
          "Kind": "RecordIdentity"
        }
      }
    ],
    "Kind": "EntityFormSubmission"
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

413

Section titled “413”

Content Too Large

Media typeapplication/json
object
Data

The committed result; null when the answer is an error, which Errors then describes.

object
OperationKey
required

Operation key of the committed submission.

string format: uuid
CompletedAt
required

Captured completion instant of the commit.

string format: date-time
AuditCorrelationId
required

Audit correlation shared by every participant.

string
IsIdempotentReplay
required

Whether this answer returns the stored result of an earlier commit without another write.

boolean
Root
required

The outcome of one participant.

object
LocalId
required

root, the request LocalId of a child, or policy-<n> for an Archive policy item.

string
ItemId

The draft-owner item of a child’s section; null for the root.

string
nullable
Action
required

What a committed Form submission did with one participant.

integer format: int32
Allowed values: 0 1 2 3 4
Result
required
One of: discriminator: Kind

A record the caller can read: its identity and the row version the submission committed or verified.

object
EntityDefinitionId
required

Entity definition identifier.

string
EntityInstanceId
required

Entity record identifier.

string
RowVersion
required

Committed row version; for an unchanged root, the verified one.

string format: uuid
Kind
required
string
Allowed values: RecordIdentity
Children
required

Child participants in request order, then the archives of a confirmed Archive policy.

Array<object>

The outcome of one participant.

object
LocalId
required

root, the request LocalId of a child, or policy-<n> for an Archive policy item.

string
ItemId

The draft-owner item of a child’s section; null for the root.

string
nullable
Action
required

What a committed Form submission did with one participant.

integer format: int32
Allowed values: 0 1 2 3 4
Result
required
One of: discriminator: Kind

A record the caller can read: its identity and the row version the submission committed or verified.

object
EntityDefinitionId
required

Entity definition identifier.

string
EntityInstanceId
required

Entity record identifier.

string
RowVersion
required

Committed row version; for an unchanged root, the verified one.

string format: uuid
Kind
required
string
Allowed values: RecordIdentity
Kind
required
string
Allowed values: EntityFormSubmission
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": {
    "Root": {
      "Action": 0,
      "Result": {
        "Kind": "RecordIdentity"
      }
    },
    "Children": [
      {
        "Action": 0,
        "Result": {
          "Kind": "RecordIdentity"
        }
      }
    ],
    "Kind": "EntityFormSubmission"
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

503

Section titled “503”

Service Unavailable

Media typeapplication/json
object
Data

The committed result; null when the answer is an error, which Errors then describes.

object
OperationKey
required

Operation key of the committed submission.

string format: uuid
CompletedAt
required

Captured completion instant of the commit.

string format: date-time
AuditCorrelationId
required

Audit correlation shared by every participant.

string
IsIdempotentReplay
required

Whether this answer returns the stored result of an earlier commit without another write.

boolean
Root
required

The outcome of one participant.

object
LocalId
required

root, the request LocalId of a child, or policy-<n> for an Archive policy item.

string
ItemId

The draft-owner item of a child’s section; null for the root.

string
nullable
Action
required

What a committed Form submission did with one participant.

integer format: int32
Allowed values: 0 1 2 3 4
Result
required
One of: discriminator: Kind

A record the caller can read: its identity and the row version the submission committed or verified.

object
EntityDefinitionId
required

Entity definition identifier.

string
EntityInstanceId
required

Entity record identifier.

string
RowVersion
required

Committed row version; for an unchanged root, the verified one.

string format: uuid
Kind
required
string
Allowed values: RecordIdentity
Children
required

Child participants in request order, then the archives of a confirmed Archive policy.

Array<object>

The outcome of one participant.

object
LocalId
required

root, the request LocalId of a child, or policy-<n> for an Archive policy item.

string
ItemId

The draft-owner item of a child’s section; null for the root.

string
nullable
Action
required

What a committed Form submission did with one participant.

integer format: int32
Allowed values: 0 1 2 3 4
Result
required
One of: discriminator: Kind

A record the caller can read: its identity and the row version the submission committed or verified.

object
EntityDefinitionId
required

Entity definition identifier.

string
EntityInstanceId
required

Entity record identifier.

string
RowVersion
required

Committed row version; for an unchanged root, the verified one.

string format: uuid
Kind
required
string
Allowed values: RecordIdentity
Kind
required
string
Allowed values: EntityFormSubmission
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": {
    "Root": {
      "Action": 0,
      "Result": {
        "Kind": "RecordIdentity"
      }
    },
    "Children": [
      {
        "Action": 0,
        "Result": {
          "Kind": "RecordIdentity"
        }
      }
    ],
    "Kind": "EntityFormSubmission"
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}