API & development

Migration inventory and mapping data fields

Exact JSON field names and types, with public-request versus protected-state boundaries.

Platform: Go
Technology: Go

How to use these fields

This release-matched technical reference indexes the JSON-visible fields in the reviewed typed models. Start with the operational guide and API conventions. A model is not a public mutation schema: request structs, response records, protected plans and internal receipts serve different purposes. Submit only the fields supported by the exact endpoint/client; unknown fields are rejected. Internal sequence, signature, receipt, owner and generation values cannot be edited to grant authority. Optional means a Go JSON field can be omitted when empty; it does not waive an endpoint prerequisite. Values containing credentials/secrets must use the protected write-only form, never logs, query strings or support screenshots. Current account ownership, grants, feature/licence state and capability still apply.

Preview

JSON field	Type	Presence
`id`	`string`	Encoded by this model
`review`	`migration.Preview`	Encoded by this model
`source`	`migration.Source`	Encoded by this model
`status`	`string`	Encoded by this model
`action`	`string`	Encoded by this model
`original_operation_id`	`string`	Optional when empty
`expires_at`	`time.Time`	Encoded by this model

SubmitRequest

JSON field	Type	Presence
`api_version`	`int`	Encoded by this model
`preview_id`	`string`	Encoded by this model
`confirmation`	`string`	Encoded by this model

Submission

JSON field	Type	Presence
`operation_id`	`string`	Encoded by this model
`replayed`	`bool`	Encoded by this model

Record

JSON field	Type	Presence
`operation_id`	`string`	Encoded by this model
`account_id`	`string`	Encoded by this model
`source_id`	`string`	Encoded by this model
`status`	`string`	Encoded by this model
`plan`	`migration.Plan`	Encoded by this model
`source`	`migration.Source`	Encoded by this model
`result`	`json.RawMessage`	Encoded by this model
`created_at`	`time.Time`	Encoded by this model
`completed_at`	`*time.Time`	Encoded by this model
`fully_migrated`	`bool`	Encoded by this model
`publicly_ready`	`bool`	Encoded by this model
`action`	`string`	Encoded by this model
`original_operation_id`	`string`	Optional when empty

Capability

JSON field	Type	Presence
`component`	`string`	Encoded by this model
`status`	`string`	Encoded by this model
`code`	`string`	Optional when empty

Source

JSON field	Type	Presence
`version`	`int`	Encoded by this model
`source_id`	`string`	Encoded by this model
`target_account_id`	`string`	Encoded by this model
`scan_digest`	`string`	Encoded by this model
`registered_at`	`time.Time`	Encoded by this model
`status`	`string`	Encoded by this model
`inventory`	`migrationarchive.Inventory`	Encoded by this model
`capabilities`	`[]Capability`	Encoded by this model

PreviewRequest

JSON field	Type	Presence
`version`	`int`	Encoded by this model
`source_id`	`string`	Encoded by this model
`target_account_id`	`string`	Encoded by this model
`scan_digest`	`string`	Encoded by this model
`components`	`[]string`	Encoded by this model
`website_id`	`string`	Optional when empty
`mailbox_mappings`	`[]MailboxMapping`	Optional when empty
`database_mappings`	`[]DatabaseMapping`	Optional when empty

DatabaseMapping

JSON field	Type	Presence
`source_database_ref`	`string`	Encoded by this model
`database_id`	`string`	Encoded by this model

MailboxMapping

JSON field	Type	Presence
`source_mailbox_ref`	`string`	Encoded by this model
`mailbox_id`	`string`	Encoded by this model

Target

JSON field	Type	Presence
`kind`	`string`	Encoded by this model
`resource_id`	`string`	Encoded by this model
`source_ref`	`string`	Optional when empty
`revision`	`uint64`	Encoded by this model
`identity_sha256`	`string`	Encoded by this model
`sha256`	`string`	Encoded by this model
`files`	`uint64`	Encoded by this model
`bytes`	`uint64`	Encoded by this model

Plan

JSON field	Type	Presence
`version`	`int`	Encoded by this model
`source_id`	`string`	Encoded by this model
`target_account_id`	`string`	Encoded by this model
`scan_digest`	`string`	Encoded by this model
`archive_sha256`	`string`	Encoded by this model
`target_revision`	`uint64`	Encoded by this model
`target_identity_sha256`	`string`	Encoded by this model
`target_sha256`	`string`	Encoded by this model
`components`	`[]string`	Encoded by this model
`website_id`	`string`	Optional when empty
`mailbox_mappings`	`[]MailboxMapping`	Optional when empty
`database_mappings`	`[]DatabaseMapping`	Optional when empty
`targets`	`[]Target`	Encoded by this model
`files`	`uint64`	Encoded by this model
`bytes`	`uint64`	Encoded by this model
`expires_at`	`time.Time`	Encoded by this model

Preview

JSON field	Type	Presence
`version`	`int`	Encoded by this model
`plan`	`Plan`	Encoded by this model
`digest`	`string`	Encoded by this model
`confirmation`	`string`	Encoded by this model
`destination`	`string`	Encoded by this model
`impact`	`[]string`	Encoded by this model
`requirements`	`[]string`	Encoded by this model

Result

JSON field	Type	Presence
`version`	`int`	Encoded by this model
`operation_id`	`string`	Encoded by this model
`source_id`	`string`	Encoded by this model
`target_account_id`	`string`	Encoded by this model
`phase`	`string`	Encoded by this model
`files`	`uint64`	Encoded by this model
`bytes`	`uint64`	Encoded by this model
`sha256`	`string`	Optional when empty
`destination`	`string`	Optional when empty
`publicly_ready`	`bool`	Encoded by this model
`database_tables`	`uint64`	Encoded by this model
`database_rows`	`uint64`	Encoded by this model

Verify the actual endpoint

Read a harmless authorized resource and validate the returned API/model version before automation. For a write, use current revision or ETag, the endpoint-specific secret/preview contract and a stable reviewed idempotency key. Follow the durable task to its final state and inspect service evidence. Missing/unqualified native behavior remains a release limitation; a field name does not prove a live service or complete recovery.

← All EmailaPanel guides Get help →

Need help with EmailaPanel?

Tell us the product version and what you are trying to do. Keep passwords and private keys out of your message.

Contact Emaila