Create a run (rebuild a version, or a single scoped unit)

Starts a run for this package's version identified by versionId. By default (no scope selectors) it is a full run that re-materializes every persist source in the version and rebuilds every indexed dimension it defines — one run driving both unit families through the same two-phase build (tables first, then indexes). It is the on-demand equivalent of the run a publish triggers.

POST/organizations/{organizationName}/environments/{environmentName}/packages/{packageName}/runs

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

organizationName*string

The unique identifier of the organization

Match^[a-zA-Z0-9_ -]+$

environmentName*string

The unique identifier of the environment

Match^[a-zA-Z0-9_ -]+$

packageName*string

The unique identifier of the package

Match^[a-zA-Z0-9_ -]+$

Request Body

application/json

Request a run for a version. By default (no scope selectors) this is a full run: re-materialize every persist source in the version and rebuild every indexed dimension it defines, in one run. The optional sourceName / dimension / modelFilePath selectors narrow the run to a single unit (Phase C per-unit dispatch); a null selector widens to the whole version, so the whole-version full run stays the default.

versionId*string

The version to (re)build. With no scope selectors the run re-materializes all of the version's persist sources and rebuilds all of the dimensions they define. A version that predates the content-addressed index model is discovered and migrated into it as part of the same run.

sourceName?string

Optional. Restrict the run to a single persist source's table (Phase C per-source dispatch). The named source is force-rebuilt (a fresh generation at the same content address); its persist upstreams are referenced from their existing materialized tables, not rebuilt (unless includeUpstream is set). Null widens to every persist source in the version.

includeUpstream?boolean

Optional. Only meaningful when the target resolves to a source (sourceName set — for a source rerun, or an index rerun that also names its source). When true, the run also force-rebuilds the target's transitive upstream persisted sources (its full derivation closure), so the whole lineage feeding the target is refreshed rather than referenced from existing tables:

source target: rebuild the source and every persisted source it derives from.
index target (dimension set): rebuild the source table the index reads from and its upstream closure, then re-index. When false (default): a source target rebuilds only that source (its upstreams reused); an index target reuses the source table and only re-indexes. Ignored for a full run or a dimension target that names no source.

Defaultfalse

dimension?string

Optional. Restrict the run to a single indexed dimension's index. Combined with sourceName it targets that dimension on that source; alone it targets the dimension across the sources that define it (disambiguated by modelFilePath when set). Null widens to every indexed dimension in scope.

modelFilePath?string

Optional. Disambiguates a dimension defined in more than one model file. Null widens to every model file defining the matched dimension.

Response Body

`application/json`

curl --request POST \  --url 'https://example.com/organizations/string/environments/string/packages/string/runs' \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{  "versionId": "string"}'

{  "id": "string",  "buildNumber": 0,  "trigger": "PUBLISH",  "status": "BUILDING",  "targetSourceName": "string",  "targetDimension": "string",  "targetModelFilePath": "string",  "targetIncludeUpstream": true,  "triggeringVersionId": "string",  "buildPlan": {    "sourceCount": 0,    "builtSources": [      "string"    ],    "reusedSources": [      "string"    ],    "unsupportedSources": [      "string"    ],    "failedSources": {      "property1": "string",      "property2": "string"    },    "dimensionCount": 0,    "builtDimensions": [      "string"    ],    "failedDimensions": {      "property1": "string",      "property2": "string"    },    "nodes": [      {        "key": "string",        "id": "string",        "nodeType": "SOURCE",        "sourceName": "string",        "status": "PENDING",        "materialized": true,        "tableName": "string",        "modelFilePath": "string",        "dimension": "string",        "rowCount": 0,        "lastIndexedAt": "2019-08-24T14:15:22Z",        "error": "string",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z"      }    ],    "edges": [      {        "from": "string",        "to": "string"      }    ]  },  "startedAt": "2019-08-24T14:15:22Z",  "completedAt": "2019-08-24T14:15:22Z",  "error": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Create a run (rebuild a version, or a single scoped unit)

Authorization

Path Parameters

Request Body

Response Body

202application/json

400application/json

401application/json

403application/json

404application/json

409application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`