Bulk Data Export Status API

Returns the status of the export job and its completion percentage for the given job ID.

Endpoint

URL: https://<<hostname>>/export/uzng/v1/convdata/status/<<jobId>>

Method: GET

curl --location 'https://<<hostname>>/export/uzng/v1/convdata/status/6872fb2c-a4b9-b2d0ef87e897' \
     --header 'Authorization: 'iGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IkxYejBQYWVFRERuS3dfcjdkU2s2UyJ9.eyJodHRwczovL2FwaS51bmlwaG9yZS5jb20vcm9sZXMiOlsiYWRtaW4iLCJzdXBlcmFkbWluIiwiU3VwZXIgQWRtaW5pc3RyYXRvciJdLCJodHRwczovL2FwaS51bmlwaG9yZS5jb20vdGVuYW50IjoiMTViYjEwN2UtMGM1Yi00NGJlLTg0ZTEtNWYyNzYxMTE1ODNhIiwiaHR0cHM6Ly9hcGkudW5pcGhvcmUuY29tL29yZ19pZCI6Im9yZ19FQlVLRmVlWHFvbXdpYU8xIiwiaXNzIjoiaHR0cHM6Ly9kZXYtZzJqNW11MnoudXMuYXV0aDAuY29tLyIsInN1YiI6InRKYXZQUlcyYWlNcVBYdlluNXhVM3VuNGh4QjhVTlVSQGNsaWVudHMiLCJhdWQiOiJhcGkudW5pcGhvcmUuY29tIiwiaWF0IjoxNzQyODg0NjEwLCJleHAiOjE3NDI5NzEwMTAsInNjb3BlIjoicmVhZDp0ZW5hbnRzIHJlYWQ6dXNlcnMgd3JpdGU6dXNlcnMiLCJndHkiOiJjbGllbnQtY3JlZGVudGlhbHMiLCJhenAiOiJ0SmF2UFJXMmFpTXFQWHZZbjV4VTN1bjRoeEI4VU5VUiIsInBlcm1pc3Npb25zIjpbInJlYWQ6dGVuYW50cyIsInJlYWQ6dXNlcnMiLCJ3cml0ZTp1c2VycyJdfQ.LMqT5NxVM8OAKlCW_4bGJFYzq4_CIfmuwDHgraMUSU4vFrS4rx8xz7JiRxfh15CZ7ekSDzkJdSFgFIN4Q4sEG5l2NhtI7GErzcPruhMxBOEH0ykXXy6qlkgYezniDS49qlFjBkrzSr7LCK9NQyWF7w1HJiVgQBhOOJsh5sncNIqjCeJintGk1G5H9AMQV_oNWstTsvk5hJtznc7Rq5t5N_VKJhUtcysL13LIO-8oyGE2Zkhb53IrQYLh6rapBOlNBHd7G6G6M4dA7apSC9HWocyH74EVQqYtYgsvBgyJnmUMDcPmQzIbAco'

Header Parameter

Authorization - Bearer <Token>

Note

To obtain an authorization token, click here.

Path Parameter

Parameter Name	Datatype	Description	Required/ Optional
jobId	Number	Enter the job ID to fetch its export status. To obtain the jobId, refer Bulk Data Export API.	Required

Parameter Name

Datatype

Description

Required/ Optional

jobId

Number

Enter the job ID to fetch its export status.

To obtain the jobId, refer Bulk Data Export API.

Required

Sample Response

{
    "code": 200,
    "message": "EXPORT_STATUS_COMPLETED",
    "data": {
        "status": "EXPORT_STATUS_COMPLETED"
        "completionPercentage": 100
            }
}

Response Parameter

Parameter Name	Datatype	Description
status	String	Shows the export status for the given job ID. The status can be: EXPORT_STATUS_ACCEPTED: Shows when the export job request is executed. EXPORT_STATUS_IN_PROGRESS: Shows when the export job is initiated in the background. EXPORT_STATUS_COMPLETED: Indicates when the entire data export is complete. EXPORT_STATUS_FAILED: Indicates when data cannot be exported.
completionPercentage	Number	Shows the percentage of completion for the export job.

Response and Error Codes

Response Code	Condition	Message	Description
200	OK	Importing users in progress.	The user information has been validated and moved to the S3 bucket. The schedulers are updating the users in batches.
404	Page Not Found	Export job not found for job ID: <jobId>, tenant ID: <tenantId>	Ensure the correct Job ID and Tenant ID are provided.

In this section:

Uniphore Help Center Portal