Get Job Status

Get Import Job Status

Overview

This API provides real-time status information for content import and validation operations. Use this endpoint to monitor job progress, check completion status, and access detailed logs and error information.

Status Values

  • Scheduled: Job is queued and waiting for scheduled execution time
  • In Progress: Job is actively processing content
  • Completed: Job finished successfully
  • Failed: Job encountered errors and could not complete
  • Cancelled: Job was manually cancelled by user

Response Information

  • Current Status: Real-time job status
  • Progress Metrics: Items processed, total items, completion percentage
  • Log Files: Location of detailed operation logs
  • Error Details: Specific errors encountered during processing
  • Timing Information: Start time, estimated completion, actual completion

Log File Access

Log files contain detailed information about:

  • Content processing steps
  • Validation results
  • Error details with context

Permissions

Actor Permission
User
  • User must be a department user.
  • User must have 'Author' role.
  • The job must have been created by the logged in user, or the logged in user must have 'View' permissions on the user who created the job.
SecurityoAuthUser
Request
path Parameters
job_id
required
string^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3...

Job ID Parameter

The unique identifier for the import or validation job. This ID was returned when the job was created via the Import or Validate API.

Format: UUID v4 (e.g., 7A84B875-6F75-4C7B-B137-0632B62DB0BD)

Example Usage:

GET /import/content/7A84B875-6F75-4C7B-B137-0632B62DB0BD/status
Example: 7A84B875-6F75-4C7B-B137-0632B62DB0BD
Responses
200

Job Status Retrieved Successfully

The current status and progress information for the specified import or validation job.

Response Details:

  • Status: Current job state (Scheduled, In Progress, Completed, etc.)
  • Job Type: Current job's type (Import or Validation)
  • Progress: Number of items processed vs. total items
  • Logs: Location of detailed operation logs
  • Timing: Start time and estimated completion
  • Errors: Any validation or processing errors encountered
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Not acceptable

500

Internal server error

get/import/content/{job_id}/status
Request samples
Response samples
application/json
Shows an import job that is currently processing content


{
  • "status": "In Progress",
  • "jobType": "Import",
  • "progress": {
    },
  • "logFileLocation": "s3://mybucket/logs/import-logs-7A84B875-6F75-4C7B-B137-0632B62DB0BD.txt",
  • "startTime": "2024-03-01T10:00:00.000Z",
  • "estimatedCompletion": "2024-03-01T11:30:00.000Z",
  • "currentOperation": "Processing content items"
}