REST API Reference

Back Next

Sending an export job request for job-level metering data

For certain meters, you can run a job to export job-level details for a particular service and meter 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 send the export job request, use the following URI:

/public/core/v3/license/metering/ExportServiceJobLevelMeteringData

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.
allMeters	Boolean	Required when meterId is blank.	Whether to return usage information for all meters. Include one of the following values: TRUE. Return usage information for all meters. FALSE. Return usage information for meter specified in meterId field. Default is FALSE.
meterId	String	Required when allMeters is FALSE.	Meter ID. For allowable values, see Meter IDs
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/ExportServiceJobLevelMeteringData
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>

{
    "startDate":"2022-08-12T00:00:00Z"
    "endDate":"2022-10-25T00:00:00Z"
    "allMeters":"FALSE"
    "meterId":"3TaYTMo6BFYeNIABfVmH0n"
    "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.
allMeters	Boolean	Whether usage information for all meters is included.
meterId	String	Meter ID.
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.

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

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

Metering data

Meter IDs

Download Guide

Watch

Comments

Cloud B2B Gateway Homepage