Response Example When the Forms Asynchronous Reporting API Request Is Successful

If a submitted API request is successful, the corresponding response body contains the fields described in this topic.

API Requests and Responses:

API Request

API Response

Reporting job submission

Sample response:

{
    "jobId" : "abc1234-9090-def5678",
    "status":"SUBMITTED",
    "message" : ""
}

  • jobId: The job ID of the submitted job.

  • status: The initial status of the job, which is SUBMITTED.

  • message: A message related to the job.

Reporting job status

Sample response:

{
    "jobId":"abc1234-9090-def5678",
    "status":"SUBMITTED",
    "message":""
}

  • jobId: The job ID of the job whose status is requested.

  • status: The retrieved status of the job. Status can be one of the following:

    • SUBMITTED

    • INPROGRESS

    • COMPLETED

    • FAILED

  • message: A message related to the job.

Reporting job list

Sample response:

[
{
"jobId":"",
"status":"",
"initiatedOn":"",
"finishedOn":"",
"errorDetails":""
},
{
"formId": "64407d21-b91c-46c0-bada-7208a0dc3fe3",
"formVersion": "1",
"filter": "documentStatus eq 'submitted'",
"requestedBy": "cnoll",
"timeCreated": "2019-08-19T14:08:14.379Z",
"status": "COMPLETED",
"jobId": "f3689890-b6ba-4739-b4f2-70af874eef24" 
},
{
"jobId":"",
"status":"",
"initiatedOn":"",
"finishedOn":"",
"errorDetails":""
}
]

  • jobId: The job ID of a job.

  • status: The status of the job.

  • initiatedOn: The start date of the job.

  • finishedOn: The end date of the job.

  • errorDetails: Error details related to the job.