Skip to content

restore_record

Restore a deleted record, under its original id, from its record delete audit event.

Find the event with list_audit_events: a row whose restorable is record. The result names the restored record, the snapshot fields no longer in the published schema (droppedFields) and the records whose credentials must be set again (credentialsResetRequired). A record deleted with its model is restored by restore_model instead.

{
"properties": {
"application_id": {
"title": "Application Id",
"type": "string"
},
"event_id": {
"title": "Event Id",
"type": "string"
},
"idempotency_key": {
"title": "Idempotency Key",
"type": "string"
}
},
"required": [
"application_id",
"event_id",
"idempotency_key"
],
"title": "restore_recordArguments",
"type": "object"
}
{
"description": "What restoring one record delete event did.",
"properties": {
"credentialsResetRequired": {
"items": {
"format": "uuid",
"type": "string"
},
"title": "Credentialsresetrequired",
"type": "array"
},
"droppedFields": {
"items": {
"type": "string"
},
"title": "Droppedfields",
"type": "array"
},
"eventId": {
"format": "uuid",
"title": "Eventid",
"type": "string"
},
"record": {
"description": "The restored record, redacted as a create returns it.",
"properties": {
"applicationId": {
"format": "uuid",
"title": "Applicationid",
"type": "string"
},
"data": {
"additionalProperties": true,
"title": "Data",
"type": "object"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"modelId": {
"format": "uuid",
"title": "Modelid",
"type": "string"
}
},
"required": [
"id",
"modelId",
"applicationId",
"data"
],
"title": "RestoredRecord",
"type": "object"
},
"status": {
"const": "restored",
"title": "Status",
"type": "string"
}
},
"required": [
"eventId",
"status",
"record",
"droppedFields",
"credentialsResetRequired"
],
"title": "RestoreRecordResult",
"type": "object"
}