Get Reports in Async Mode
Describes the API specifications for retrieving data for reports in the async mode.
GET Execute Report in Async Mode
By setting the parameter Asynchronous: true, a report can be set in the async mode.
Request Format
URL: <env_url>/api/vc/report
HTTP Method: GET
curl --location '<env_url>/api/vc/report/<report_id>' \
--header 'isAsynchronous: true' \
--header 'Authorization: Bearer <token>'
Response Example
<?xml version="1.0" encoding="UTF-8"?> <Status> <TransactionID>z25052014394381730373fcb</TransactionID> </Status>
Other Responses or Errors
<?xml version="1.0" encoding="UTF-8"?> <Status> <TransactionID>z25052020582315229671104</TransactionID> <ReturnCode>255</ReturnCode> <Message>Your transaction is already in progress. Please poll using the transaction ID: [z25052020581705310787104] for the report output.</Message> </Status>
GET Poll Report Transaction for Report Output data
Using the transactionId parameter, the status of a report can be viewed.
Request Format
URL: <env_url>/api/vc/report/<report_id>?transactionId=<transaction_id>
HTTP Method: GET
curl --location '<env_url>/api/vc/report/<report_id>?transactionId=<transaction_id>' \
--header 'isAsynchronous: true' \
--header 'Authorization: Bearer <token>'
Response Example
"Job Posting ID","Job Posting Status","Job Posting Create Date" "CRPAJP00000501","Submitted","02/20/2012 05:32 pm" "CRPAJP00000502","Submitted","02/20/2012 06:06 pm" "CRPAJP00000503","Submitted","02/20/2012 06:36 pm" "CRPAJP00000504","Submitted","02/20/2012 08:47 pm" "CRPAJP00000505","Submitted","02/20/2012 08:58 pm" "CRPAJP00000506","Submitted","02/20/2012 09:06 pm" "CRPAJP00000507","Submitted","02/20/2012 09:11 pm" "CRPAJP00000512","Submitted","02/20/2012 10:35 pm" "CRPAJP00000513","Submitted","02/21/2012 12:05 am"
Other Responses or Errors
{"status":"Your transaction might still be in progress, as the report generation typically depends on your configuration. Please wait and try polling again."}
{"status":"Your transaction might be an older or completed one. Please poll using the latest transaction ID received from the asynchronous call."}
<?xml version="1.0" encoding="UTF-8"?>
<Status>
<TransactionID>z25052021000692730257104</TransactionID>
<ReturnCode>255</ReturnCode>
<Message>Your transaction might be invalid. Please use the latest transaction ID received from the asynchronous call to poll.</Message>
</Status>