Adobe Captivate · Schema

JobResponse

Single job response

AuthoringEducationeLearningLMSSCORMTrainingxAPI

Properties

Name Type Description
data object A bulk import/export job
View JSON Schema on GitHub

JSON Schema

prime-api-job-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adobe-captivate/refs/heads/main/json-schema/prime-api-job-response-schema.json",
  "title": "JobResponse",
  "description": "Single job response",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "description": "A bulk import/export job",
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique job identifier"
        },
        "type": {
          "type": "string",
          "const": "job"
        },
        "attributes": {
          "type": "object",
          "properties": {
            "dateCreated": {
              "type": "string",
              "format": "date-time",
              "description": "Timestamp when the job was created"
            },
            "dateCompleted": {
              "type": "string",
              "format": "date-time",
              "description": "Timestamp when the job completed"
            },
            "description": {
              "type": "string",
              "description": "Job description"
            },
            "downloadUrl": {
              "type": "string",
              "format": "uri",
              "description": "URL to download the job result file (for export jobs)"
            },
            "jobType": {
              "type": "string",
              "description": "The type of bulk operation",
              "enum": [
                "userImport",
                "learnerTranscriptExport",
                "trainingReportExport"
              ]
            },
            "status": {
              "type": "string",
              "description": "Current job status",
              "enum": [
                "Submitted",
                "InProgress",
                "Completed",
                "Failed"
              ]
            }
          }
        }
      }
    }
  }
}