Skip to content

Message Popups Data Model

This page maps the stored entities and response shapes that the message popup family works with.

Core entities

Model Purpose Important fields
cpiMessageLog main message row messageguid, correlationid, flow, status, customstatus, time_started, time_completed, payloads_count, runs_count, customheaders_count, error_value, duration_human, link
cpiMessageLogRuns individual run records runid, runstart, runstop, overallstate, processid, runsteps, runstepsdetails
cpiCustomHeaderProperties normalized custom headers name, value, messagelog, config
cpiPayload payload metadata and downloaded body payloadid, status, type, createdat, retainuntil, raw_data, body, headers, download_error
cpiMessageAttachment attachment cache and metadata position, data, cache_ready, cache_content_type, cache_size, cache_text, cache_content_b64
cpiMessageCorrelation correlation aggregate correlationid, ncount

Main list row shape

The list endpoint returns a compact projection optimized for table rendering, for example:

Field Meaning
messageguid stable message identity inside one tenant
iflow_name / flow__name runtime or linked artifact name
integrationartifact artifact identifier
status CPI processing state
customstatus additional runtime status
payloads_count number of related payload rows
runs_count number of known run rows
correlation_ncount number of correlated messages
duration / duration_human numeric and human-readable duration
error_value condensed error text
customheaderproperties_list header preview or masked projection

Detail payload shape

The message detail endpoint enriches the main row with:

  • restricted_resources
  • correlated_messages
  • correlation_ncount
  • header_properties
  • run_list
  • attachments

Run list entries

Typical run-list fields:

  • runid
  • runstart
  • runstop
  • overallstate
  • processid
  • runsteps_count
  • runstepsdetails_preview

Attachment entries

Typical attachment fields:

  • id
  • position
  • name
  • mime
  • size
  • modified_at
  • media_src
  • cache_ready
  • cache_content_type
  • cache_size
  • cache_updated_at

Payload response shape

When payload access is allowed, payloads_by_message returns metadata rows. When restricted, it returns a reduced masked shape:

Field Visible when allowed Visible when masked
id yes yes
payloadid yes yes
status yes yes
datastorename yes yes
createdat yes yes
dueat yes yes
retainuntil yes yes
body or raw content downloadable through payload endpoint blocked
masked false true

Typical enum-like values

Examples observed in code and defaults:

  • message status filters such as FAILED, RETRY, COMPLETED, CUSTOM_ALL
  • alert-facing message status defaults such as failed
  • restricted resources such as payloads and custom_headers

Diagnostic reading order

  1. message row
  2. detail payload
  3. runs
  4. attachments and payload metadata
  5. related alert state in Alerting