REST API Reference

Back Next

Request summary data with the new REST API resource

Use the ExportMeteringData resource for all new export requests.

POST request

To send an export job request, use the following URI:

/public/core/v3/license/metering/ExportMeteringData

The following table describes the fields to include in the request:

Field	Type	Required	Description
startDate	String	Yes	Start of the date range in ISO 8601 format. For example, 2022-08-12T00:00:00Z
endDate	String	Yes	End of the date range in ISO 8601 format. When you request summary data, the range can be a maximum of 180 days.
jobType	String	Yes	Type of metering data to export. Use SUMMARY.
combinedMeterUsage	String	-	Indicates whether to return usage information for all organizations in one CSV file. Include one of the following values: TRUE. Return usage information for all organizations in one CSV file. FALSE. Return usage information for each organization in a separate CSV file. Default is FALSE.
allLinkedOrgs	String	-	Indicates whether to return usage information from the parent organization and all its linked organizations. Include one of the following values: TRUE. Return usage information for the parent organization and all linked organizations. FALSE. Return usage information for the parent organization only. Default is FALSE.
callbackUrl	String	-	A valid, publicly available URL where the service posts the job status.

POST request example

You might use a request similar to the following example:

POST <baseApiUrl>/public/core/v3/license/metering/ExportMeteringData
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>

{
    "startDate":"2024-08-12T00:00:00Z",
    "endDate":"2024-09-12T00:00:00Z",
    "jobType":"SUMMARY",
    "combinedMeterUsage":"TRUE",
    "allLinkedOrgs":"TRUE",
    "callbackUrl":"https://MyExportJobStatus.com"
}

POST response

The following table describes the response fields:

Field	Type	Description
jobID	String	ID of the export job.
status	String	Status of the export job.
orgId	String	Organization ID for the requesting organization.
userId	String	ID of the user who sent the request.
selectedOrgId	String	Organization ID for the requesting organization.
meterId	String	Meter ID.
startDate	String	Start of the date range.
endDate	String	End of the date range.
callbackUrl	String	URL that the service uses to post the job status.
createTime	String	Time the export job was created.
updateTime	String	Time the export job was last updated.

POST response example

If successful, you might receive a response similar to the following example:

{
    "jobId": "cYjwJNEF7OckWEmkSC1tSI",
    "status": "CREATED",
    "orgId": "4wMFqGlxAKVlIFTixlTSOY",
    "userId": "aMxRLnYzdWtlkJvDbtPZOr",
    "selectedOrgId": "4wMFqGlxAKVlIFTixlTSOY",
    "meterId": null,
    "startDate": "2024-08-12T00:00:00Z",
    "endDate": "2024-09-12T00:00:00Z",
    "callbackUrl": "https://MyExportJobStatus.com",
    "createTime": "2024-09-12T23:22:20Z",
    "updateTime": "2024-09-12T23:22:20Z"
}

Requesting summary IPU usage data

Download Guide

Watch

Comments

Cloud Data Integration Homepage