Creating asynchronous batch requests

Use this operation to create an asynchronous request for a file download of the data you want to query based on the wanted parameters and file type. This method will return a JobId.

Request

Copy

POST /dpss/api/v1/subscriptions/{{subscriptionid}}/batch-request HTTP/1.1
Host: k8s.itrontotal.com
Authorization: Bearer {{AccessToken}}
Itron-CorrelationId: 26454e7a-f973-4dda-9efc-08770e49bf19
DataSubscriberId: {{subscriberid}}


{
    "filetype": "Json",
    "tokens": {
        "StartEventDate": "2024-01-01",
        "EndEventDate": "2025-01-01",
        "StartReceivedDateTime": "",
        "EndReceivedDateTime": "",
        "Device": "",
        "ElectronicSerialNumber": "",
        "Meter": "",
        "MeterNumber": "",
        "ServicePoint": "9022053409,8202036306,9011110527,9067540122,",
        "Premises": "",
        "Transformer": "",
        "Feeder": ""
    },
    "isOhsRequest": false
}

Parameters

Table 17
Name	Description	In	Required	Type	Format
Subscriptionid	Your subscription ID provided by Itron, different for each data product and tenant combination.	Path	TRUE	String	UUID
SubscriberId	Your subscriber ID provided by Itron.	Header	TRUE	String	UUID
AccessToken	JWT access token obtained from the Identity Server. For example, Bearer: xyz	Header	TRUE	String	JWT
FileType	To request the file type of the data that is retrieved. Options include Parquet, Orc, Json, and Csv.	Body	TRUE	String	N/A
Tokens	A key value pair of the query parameters you use to query the data product and their associated values.	Body	TRUE	Json	N/A

Response

Copy

{
    "jobId": "6ab9821f-4c56-4ad8-8815-8a67be55878f",
    "status": "New",
    "downloadUrl": null,
    "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 18
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