API reference / Pipelines

Pipelines

Multi-step pipeline execution records.

GET /api/v1/pipelines/

List pipeline executions across all assets.

Parameters

NameInTypeRequired
statusquerystring (running, done, failed)optional
limitqueryintegeroptional
offsetqueryintegeroptional

Response

Response 200 (application/json)
{
  "items": [
    {
      "id": "string",
      "assetId": "string",
      "pipelineName": "string",
      "status": "running",
      "steps": [
        {
          "name": null,
          "status": null,
          "jobId": null,
          "encoreJobId": null,
          "error": null,
          "startedAt": null,
          "completedAt": null,
          "progress": null
        }
      ],
      "createdAt": "string",
      "updatedAt": "string",
      "assetName": "string"
    }
  ],
  "total": 0
}

GET /api/v1/pipelines/{executionId}

Get a pipeline execution.

Parameters

NameInTypeRequired
executionIdpathstringrequired

Response

Response 200 (application/json)
{
  "id": "string",
  "assetId": "string",
  "pipelineName": "string",
  "status": "running",
  "steps": [
    {
      "name": "extract-metadata",
      "status": "pending",
      "jobId": "string",
      "encoreJobId": "string",
      "error": "string",
      "startedAt": "string",
      "completedAt": "string",
      "progress": 0
    }
  ],
  "createdAt": "string",
  "updatedAt": "string",
  "assetName": "string"
}

DELETE /api/v1/pipelines/{executionId}

Delete a pipeline execution record.

Parameters

NameInTypeRequired
executionIdpathstringrequired

Response

Response 200 (application/json)
{
  "id": "string",
  "assetId": "string",
  "pipelineName": "string",
  "status": "running",
  "steps": [
    {
      "name": "extract-metadata",
      "status": "pending",
      "jobId": "string",
      "encoreJobId": "string",
      "error": "string",
      "startedAt": "string",
      "completedAt": "string",
      "progress": 0
    }
  ],
  "createdAt": "string",
  "updatedAt": "string",
  "assetName": "string"
}