Table of Contents

Search

  1. Preface
  2. Informatica Intelligent Cloud Services REST API
  3. Platform REST API version 2 resources
  4. Platform REST API version 3 resources
  5. Data Integration REST API
  6. File Ingestion and Replication REST API
  7. Streaming Ingestion and Replication REST API
  8. Model Serve REST API
  9. RunAJob utility
  10. ParamSetCli utility
  11. REST API codes
  12. REST API resource quick references

REST API Reference

REST API Reference

Getting the metering data export job status

Getting the metering data export job status

Use a GET request to get the status of an export job for metering data.

GET request

To get the status of the export job, use the following URI:
/public/core/v3/license/metering/ExportMeteringData/<jobId>

GET response

The response includes the following fields:
Field
Type
Description
jobID
String
ID of the export job.
status
String
Status of the export job. One of the following values can be returned:
  • CREATED
  • PROCESSING
  • SUCCESS
  • FAILED
  • PARTIAL_SUCCESS
If the status is PARTIAL_SUCCESS, the job completed but data couldn't be collected for all of the linked organizations due to errors.
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.
meterId
String
Meter ID.
Applicable for jobs requesting job-level details.
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.

GET response example

If successful, you might receive a response similar to the following example:
{ "jobId": "4l1eKlA9ngChmu6gdv3FKs", "status": "SUCCESS", "orgId": "4wMFqGlxAKVlIFTixlTSOY", "userId": "aMxRLnYzdWtlkJvDbtPZOr", "selectedOrgId": "4wMFqGlxAKVlIFTixlTSOY", "meterId": null, "startDate": "2022-08-01T10:00:00Z", "endDate": "2022-12-31T00:00:00Z", "callbackUrl": "https://MyExportJobStatus.com", "createTime": "2022-11-23T10:04:37Z", "updateTime": "2022-11-23T10:04:37Z" }
If the job is partially successful, the response might be similar to the following example:
{ "jobId": "cYjwJNEF7OckWEmkSC1tSI", "status": "PARTIAL_SUCCESS", "errorMessage": "Short error message: [fetchEligibleJobForExecution] Exception in executing job. org.springframework.web.client.HttpServerErrorException$ServiceUnavailable: 503 Service Unavailable: \"<html><body><h1>503 Service Unavailable</h1><EOL>No server is available to handle this request.<EOL></body></html><EOL>\", "orgId": "4wMFqGlxAKVlIFTixlTSOY", "userId": "aMxRLnYzdWtlkJvDbtPZOr", "selectedOrgId": "4wMFqGlxAKVlIFTixlTSOY", "meterId": null, "startDate": "2020-01-01T10:00:00Z", "endDate": "2022-12-31T00:00:00Z", "callbackUrl": "https://MyExportJobStatus.com", "createTime": null, "updateTime": null }

0 COMMENTS

We’d like to hear from you!