GET status

Retrieves status and other information for submitted exporter wrapper jobs.

API Specification: Get Status for single job

Description Get status and additional information about submitted exporter task matching the supplied jobId
Authentication Required yes
URL https://<domain or IP>/SMARTSync/services/rs/exporters/v1/status/{jobId}
Method GET
Request
Headers 		Cookie: JSESSIONID={jsessionId}
Content-Type: application/json

Response
Headers

Content-Type: application/json

Success
Response

Code: 200 OK
Content : [Response Data]

Error
Response

Code: 401 Unauthorized

Error message:

{

"message": "Unauthorized",

"status": 401

}

 

Code: 404 Not Found

Error message:

{

"message": "Job id is not found",

"status": 401

}

Response Data

Response provides information about status and additional details for requested JobId:

jobId is a 32 length string 
status: can be WAITING, RUNNING, COMPLETED_SUCCESFULLY, FAILED, CANCELED
exporterType: name of exporter
lastStatusChange: dateTime in ISO format about last status change date
outputFormat: result output format value (JSON, PIPE or XML)
errorDetails: error information. Can be one of (Internal server error, Job was canceled by a user, Result set is too large, reduce date range and/or number of entities)
totalRecords: number of response records. Only available for job status COMPLETED_SUCCESFULLY
resultsSizeBytes: object which contains information about compressed and uncompressed response file size in bytes. Only available for COMPLETED_SUCCESFULLY job status
additionalDetails: rpt file content

Response Examples

Example for JSON

Example for PIPE

Example for XML

API Specification: Get Status for all jobs assigned to authenticated user:

Description

Get status and additional information about all submitted exporters tasks for authenticated user

Authentication
Required

yes

URL

https://<domain or IP>/SMARTSync/services/rs/exporters/v1/status

Method

GET

Request
Headers

Cookie: JSESSIONID={jsessionId}
Content-Type: application/json

Response
Headers

Content-Type: application/json

Success
Response

Code: 200 OK
Content : [Response Data]

Error
Response

Code: 401 Unauthorized

Error message:

{

"message": "Unauthorized",

"status": 401

}

Response Data

Response provides information about status and additional details for all existing jobs which are assigned to the authenticated user.

jobId is a 32 length string 
status: can be WAITING, RUNNING, COMPLETED_SUCCESFULLY, FAILED, CANCELED
exporterType: name of exporter
lastStatusChange: dateTime in ISO format about last status change date
outputFormat: result output format value (JSON, PIPE or XML)
totalRecords: number of response records. Only available for COMPLETED_SUCCESFULLY job status
lastStatusChange: dateTime in ISO format about last status change date
resultsSizeBytes: object which contains information about compressed and uncompressed response file size in bytes. Only available for COMPLETED_SUCCESFULLY job status

Response Example