Adobe Captivate · JSON Structure

Prime Api Job Create Request Structure

Request body for creating a bulk job

Type: object Properties: 1 Required: 1
AuthoringEducationeLearningLMSSCORMTrainingxAPI

JobCreateRequest is a JSON Structure definition published by Adobe Captivate, describing 1 property, of which 1 is required. 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

Raw ↑ 
{
  "$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-create-request-structure.json",
  "name": "JobCreateRequest",
  "description": "Request body for creating a bulk job",
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "type",
        "attributes"
      ],
      "properties": {
        "type": {
          "type": "string",
          "const": "job"
        },
        "attributes": {
          "type": "object",
          "required": [
            "jobType"
          ],
          "properties": {
            "jobType": {
              "type": "string",
              "description": "The type of bulk operation",
              "enum": [
                "userImport",
                "learnerTranscriptExport",
                "trainingReportExport"
              ]
            },
            "description": {
              "type": "string",
              "description": "Description for this job"
            }
          }
        }
      }
    }
  }
}