Adobe Captivate · Schema

Job

A bulk import/export job

AuthoringEducationeLearningLMSSCORMTrainingxAPI

Properties

Name Type Description
id string Unique job identifier
type string
attributes object
View JSON Schema on GitHub

JSON Schema

prime-api-job-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-schema.json",
  "title": "Job",
  "description": "A bulk import/export job",
  "type": "object",
  "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"
          ]
        }
      }
    }
  }
}