Skip to main content

Get Status of Export Job

This gets the status of the export job identified by the id parameter. Request will need one of the following security scopes:

  • sp:config:read - sp:config:manage
Path Parameters
  • id string required

    The ID of the export job for which status will be returned.

    Example: ef38f94347e94562b5bb8424a56397d8
Responses

Export job status successfully returned.


Schema
  • jobId string

    Unique id assigned to this job.

  • status string

    Possible values: [NOT_STARTED, IN_PROGRESS, COMPLETE, CANCELLED, FAILED]

    Status of the job.

  • type string

    Possible values: [EXPORT, IMPORT]

    Type of the job, either export or import.

  • message string

    This message contains additional information about the overall status of the job.

  • description string

    Optional user defined description/name for export job.

  • expiration date-time

    The time until which the artifacts will be available for download.

  • created date-time

    The time the job was started.

  • modified date-time

    The time of the last update to the job.

  • completed date-time

    The time the job was completed.

Loading...