Restore selected archived rows.

POST

/api/workspace/entity/{entityIdOrKey}/instances/bulk/restore

curl --request POST \
  --url https://example.com/api/workspace/entity/example/instances/bulk/restore \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "OperationKey": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "Rows": [ { "InstanceId": "example", "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "InputOrdinal": 1, "CallerCorrelation": "example" } ], "Reason": "example" }'

Requires one Reason of 1–1000 characters after trimming; it is stored with each row’s lifecycle audit evidence. A missing or over-long reason rejects the whole request before any row changes.

Authorizations

• WorkspaceBearer

Parameters

Path Parameters

entityIdOrKey

required

string

Query Parameters

access_token

string

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

Request Body

Selected runtime entity instances for a bulk lifecycle operation.

object

OperationKey

Stable caller key used to derive replay-safe per-row operation keys.

string format: uuid

Rows

Explicitly selected rows. Bulk operations never imply “all matching query”.

Array<object>

nullable

One selected runtime entity instance in a bulk action request.

object

InstanceId

Selected entity instance identifier.

string

nullable

RowVersion

Expected runtime row version when the operation mutates the row.

string format: uuid

nullable

InputOrdinal

Caller-provided input position used for safe per-item correlation.

integer format: int32

nullable

CallerCorrelation

Optional caller-provided opaque correlation value.

string

nullable

Reason

required

Required audit reason shared by every selected row. Must contain 1–1000 characters after trimming leading and trailing whitespace; it is stored with each row’s archive, restore or permanent delete.

string

Example^generated

{
  "OperationKey": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "Rows": [
    {
      "InstanceId": "example",
      "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "InputOrdinal": 1,
      "CallerCorrelation": "example"
    }
  ],
  "Reason": "example"
}

Selected runtime entity instances for a bulk lifecycle operation.

object

OperationKey

Stable caller key used to derive replay-safe per-row operation keys.

string format: uuid

Rows

Explicitly selected rows. Bulk operations never imply “all matching query”.

Array<object>

nullable

One selected runtime entity instance in a bulk action request.

object

InstanceId

Selected entity instance identifier.

string

nullable

RowVersion

Expected runtime row version when the operation mutates the row.

string format: uuid

nullable

InputOrdinal

Caller-provided input position used for safe per-item correlation.

integer format: int32

nullable

CallerCorrelation

Optional caller-provided opaque correlation value.

string

nullable

Reason

required

Required audit reason shared by every selected row. Must contain 1–1000 characters after trimming leading and trailing whitespace; it is stored with each row’s archive, restore or permanent delete.

string

Example^generated

{
  "OperationKey": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "Rows": [
    {
      "InstanceId": "example",
      "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "InputOrdinal": 1,
      "CallerCorrelation": "example"
    }
  ],
  "Reason": "example"
}

Selected runtime entity instances for a bulk lifecycle operation.

object

OperationKey

Stable caller key used to derive replay-safe per-row operation keys.

string format: uuid

Rows

Explicitly selected rows. Bulk operations never imply “all matching query”.

Array<object>

nullable

One selected runtime entity instance in a bulk action request.

object

InstanceId

Selected entity instance identifier.

string

nullable

RowVersion

Expected runtime row version when the operation mutates the row.

string format: uuid

nullable

InputOrdinal

Caller-provided input position used for safe per-item correlation.

integer format: int32

nullable

CallerCorrelation

Optional caller-provided opaque correlation value.

string

nullable

Reason

required

Required audit reason shared by every selected row. Must contain 1–1000 characters after trimming leading and trailing whitespace; it is stored with each row’s archive, restore or permanent delete.

string

Example^generated

{
  "OperationKey": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "Rows": [
    {
      "InstanceId": "example",
      "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "InputOrdinal": 1,
      "CallerCorrelation": "example"
    }
  ],
  "Reason": "example"
}

Responses

200

OK

Media typeapplication/json

object

Data

object

OperationKey

string format: uuid

Items

Array

nullable

One of: discriminator: Kind

object

object

Data

required

object

EntityDefinitionId

required

string

EntityInstanceId

required

string

RowVersion

required

string format: uuid

CanViewResult

required

boolean

Kind

required

string

Allowed values: AuthorizedEntityIdentity

object

Receipt of a committed Entity record mutation whose post-state the caller cannot read now.

object

OperationKey

required

Operation key of the committed operation.

string format: uuid

CompletedAt

required

Completion instant of the committed operation. A receipt built when a replay can no longer show its stored result carries the instant the replayed command committed.

string format: date-time

AuditCorrelationId

required

Audit correlation of the committed operation. A receipt built when a replay can no longer show its stored result carries the correlation of the replaying call instead.

string

IsIdempotentReplay

required

Whether this answer repeats an earlier committed operation without another write.

boolean

Success

required

boolean

CanViewResult

required

boolean

CallerKnownIdentity

required

Entity record identity carried by a receipt: only values the caller already knew.

object

EntityDefinitionId

required

Entity definition identifier.

string

EntityInstanceId

required

Entity record identifier.

string

ResponsibilityCode

Responsibility key a bulk assignment or removal item sent; left out for record mutations.

string

nullable

Kind

required

string

Allowed values: Receipt

object

object

