GET result

Retrieves the exporter job output result for a specified job.

API Specification

Description Returns exporter job output result to the end user. The result can be in one of the formats: XML, PIPE, JSON
Authentication
Required
yes
URL https://<domain or IP>/SMARTSync/services/rs/exporters/v1/result/{jobId}
Method GET
Request Headers

Cookie: JSESSIONID={jsessionId}
Accept*/*, or one from the list: application/jsontext/plainapplication/xmltext/xml - depends on the expected result

Accept-Encodinggzip, deflate, br

Request query params

startRecord (Optional) position of element from which results will be returned.

numRecords (Optional) count of records to return starting from startRecord.

To get pagination results both params should be present in query and should be valid.

example query: /SMARTSync/services/rs/exporters/v1/result/d71ee75dfee04566848e3062191e9736?startRecord=1800&numRecords=7

Response
Headers

Content-Type: application/json, text/plain , application/xml, text/xml - depends on the expected result

Content-Encoding: GZIP

X-Start-Record: <integer between 1 and totalrecords of result>. Present only when querying for paginated result.
X-Count-Records: <integer value of numRecords if elements in results are not last, otherwise totalrecords of result - startRecord> . Present only when querying for paginated result.
X-Next-Record: <integer position of next available element if present>. Present only if pagination result doesn't return last element.
X-Remaining-Records: <integer count of elements till the end of result>. Present only if pagination result doesn't return last element.

Success
Response

Code: 200 OK
Content : [Response Data]

Error
Response
Code: 206 Partial content
{
"message": "Your Job isn't completed yet. Try again later",
"status": 206
}
Code: 206 Partial content
{
"message": "Your job has failed. Call the status endpoint to get more details about the failure",
"status": 206
}
 
Code: 206 Partial content
{
"message": "Job was canceled by a user",
"status": 206
}
 
Code: 400 Bad Request
{
"message": "One or more request validations failed",
"status": 400,
"details": [
"'startRecord' query parameter value must be >= 1",
"'numbRecords' query parameter value must be >= 1"
    ]
}
{
"message": "One or more request validations failed",
"status": 400,
"details": [
"Invalid query parameter 'wrongParameter1'"
    ]
}
{
"message": "One or more request validations failed",
"status": 400,
"details": [
"Missing mandatory query parameter: 'numRecords'"
    ]
}
 
{
"message": "One or more request validations failed",
"status": 400,
"details": [
"Missing mandatory query parameter: 'startRecord'"
    ]
}
{
"message": "One or more request validations failed",
"status": 400,
"details": [
"Invalid startRecord value 'A'",
"Invalid numRecords value 'B'"
    ]
}
{
"message": "'startRecord' query parameter value must be less or equal to number of records in the results",
"status": 400
}
 
Code: 401 Unauthorized

Error message:

{
"message": "Unauthorized",
"status": 401
}
 
Code: 403 Forbidden
{
"message": "Unauthorized to access Job ID: 8724eb83dfa843fdb344893ab829df02",
"status": 403
}
 
Code: 404 Not Found
{
"message": "Job id is not found",
"status": 404
}
{
"message": "Your request returned no results, update your request parameters",
"status": 404
}
 
Code: 406 Not Acceptable
{
"message": "The results are served as text/plain, client must support that type to retrieve the results",
"status": 406
}
 
Code: 500 Internal server error
{
"message": "Unexpected error happens",
"status": 500
}

Response Data in the one of the formats: XML, PIPE or JSON

JSON results are in tree or array format depending on each exporter's design.

 

Example of XML result

Example of JSON result

PIPE results with enabled headers

PIPE Results with disabled headers

JSON Results with Pagination in tree format

JSON Results with Pagination in array format

Pagination XML Results

Pagination PIPE Results