Skip to content

Job failure reasons

Preview

This feature is not subject to our service terms. Pre-GA features are available as is and might have limited support.

The job's reason property identifies why a job did not terminate successfully; that is, why the job's status is any terminal status other than "completed".

The following list describes the possible values in the reason.reasonType property and their meanings:

  • "JobRejectReason": The job did not pass the request validation and has been "rejected".
  • "JobCancelByUserReason": The job was explicitly "canceled" by your application. Note that this feature is available only to certain integrations or select repositories.
  • "JobCancelByModigieReason": The job was explicitly "canceled" by Modigie. This may occur as part of an individual support ticket or incident response.
  • "JobCancelReason": The job was explicitly "canceled" with unspecified details.
  • "JobExpireReason": The job was automatically "canceled" because processing did not start within the duration defined by modigieJobExpireAfter. Note that this feature is available to certain subscriptions only.
  • "JobFailReason": The processing of the job in the real-time engine "failed" with unspecified details.
  • "JobDeadlineExceededReason": The processing of the job in the real-time engine took too much time or "failed" for other temporary technical reasons.
  • "JobPipelineEvictedReason": When a repository's pipeline is shut down at the end of your subscription, any jobs still in the pipeline are evicted; that is, they are "canceled". This ensures your application is notified and can handle their cancellation gracefully.

The reason.body or reason.message properties may contain additional details.

reason is a read-only property.

Example

Note

reason is a read-only property.

The following is an example of an Enrich Mobile & Verify Employment job where processing exceeded the deadline. Your application can programmatically interrogate the job's reason.reasonType property. All other properties can provide details to you or your users.

job-response.json
{
  "status": "failed",
  "reason": {
    "body": "Job processing exceeded the allowed time and was terminated. No charge applied. You can resubmit your request with the same parameters and a new request ID.",
    "code": 204,
    "level": "success",
    "message": "Job processing timeout: Job processing exceeded the allowed time and was terminated. No charge applied. You can resubmit your request with the same parameters and a new request ID.",
    "reasonType": "JobDeadlineExceededReason",
    "subtitle": "Success",
    "title": "Job processing timeout"
  },
  ...
}

Schema: JobV2Reason