Adobe Captivate · JSON Structure

Prime Api Job Response Structure

Single job response

Type: object Properties: 1

AuthoringEducationeLearningLMSSCORMTrainingxAPI

JobResponse is a JSON Structure definition published by Adobe Captivate, describing 1 property. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

data

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adobe-captivate/refs/heads/main/json-structure/prime-api-job-response-structure.json",
  "name": "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": "datetime",
              "description": "Timestamp when the job was created"
            },
            "dateCompleted": {
              "type": "datetime",
              "description": "Timestamp when the job completed"
            },
            "description": {
              "type": "string",
              "description": "Job description"
            },
            "downloadUrl": {
              "type": "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"
              ]
            }
          }
        }
      }
    }
  }
}