younifyd
Menu

Cancel Job

Cancel a Job

POST/pcm/jobs/{jobID}/cancel

Use it in a workflow

  1. Add a step and choose the Elastic Path connector.
  2. Pick the Cancel Job action (under PIM).
  3. Fill in the fields below, then reference the result from later steps as {{cancelJob.response.data}}.

Request

Path parameters

jobIDstringrequired

A unique identifier for the job.

Response

Returns 200 with an object. Read it in later steps with {{cancelJob.response.data.<field>}}.

dataobject
idstringrequired

A unique identifier generated when a job is created.

typestringrequired

This represents the type of resource object being returned. Always `pim-job`.

One ofpim-job

attributesobjectrequired6 fields
metaobjectrequired5 fields
json
{
  "data": {
    "id": "string",
    "type": "pim-job",
    "attributes": {
      "started_at": "2020-09-22T09:00:00.000Z",
      "completed_at": "2020-09-22T09:00:00.000Z",
      "created_at": "2020-09-22T09:00:00.000Z",
      "updated_at": "2020-09-22T09:00:00.000Z",
      "type": "child-products",
      "status": "pending"
    },
    "meta": {
      "x_request_id": "string",
      "copied_from": "string",
      "hierarchy_id": "string",
      "file_locations": [
        "string"
      ],
      "filter": "string"
    }
  }
}

Need more? See the Elastic Path guide for connection setup and behaviour shared by every action.