Read Channel publication run

GET

/v1/object-types/hospitality.channel_publication_run/objects/{id}

const url = 'https://api.aerandil.com/v1/object-types/hospitality.channel_publication_run/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.aerandil.com/v1/object-types/hospitality.channel_publication_run/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Read an existing instance.

One audited ARI push at a conduit: what triggered it, when it ran, how many date-cells it published across availability, rates and restrictions, and how many the partner refused. Run-grain only — per-cell state stays in the publication outbox in Postgres. partial is a first-class outcome: a run that published four hundred cells and had eleven refused for an unmapped rate plan neither succeeded nor failed, and flattening it to either loses the only signal that mapping is broken.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.channel_publication_run:read

Parameters

Path Parameters

required

string format: uuid

Object id (UUID v7, server-generated at create time).

Query Parameters

branch

string format: uuid

Read through an open branch’s copy-on-first-write overlay view instead of the canonical (main) plane. Does not compose with as_of (422). The branch must exist under the caller’s tenant.

Responses

200

Object found.

application/json

object

created_at

required

string format: date-time

required

string format: uuid

object_type

required

Allowed value: hospitality.channel_publication_run

properties

required

object

cells_published

Date-cells successfully published across all facets

integer

cells_rejected

Date-cells the partner refused

integer

error_summary

Why the run failed or was partial (required for those outcomes)

string

finished_at

When the run reached a terminal status

string format: date-time

required

Publication run id

string

messages_sent

Wire messages sent (bundling collapses many cells into one)

integer

started_at

required

When the run started

string format: date-time

status

required

Publication-run lifecycle status

string

Allowed values: running succeeded partial failed cancelled

trigger

required

What initiated this run

string

Allowed values: delta full recovery manual

window_end

Last business date covered by this run

string format: date

window_start

First business date covered by this run

string format: date

provenance

Per-property source attribution and pins. An entry under properties means the property’s current value came from that source (on the source’s own clock, source_updated_at); an entry under pins is a human override protecting the property from sourced writes.

object

pins

object

key

additional properties

object

pinned_at

string format: date-time

pinned_by

object

reason

required

string

properties

object

key

additional properties

object

external_id

string

recorded_at

required

string format: date-time

source

required

string

source_updated_at

string format: date-time

stream

string

scope

required

One of: discriminator: level

object

level

required

string

Allowed value: tenant

Allowed values: tenant

tenant_id

required

string format: uuid

updated_at

required

string format: date-time

version

required

integer

>= 1

Example

{
  "object_type": "hospitality.channel_publication_run",
  "properties": {
    "status": "running",
    "trigger": "delta"
  },
  "scope": {
    "level": "tenant"
  }
}

Headers

ETag

string

/^"\d+"$/

Quoted strong validator (RFC 7232 §2.3) carrying the object’s monotonic version. Informational on the read path — object mutation goes through typed actions on /v1/actions/{action}/apply, not raw CRUD.

404

No object with that id (or soft-deleted).