Jump to

• Request
• Response

Reverse a processed usage event

post

/crmRestApi/resources/11.13.18.05/subscriptionUsageEventBatches/{BatchNumber}/child/usageEvents/{EventNumber}/action/reverse

This method reverses a previously processed usage event using the provided reversal identifiers.

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=
• EventNumber(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

• reverseBatchId: number
  The identifier of the batch to which the usage event reversal applies.
• reverseBatchNumber: string
  The number of the batch to which the usage event reversal applies.
• reverseEventNumber: string
  The number of the event to be reversed.

{
    "type":"object",
    "properties":{
        "reverseBatchNumber":{
            "type":"string",
            "description":"The number of the batch to which the usage event reversal applies.",
            "nullable":true
        },
        "reverseBatchId":{
            "type":"number",
            "description":"The identifier of the batch to which the usage event reversal applies.",
            "nullable":true
        },
        "reverseEventNumber":{
            "type":"string",
            "description":"The number of the event to be reversed.",
            "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 status or result of the reverse operation.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"The status or result of the reverse operation."
        }
    },
    "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 reverse operation."
}

The status or result of the reverse operation.

Back to Top