Sign in
processes

Get a process in Pipeline

Get a process in Pipeline

get/api/v1/orgs/{orgId}/processes/{id}

Path parameters

orgIdinteger required

Organization identifier

idstring required

Process id

Response

The process

idstring
parentIdstring
orgIdinteger
typestring
logstring
resourceIdstring
resourceTypestring
status'running' | 'failed' | 'finished' | 'canceled'
startedAtstring date-time
finishedAtstring date-time nullable

Example response

{
  "resourceId": "resourceId",
  "log": "log",
  "startedAt": "2000-01-23T04:56:07.000+00:00",
  "id": "id",
  "type": "type",
  "parentId": "parentId",
  "orgId": 0,
  "events": [
    {
      "processId": "processId",
      "log": "log",
      "id": 6,
      "type": "type",
      "status": null,
      "timestamp": "2000-01-23T04:56:07.000+00:00"
    },
    {
      "processId": "processId",
      "log": "log",
      "id": 6,
      "type": "type",
      "status": null,
      "timestamp": "2000-01-23T04:56:07.000+00:00"
    }
  ],
  "resourceType": "resourceType",
  "status": null,
  "finishedAt": "2000-01-23T04:56:07.000+00:00"
}

Changes

Changed in 2 of the 50 revisions of this API.11

  • 7c409f3ff1a91See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 5186ea64aa561See the full diff
    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    This revision also has 35 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog