Update an usage event

patch

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

Request

Path Parameters
  • 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=
  • 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
  • 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".
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Currency Code
    Maximum Length: 15
    The corporate currency code associated with the usage event.
  • Maximum Length: 30
    The currency conversion rate type associated with the usage event.
  • Title: Currency Code
    Maximum Length: 15
    The currency code associated with the usage event. A list of accepted values is defined in the FND_CURRENCIES_VL view for currency code
  • Title: Error
    Maximum Length: 255
    The error message text for the usage event.
  • Title: Event End Time
    The date and time when a usage event ends.
  • Title: Event Rating Type
    Maximum Length: 30
    The event rating type of an event.
  • Title: Event Start Time
    The date and time when usage event starts.
  • Title: Event Status
    Maximum Length: 30
    The usage event processing status. The event status is used to segregate event records that are ready for processing and the ones that are on hold requiring further enrichment. The outcome of the pricing process is also recorded in the status. A list of accepted values is defined in the ORA_OSS_EVENT_STATUS lookup for usage event status.
  • Title: Event End Time
    Maximum Length: 50
    The usage event time zone.This is the Time Zone of the logged in user.
  • Title: Event Type
    Maximum Length: 30
    The usage event types that will be imported and processed by the pricing engine. A list of accepted values is defined in the ORA_OSS_EVENT_TYPES lookups for usage event type.
  • The unique identifier of the event type.
  • Title: File Name
    Maximum Length: 300
    The file name of the event.
  • Title: Priced on Date
    The date on which the usage event is priced.
  • Title: Related Batch ID
    The related batch ID of the event.
  • Title: Related Event ID
    The related event ID of the event.
  • Title: Reported Usage Quantity
    The reported usage quantity of the event.
  • Title: Reported UOM
    Maximum Length: 3
    The reported unit of measure of the event such as Ea, FT, and GAL. A list of accepted values is defined in INV_UNITS_OF_MEASURE_VL for a usage unit of measure.
  • Title: Service Identifier
    Maximum Length: 120
    The unique identifier of the service identifier.
  • Title: Source Interface Type
    Maximum Length: 30
    The source interface type of the event.
  • Subscription Usage Event Charges
    Title: Subscription Usage Event Charges
    The usage event charges resource is used to view, create, update, and delete an usage event charge. It provides details of the usage event charges associated with a subscription product.
  • Subscription Usage Event Messages
    Title: Subscription Usage Event Messages
    The usage event messages resource is used to view, create, update, and delete an usage event message.
  • Title: Usage Quantity
    The usage quantity of the event.
  • Title: Usage UOM
    Maximum Length: 3
    The unit of measure of the event such as Ea, FT, and GAL. A list of accepted values is defined in the INV_UNITS_OF_MEASURE_VL view for a usage unit of measure.
Nested Schema : Subscription Usage Event Charges
Type: array
Title: Subscription Usage Event Charges
The usage event charges resource is used to view, create, update, and delete an usage event charge. It provides details of the usage event charges associated with a subscription product.
Show Source
Nested Schema : Subscription Usage Event Messages
Type: array
Title: Subscription Usage Event Messages
The usage event messages resource is used to view, create, update, and delete an usage event message.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : subscriptionUsageEventBatches-usageEvents-usageMessages-item-patch-request
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : subscriptionUsageEventBatches-usageEvents-item-response
Type: object
Show Source
Nested Schema : Subscription Usage Event Charges
Type: array
Title: Subscription Usage Event Charges
The usage event charges resource is used to view, create, update, and delete an usage event charge. It provides details of the usage event charges associated with a subscription product.
Show Source
Nested Schema : Subscription Usage Event Messages
Type: array
Title: Subscription Usage Event Messages
The usage event messages resource is used to view, create, update, and delete an usage event message.
Show Source
Nested Schema : subscriptionUsageEventBatches-usageEvents-usageCharges-item-response
Type: object
Show Source
Nested Schema : subscriptionUsageEventBatches-usageEvents-usageMessages-item-response
Type: object
Show Source
Back to Top