Skip to main content
MindTouch Success Center

GET:site/jobs/{id}

Applies to:
MindTouch (current)
Role required:
Admin

Response

Job

<job id="{id}" type="{type}" status="{status}">
    <submitted>{submitted}</submitted>
    <lastmodified>{lastmodified}</lastmodified>
    <data>{data}</data>
    
    <!-- optionally available when job resource is the result of a job submission -->
    {user}
</job>
Name Type Description
{id} string The unique id for this job in UUID v4 format
{type} {export, import, import_test} The type of job
{status} {submitted, in_progress, completed, failed, cancelled} The status of the job
{submitted} datetime ISO 8601 representation for the job submission event timestamp
{lastmodified} datetime ISO 8601 representation for the last time the job status was updated timestamp
{data} xml Structured data (presently not documented in API specification)
{user} (optional) User The user who submitted the job

 Job Types

Job Type Description
export A content export job
import A content import job
import_test A dry run content import job that will only process import manifest and content for warnings and errors, not create or update content

Job Statuses

Job Status Description
submitted Job is in the queue and is not in progress. While the time to begin the job cannot be accurately predicted, under normal system operation we expect the job to begin in under five (5) minutes
in_progress Job is in progress. Once in progress, an export type job can be cancelled, however an import or import_test type job cannot be cancelled
completed Job is complete and system sends notification and optional logs to the configured email address or webhook
failed Job has failed and system sends notification and error logs to the configured email address or webhook
cancelled Job has been cancelled and system sends notification and optional logs to the configured email address or webhook
  • Was this article helpful?