Get Job Details
Get details of a job for a given job_id. job_id parameter can be obtained from the Get All User Jobs API.
Endpoint#
URL: https://portal.bihelper.tech/api/user-jobs/{job_id}Method: GETHeaders#
| Key | Value | Description |
|---|---|---|
| Authorization | Bearer Auth_Token | Auth token |
| Content-Type | application/json | |
| User-Agent | curl/7.68.0 | Set user agent header |
Curl Request#
curl --location --request GET 'https://portal.bihelper.tech/api/user-jobs/443' \--header 'Authorization: Bearer Auth_Token' \--header 'User-Agent: curl/7.68.0' Response#
Sample response:
{ "id": 443, "name": "API Demo Job", "isActive": true, "lastRun": null, "nextRun": "2020-05-20T19:58:16", "timeZone": "Etc/GMT", "status": "READY", "jobDuration": 0, "jobRunFrequency": "MONTHLY", "userJobStartTime": "2020-05-20T19:58:16", "userId": 6, "userReportGenerationTasks": [ { "id": 433, "name": "NOT CONFIGURED", "isActive": true, "lastRun": null, "nextRun": null, "timeZone": "America/New_York", "status": null, "jobDuration": null, "userWorkspace": "My workspace", "userWorkspaceId": "MY_WORKSPACE", "userReportName": "Retail Sales Report", "reportType": "REPORTS", "generateSamples": false, "userJobId": 443, "pbiUserName": "7AmKogAOK4KFgM4VT+e5o080MN990Z/ng0I0ozRZKq0=", "pbiPassword": "5sw13cfs2ZKKpP/cKDRA9hybHluBScAyyX9Z97LYSrc=", "reportRunPeriod": "LAST_MONTH", "scriptName": "NewJob_443", "filePrefix": "Retail Sales Report", "reportUrl": "https://app.powerbi.com/reportEmbed?reportId=db9a2770-75de-492a-827f-be2a78c8af78&config=eyJjbHVzdGVyVXJsIjoiaHR0cHM6Ly9XQUJJLUlORElBLUNFTlRSQUwtQS1QUklNQVJZLXJlZGlyZWN0LmFuYWx5c2lzLndpbmRvd3MubmV0IiwiZW1iZWRGZWF0dXJlcyI6eyJtb2Rlcm5FbWJlZCI6ZmFsc2V9fQ%3d%3d", "dataIngestionMode": "MANUAL", "numberOfLoops": 10, "timeout": 30, "transparentBackground": false, "pagesToPrint": "All", "pageSize": "1280*720", "generateExcel": false, "listOfExcelVisuals": "All", "shouldPDFBeGenerated": true, "reportDateField": null, "userReportGenerationFilterData": [ { "id": 50325, "startDate": null, "endDate": null, "isActive": true, "filterName": "District Manager <> Store/DM", "filterValue": "Andrew11 Ma", "contacts": null, "toEmail": "ishan@bihelper.tech", "ccEmail": null, "bccEmail": null, "userReportGenerationTasksId": 433 }, { "id": 50326, "startDate": "2020-06-24T02:55:51", "endDate": "2020-06-24T02:55:51", "isActive": true, "filterName": "District Manager <> Store/DM", "filterValue": "Allan11 Guinot", "contacts": "", "toEmail": "kiran@bihelper.tech", "ccEmail": null, "bccEmail": null, "userReportGenerationTasksId": 433 }, { "id": 50327, "startDate": "2020-06-24T02:55:51", "endDate": "2020-06-24T02:55:51", "isActive": true, "filterName": "District Manager <> Store/DM", "filterValue": "Ishan Rastogi", "contacts": "", "toEmail": "kiran@bihelper.tech", "ccEmail": null, "bccEmail": null, "userReportGenerationTasksId": 433 } ] } ], "userEmailTasks": [ { "id": 426, "name": "Email Task Default Name", "isActive": true, "lastRun": null, "nextRun": null, "timeZone": "America/New_York", "status": null, "jobDuration": null, "taskRunTime": null, "userJobId": 443, "fromEmail": "BI Helper Demo <demo@bihelper.tech>", "isEmailVerified": true, "clientEmailTemplateName": null, "testCampaign": false, "emailTitle": "BI Helper Report", "emailBody": "<div>Hi,</div><div><br></div><div>Please find attached a PDF of your report <strong>without</strong> any slicers or filters applied.</div><div><br></div><div>To add slicers or filters to your report, please refer to the following documents:</div><div><br></div><ul><li><a href=\"https://medium.com/bi-helper/tutorial-configure-a-power-bi-report-with-slicers-and-filters-9d51629c57e2\" target=\"_blank\">Configure your BI Helper job with slicers or filters</a></li><li><a href=\"https://bihelperresources.s3.amazonaws.com/documentation/BI+Helper+-+Product+Documentation.pdf\" target=\"_blank\">Product Guide</a></li></ul><div><br></div><div>For any assistance, please email contact@bihelper.tech</div><div><br></div><div>Thank you,</div><div><img src=\"https://s3.amazonaws.com/bihelperresources/images/logo.png\" width=\"101\"></div>", "emailSignature": null } ]}