Jump to

• Request
• Response

Add a usage event

post

/crmRestApi/resources/11.13.18.05/subscriptionUsageEventBatches/{BatchNumber}/action/addEvents

This method lets you add usage events to the rerate or reversal usage event batch using the specified rule conditions.

Request

Path Parameters

• BatchNumber(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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

• ruleBuilderConditions: array ruleBuilderConditions
  The rule conditions based on which usage events will be added to the rerate or reversal batch.

{
    "type":"object",
    "properties":{
        "ruleBuilderConditions":{
            "type":"array",
            "description":"The rule conditions based on which usage events will be added to the rerate or reversal batch.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : ruleBuilderConditions

Type: array

The rule conditions based on which usage events will be added to the rerate or reversal batch.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"The rule conditions based on which usage events will be added to the rerate or reversal batch.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

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 status or result of the add operation to the rerate or reversal usage event batch.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"The status or result of the add operation to the rerate or reversal usage event batch."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"The status or result of the add operation to the rerate or reversal usage event batch."
}

The status or result of the add operation to the rerate or reversal usage event batch.

Back to Top