GET /api/v1/getJobStatus.jsp

Get the status and results of a job.

Parameters:

appId (type: string; required): id of the app in which context the job is executed.
jobId (type: string; required): id of the job.

Call example:


curl -i -H "Accept: application/json" -H "Content-Type: application/json" -X GET "<path_to_infolink>/api/v1/getJobStatus.jsp?apiKey=<your API key>&appId=7&jobId=<jobId returned by executeJob>"

Response:

status (type: string): the status of the call can be success or error.
result (type: object):
- If status is success, result.status (type: string) contains the status of the job that can be one of the following:
  - completed: result.results contains the data returned by the job.
  - completedWithError
  - stopped
- If status is error, result.message contains the error message.

Response example:


{
"result": 
    {
        "status": "completed",    
        "results": [
            {
                "result": {
                   "schema": [
                       {
                           "updateable": false,
                           "typeStandard": {
                               "typeStr": "text",
                               "name": "text"
                            },
                           "name": "id",
                           "type": {
                               "typeStr": "nvarchar(max)",
                               "precision": -1,
                               "name": "nvarchar",
                               "scale": 0
                           }
                       },
                       {
                           "updateable": false,
                           "typeStandard": {
                               "typeStr": "text",
                               "name": "text"
                           },
                           "name": "company_name",
                           "type": {
                               "typeStr": "nvarchar(max)",
                               "precision": -1,
                               "name": "nvarchar",
                               "scale": 0
                           }
                       },
            
                   ],
                   "records": [
                       {
                           "company_name": "IBM",
                           "id": "1"
                       },
                       {
                           "company_name": "Microsoft",
                           "id": "2"
                       }
                   ]
                },
                "name": "companies"
            }
        ]
    },
"status": "success"
}