REST API Reference

Back Next

Sending an export job request for IPU usage data

You can run a job to export summary IPU usage data for the parent organization and its linked organizations such as additional production organizations, sub-organizations, and sandbox organizations for a specified date range.

After the job starts, you can check the job status. When the job completes successfully, you can send a request to download the data.

POST request

To request and receive summary IPU usage data, you must have access rights to the parent organization and all of the linked organizations.

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

/public/core/v3/license/metering/ExportMeteringDataAllLinkedOrgsAcrossRegion

Include the following fields in the request:

Field	Type	Required	Description
startDate	Date/time	Yes	Start of the date range.
endDate	Date/time	Yes	End of the date range. The range can be a maximum of 180 days.
combinedMeterUsage	Boolean	-	Whether to return usage information for all meters in one CSV file. Include one of the following values: TRUE. Return usage information for all meters in one CSV file. FALSE. Return usage information in a separate CSV file for each meter. Default is FALSE.
callbackUrl	String	-	A valid, publicly available URL. The service posts the job status to the callbackURL.

POST request example

You might use a request similar to the following example:

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

{
    "startDate":"2022-08-12T00:00:00Z",
    "endDate":"2022-10-25T00:00:00Z",
    "combinedMeterUsage":"FALSE"
    "callbackUrl":"https://MyExportJobStatus.com"
}

POST response

The response includes the following fields:

Field	Type	Description
jobID	String	ID of the export job.
status	String	Status of the export job.
errorMessage	String	Error message, if any, that is associated with the 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.
startDate	Date/time	Start of the date range.
endDate	Date/time	End of the date range.
callbackUrl	String	The 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.
combinedMeterUsage	Boolean	Whether usage data for all meters is returned in one CSV file.

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",
    "startDate": "2020-01-01T10:00:00Z",
    "endDate": "2022-12-31T00:00:00Z",
    "callbackUrl": "https://MyExportJobStatus.com",
    "createTime": null,
    "updateTime": null
    "combinedMeterUsage":"FALSE"
}

If an error occurs, the response might be similar to the following example:

{
    "jobId": "cYjwJNEF7OckWEmkSC1tSI",
    "status": "FAILED",
    "errorMessage": "Exception occurred while processing request for org:
4wMFqGlxAKVlIFTixlTSOY.\ncom.informatica.cloud.errorutil.MicroServiceException: Get
meter usage request failed with exception: I/O error on POST request",
    "orgId": "4wMFqGlxAKVlIFTixlTSOY",
    "userId": "aMxRLnYzdWtlkJvDbtPZOr",
    "selectedOrgId": "4wMFqGlxAKVlIFTixlTSOY",
    "startDate": "2020-01-01T10:00:00Z",
    "endDate": "2022-12-31T00:00:00Z",
    "callbackUrl": "https://MyExportJobStatus.com",
    "createTime": null,
    "updateTime": null
    "combinedMeterUsage":"FALSE"
}

Metering data

Download Guide

Watch

Comments

Cloud Data Integration Homepage