InputOrdinal

integer format: int32

nullable

CallerCorrelation

string

nullable

Code

required

string

Field

string

nullable

Kind

required

string

Allowed values: Failure

Kind

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": {
    "Items": [
      {
        "Kind": "AuthorizedEntityIdentity"
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Bad Request

Media typeapplication/json

object

Data

object

OperationKey

string format: uuid

Items

Array

nullable

One of: discriminator: Kind

object

object

Data

required

object

EntityDefinitionId

required

string

EntityInstanceId

required

string

RowVersion

required

string format: uuid

CanViewResult

required

boolean

Kind

required

string

Allowed values: AuthorizedEntityIdentity

object

Receipt of a committed Entity record mutation whose post-state the caller cannot read now.

object

OperationKey

required

Operation key of the committed operation.

string format: uuid

CompletedAt

required

Completion instant of the committed operation. A receipt built when a replay can no longer show its stored result carries the instant the replayed command committed.

string format: date-time

AuditCorrelationId

required

Audit correlation of the committed operation. A receipt built when a replay can no longer show its stored result carries the correlation of the replaying call instead.

string

IsIdempotentReplay

required

Whether this answer repeats an earlier committed operation without another write.

boolean

Success

required

boolean

CanViewResult

required

boolean

CallerKnownIdentity

required

Entity record identity carried by a receipt: only values the caller already knew.

object

EntityDefinitionId

required

Entity definition identifier.

string

EntityInstanceId

required

Entity record identifier.

string

ResponsibilityCode

Responsibility key a bulk assignment or removal item sent; left out for record mutations.

string

nullable

Kind

required

string

Allowed values: Receipt

object

object

InputOrdinal

integer format: int32

nullable

CallerCorrelation

string

nullable

Code

required

string

Field

string

nullable

Kind

required

string

Allowed values: Failure

Kind

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": {
    "Items": [
      {
        "Kind": "AuthorizedEntityIdentity"
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

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

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

Media typeapplication/json

object

Data

object

OperationKey

string format: uuid

Items

Array

nullable

One of: discriminator: Kind

object

object

Data

required

object

EntityDefinitionId

required

string

EntityInstanceId

required

string

RowVersion

required

string format: uuid

CanViewResult

required

boolean

Kind

required

string

Allowed values: AuthorizedEntityIdentity

object

Receipt of a committed Entity record mutation whose post-state the caller cannot read now.

object

OperationKey

required

Operation key of the committed operation.

string format: uuid

CompletedAt

required

Completion instant of the committed operation. A receipt built when a replay can no longer show its stored result carries the instant the replayed command committed.

string format: date-time

AuditCorrelationId

required

Audit correlation of the committed operation. A receipt built when a replay can no longer show its stored result carries the correlation of the replaying call instead.

string

IsIdempotentReplay

required

Whether this answer repeats an earlier committed operation without another write.

boolean

Success

required

boolean

CanViewResult

required

boolean

CallerKnownIdentity

required

Entity record identity carried by a receipt: only values the caller already knew.

object

EntityDefinitionId

required

Entity definition identifier.

string

EntityInstanceId

required

Entity record identifier.

string

ResponsibilityCode

Responsibility key a bulk assignment or removal item sent; left out for record mutations.

string

nullable

Kind

required

string

Allowed values: Receipt

object

object

InputOrdinal

integer format: int32

nullable

CallerCorrelation

string

nullable

Code

required

string

Field

string

nullable

Kind

required

string

Allowed values: Failure

Kind

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": {
    "Items": [
      {
        "Kind": "AuthorizedEntityIdentity"
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

409

Conflict

Media typeapplication/json

object

Data

object

OperationKey

string format: uuid

Items

Array

nullable

One of: discriminator: Kind

object

object

Data

required

object

EntityDefinitionId

required

string

EntityInstanceId

required

string

RowVersion

required

string format: uuid

CanViewResult

required

boolean

Kind

required

string

Allowed values: AuthorizedEntityIdentity

object

Receipt of a committed Entity record mutation whose post-state the caller cannot read now.

object

OperationKey

required

Operation key of the committed operation.

string format: uuid

CompletedAt

required

Completion instant of the committed operation. A receipt built when a replay can no longer show its stored result carries the instant the replayed command committed.

string format: date-time

AuditCorrelationId

required

Audit correlation of the committed operation. A receipt built when a replay can no longer show its stored result carries the correlation of the replaying call instead.

string

IsIdempotentReplay

required

Whether this answer repeats an earlier committed operation without another write.

boolean

Success

required

boolean

CanViewResult

required

boolean

CallerKnownIdentity

required

Entity record identity carried by a receipt: only values the caller already knew.

object

EntityDefinitionId

required

Entity definition identifier.

string

EntityInstanceId

required

Entity record identifier.

string

ResponsibilityCode

Responsibility key a bulk assignment or removal item sent; left out for record mutations.

string

nullable

Kind

required

string

Allowed values: Receipt

object

object

InputOrdinal

integer format: int32

nullable

CallerCorrelation

string

nullable

Code

required

string

Field

string

nullable

Kind

required

string

Allowed values: Failure

Kind

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": {
    "Items": [
      {
        "Kind": "AuthorizedEntityIdentity"
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}