Discovering batch request parameters

This operation retrieves the list of query parameters available to send in request of a data product. Use these parameters to specify what specific data you want to retrieve when making batch requests.

Request

Copy

GET /dpss/api/v1/subscriptions/{{subscriptionid}}/batch-request-parameters HTTP/1.1
Host: k8s.itrontotal.com
Authorization: Bearer {{AccessToken}}
Itron-CorrelationId: {{correlationid}}
DataSubscriberId: {{subscriberid}}

Parameters

Table 15
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
AccessToken	JWT access token obtained from the Identity Server. For example, Bearer: xyz	Header	TRUE	String	JWT
SubscriberId	Your subscriber ID provided by Itron.	Header	TRUE	String	UUID

Response

Copy

{
    "tokens": [
        {
            "name": "StartEventDate",
            "type": "DATE",
            "isList": false,
            "default": "__REQUIRED__",
            "description": "Min Event Date"
        },
        {
            "name": "EndEventDate",
            "type": "DATE",
            "isList": false,
            "default": "12-29-9999",
            "description": "Max Event Date"
        },
        {
            "name": "StartReceivedDateTime",
            "type": "TIMESTAMP",
            "isList": false,
            "default": "__REMOVEIFNOTSUPPLIED__",
            "description": "Start of the time range for which the data is requested"
        },
        {
            "name": "EndReceivedDateTime",
            "type": "TIMESTAMP",
            "isList": false,
            "default": "__REMOVEIFNOTSUPPLIED__",
            "description": "End of the time range for which the data is requested"
        },
        {
            "name": "Device",
            "type": "STRING",
            "isList": true,
            "default": "__REMOVEIFNOTSUPPLIED__",
            "description": "An electromechanical device that records measurements and/or communicates data on a network"
        },
        {
            "name": "ElectronicSerialNumber",
            "type": "STRING",
            "isList": true,
            "default": "__REMOVEIFNOTSUPPLIED__",
            "description": "ElectronicSerialNumber"
        },
        {
            "name": "Meter",
            "type": "STRING",
            "isList": true,
            "default": "__REMOVEIFNOTSUPPLIED__",
            "description": "An electromechanical device that records electricity, gas, or water measurements to determine the consumption and usage demand at a Service Point"
        },
        {
            "name": "MeterNumber",
            "type": "STRING",
            "isList": true,
            "default": "__REMOVEIFNOTSUPPLIED__",
            "description": ""
        },
        {
            "name": "ServicePoint",
            "type": "STRING",
            "isList": true,
            "default": "__REMOVEIFNOTSUPPLIED__",
            "description": "A point where a customer meter is installed and electricity, gas, or water consumption is measured"
        },
        {
            "name": "Premises",
            "type": "STRING",
            "isList": true,
            "default": "__REMOVEIFNOTSUPPLIED__",
            "description": "A physical location where a customer consumes the services supplied by your company"
        },
        {
            "name": "Transformer",
            "type": "STRING",
            "isList": true,
            "default": "__REMOVEIFNOTSUPPLIED__",
            "description": "A device that changes the voltage from a distribution voltage to a service voltage, generally less than 480 V, before delivering electricity to a service point"
        },
        {
            "name": "Feeder",
            "type": "STRING",
            "isList": true,
            "default": "__REMOVEIFNOTSUPPLIED__",
            "description": "A point immediately below a substation bank where power exits a substation to serve the demand of all customers connected to the feeder"
        }
    ]
}

Data values

Table 16
Name	Description	In	Type
Tokens	An array of the available query parameters for this data product.	Body	Json
Name	The name of the parameter.	Body	String
Description	A description of the parameter.	Body	String
Type	The data type of the parameter.	Body	String
Default	The default value used if the parameter is omitted from a batch request.	Body	String