REST API Reference

Back Next

Request summary data with the older REST API resource

You can continue to use the ExportMeteringDataAllLinkedOrgsAcrossRegion resource for existing export requests.

POST request

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

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

The following table describes the fields to include 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	-	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.
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/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 following table describes the response 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	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 organizations 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"
}

Requesting summary IPU usage data

Download Guide

Watch

Comments

Cloud Data Integration Homepage