Get a job's status

GET

/content/management/v1/operations/{id}

const url = 'https://api.ebitex.io/content/management/v1/operations/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.ebitex.io/content/management/v1/operations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Reports a background job started by POST /publish-plan or POST /publish, by the id the start call returned. status moves from queued to running and ends at succeeded or failed.

Poll until it finishes. A succeeded job’s result holds its output: the plan, or the list of published items. A failed job’s error says why, and result may still list work completed before the failure. Only jobs in the key’s own environment can be read.

Key: a management key with content.management.read.

Authorizations

apiKey

Parameters

Path Parameters

required

string format: uuid

Responses

200

{ "id", "kind": "publish-plan" | "publish-execute", "status", "result", "error" }

401

missing_api_key or invalid_api_key: no key was sent, or it is unknown, revoked or expired.

402

payment_required: the organization’s subscription needs attention.

403

scope_denied: the key lacks this route’s scope. tier_required: the Content Management API needs the Pro plan or above. ip_denied: the caller’s address is outside the key’s allowed ranges. app_not_available: Content is not enabled for the organization.

404

operation_not_found: no job with this id exists in the key’s environment.

429

Rate limit or quota exceeded; Retry-After says how long to wait. too_many_failed_authentications: too many bad keys from this address.