Skip to main content

Get export job status

GET 

/sp-config/export/:id

experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

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

  • sp:config:read - sp:config:manage

Request

Path Parameters

    id stringrequired

    The ID of the export job whose status will be returned.

    Example: ef38f94347e94562b5bb8424a56397d8

Header Parameters

    X-SailPoint-Experimental stringrequired

    Default value: true

    Use this header to enable this experimental API.

    Example: true

Responses

Export job status successfully returned.

Schema

    jobId stringrequired

    Unique id assigned to this job.

    status stringrequired

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

    Status of the job.

    type stringrequired

    Possible values: [EXPORT, IMPORT]

    Type of the job, either export or import.

    expiration date-timerequired

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

    created date-timerequired

    The time the job was started.

    modified date-timerequired

    The time of the last update to the job.

    description string

    Optional user defined description/name for export job.

    completed date-time

    The time the job was completed.

Loading...