Getting a job's status

Use this operation to retrieve the current job status. When the status is “Success”, use the DownloadUri value to then retrieve the file. Asynchronous jobs are large in nature and can take several minutes to extract the data and generate the files.

Request

Copy

GET /dpss/api/v1/subscriptions/{{subscriptionid}}/batch-request/{{jobid}} HTTP/1.1
Host: k8s.itrontotal.com
Authorization: Bearer {{AccessToken}}
Itron-CorrelationId: 0c46eec6-41c3-41ab-b349-028b6ced9763
DataSubscriberId: {{subscriberid}}

Parameters

Table 19
Name	Description	In	Required	Type	Format
dataproductid	The identifier of the data product being requested.	Path	TRUE	String	UUID
Subscriptionid	Your subscription ID provided by Itron, different for each data product and tenant combination.	Path	TRUE	String	UUID
jobId	The identifier of the job in response to your batch request.	Path	TRUE	String	UUID
AccessToken	JWT access token obtained from the Identity Server. For example, Bearer: xyz	Header	TRUE	String	JWT

Response

Copy

{
    "jobId": "6ab9821f-4c56-4ad8-8815-8a67be55878f",
    "status": "Success",
    "downloadUrl": "https://sta1usw1dpss1prod1.blob.core.windows.net/raw/6AB9821F-4C56-4AD8-8815-8A67BE55878F/6AB9821F-4C56-4AD8-8815-8A67BE55878F.zip?sv=2018-03-28&sr=b&sig=COukUumUbBCJp7qOrIs9kw9J3%2BWj%2Bcc%2Bm69hB3oVYUg%3D&st=2024-07-18T20%3A37%3A19Z&se=2024-08-17T20%3A37%3A19Z&sp=r",
    "fileFormat": "csv",
    "tokens": {
        "StartEventDate": "2024-01-01",
        "EndEventDate": "2025-01-01",
        "StartReceivedDateTime": "",
        "EndReceivedDateTime": "",
        "Device": "",
        "ElectronicSerialNumber": "",
        "Meter": "",
        "MeterNumber": "",
        "ServicePoint": "9000053409,9002036306,9000910527,9001640122,",
        "Premises": "",
        "Transformer": "",
        "Feeder": ""
    },
    "isOhsRequest": false
}

Data values

Table 20
Name	Description	In	Type	Format
JobId	The identifier of the job in response to your batch request.	Body	String	UUID
Status	The status of the job. Options include: New, Started, Running, Success, Failed.	Body	String	N/A
DownloadUri	The temporary, secured URI where the file created in response to the batch request can be downloaded from.	Body	String	URI