Jump to

• Request
• Response

Get metric for usage batches

post

/crmRestApi/resources/11.13.18.05/subscriptionUsageEventBatches/action/getMetricsForUsageBatches

This method lets you get the metrics details on events for batches based on given status and time unit.

Request

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• batchStatus: string
  The batch status for which the metrics need to be calculated.
• timeUnitCode: string
  The time unit code for which the metrics need to be calculated.
• timeUnitValue: number
  The time unit value for which the metrics need to be calculated.

{
    "type":"object",
    "properties":{
        "timeUnitValue":{
            "type":"number",
            "description":"The time unit value for which the metrics need to be calculated.",
            "nullable":true
        },
        "timeUnitCode":{
            "type":"string",
            "description":"The time unit code for which the metrics need to be calculated.",
            "nullable":true
        },
        "batchStatus":{
            "type":"string",
            "description":"The batch status for which the metrics need to be calculated.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): object result
  Additional Properties Allowed: additionalProperties

  The metric details on events for batches.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"number"
            },
            "description":"The metric details on events for batches."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• number

{
    "type":"object",
    "additionalProperties":{
        "type":"number"
    },
    "description":"The metric details on events for batches."
}

The metric details on events for batches.

Back to Top