Update an usage event
patch
/crmRestApi/resources/11.13.18.05/subscriptionUsageEventBatches/{BatchNumber}/child/usageEvents/{EventNumber}
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/json
Root Schema : schema
Type:
Show Source
object
-
CorpCurrencyCode: string
Title:
Currency Code
Maximum Length:15
The corporate currency code associated with the usage event. -
CurcyConvRateType: string
Maximum Length:
30
The currency conversion rate type associated with the usage event. -
CurrencyCode: string
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 -
Error: string
Title:
Error
Maximum Length:255
The error message text for the usage event. -
EventEndTime: string
(date-time)
Title:
Event End Time
The date and time when a usage event ends. -
EventRatingType: string
Title:
Event Rating Type
Maximum Length:30
The event rating type of an event. -
EventStartTime: string
(date-time)
Title:
Event Start Time
The date and time when usage event starts. -
EventStatus: string
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. -
EventTimeZone: string
Title:
Event End Time
Maximum Length:50
The usage event time zone.This is the Time Zone of the logged in user. -
EventType: string
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. -
EventTypeId: integer
(int64)
The unique identifier of the event type.
-
FileName: string
Title:
File Name
Maximum Length:300
The file name of the event. -
PricedOn: string
(date-time)
Title:
Priced on Date
The date on which the usage event is priced. -
RelatedBatchId: integer
(int64)
Title:
Related Batch ID
The related batch ID of the event. -
RelatedEventId: integer
(int64)
Title:
Related Event ID
The related event ID of the event. -
ReportedUsageQuantity: number
Title:
Reported Usage Quantity
The reported usage quantity of the event. -
ReportedUsageUnitOfMeasure: string
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. -
ServiceId: string
Title:
Service Identifier
Maximum Length:120
The unique identifier of the service identifier. -
SourceInterfaceType: string
Title:
Source Interface Type
Maximum Length:30
The source interface type of the event. -
usageCharges: array
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. -
usageMessages: array
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. -
UsageQuantity: number
Title:
Usage Quantity
The usage quantity of the event. -
UsageUnitOfMeasure: string
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:
Show Source
object
-
AllowanceAmount: number
Title:
Allowance Amount
The allowance amount of the usage event charge. -
BilledAmount: number
Title:
Amount
The billed amount of the usage event charge. -
ChargeCurrency: string
Title:
Currency
Maximum Length:15
The currency of the usage event charge. -
ChargeDefinition: string
Title:
Charge Definitions
Maximum Length:30
The charge definition associated with the usage event charge. -
ChargeDefinitionId: integer
(int64)
The identifier of the charge definition associated with the usage event charge.
-
ChargeName: string
Title:
Charge Name
Maximum Length:120
The name of the usage event charge. -
EventId: integer
(int64)
Title:
Event Identifier
The unique identifier of the event to which this usage event charge is associated with. -
ExtendedAmount: number
Title:
Extended Amount
The extended amount of the usage event charge. -
ObjectVersionNumber: integer
(int32)
The object version number updated after every update of an usage event charge.
-
ParentEntity: string
Title:
Reference Object
Maximum Length:30
The parent entity associated with the usage event charge. -
ParentEntityId: integer
(int64)
Title:
Reference Object ID
The unique identifier of the parent entity associated with the usage event charge. -
PricedQuantity: number
Title:
Priced Quantity
The quantity priced for an usage event charge. -
PricedQuantityUnitOfMeasure: string
Title:
Priced Quantity Unit of Measure
Maximum Length:3
The unit of measure of the priced quantity of an usage event charge. -
SequenceNumber: integer
(int32)
Title:
Sequence Number
The sequence number associated with an usage event charge. -
SubscriptionId: integer
(int64)
Title:
Subscription ID
The unique identifier of a subscription to which this usage event change belongs. -
SubscriptionProductId: integer
(int64)
Title:
Subscription Product ID
The PUID of a subscription product to which this usage event charge belongs.
Nested Schema : subscriptionUsageEventBatches-usageEvents-usageMessages-item-patch-request
Type:
Show Source
object
-
MessageName: string
Title:
Message Name
Maximum Length:30
The name of the usage event message. -
MessageText: string
Title:
Message Text
Maximum Length:2000
The text of the usage event message. -
MessageType: string
Title:
Message Type
Maximum Length:30
The type of the usage event message. -
ObjectVersionNumber: integer
(int32)
Title:
Object Version Number
The object version number updated after every update of an usage event message. -
ParentEntity: string
Title:
Reference Object
Maximum Length:30
The parent entity associated with the usage event message. -
ParentEntityId: integer
(int64)
Title:
Reference Object ID
The unique identifier of the parent entity associated with the usage event message. -
UsageMessageId: integer
(int64)
Title:
Usage Message
The unique identifier of an usage event message.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
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:
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.
Root Schema : subscriptionUsageEventBatches-usageEvents-item-response
Type:
Show Source
object
-
BatchNumber: string
Title:
Batch Number
Maximum Length:120
The number of the batch associated with an usage event. -
CorpCurrencyCode: string
Title:
Currency Code
Maximum Length:15
The corporate currency code associated with the usage event. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created a usage event. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when a usage event was created. -
CurcyConvRateType: string
Maximum Length:
30
The currency conversion rate type associated with the usage event. -
CurrencyCode: string
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 -
Error: string
Title:
Error
Maximum Length:255
The error message text for the usage event. -
EventEndTime: string
(date-time)
Title:
Event End Time
The date and time when a usage event ends. -
EventId: integer
(int64)
Title:
Event Identifier
The unique identifier of the event. -
EventNumber: string
Title:
Event Number
Maximum Length:120
The alternate unique identifier of the event. -
EventRatingType: string
Title:
Event Rating Type
Maximum Length:30
The event rating type of an event. -
EventStartTime: string
(date-time)
Title:
Event Start Time
The date and time when usage event starts. -
EventStatus: string
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. -
EventTimeZone: string
Title:
Event End Time
Maximum Length:50
The usage event time zone.This is the Time Zone of the logged in user. -
EventType: string
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. -
EventTypeId: integer
(int64)
The unique identifier of the event type.
-
FileName: string
Title:
File Name
Maximum Length:300
The file name of the event. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when a usage event was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who has last updated a usage event. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the usage event. -
LeEventStartDate: string
(date)
Title:
Start Date
Read Only:true
The legal entity date when usage event starts. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PricedOn: string
(date-time)
Title:
Priced on Date
The date on which the usage event is priced. -
RatingSource: string
Title:
Rating Source
Maximum Length:30
The rating source of an usage event. This attributes gives information on whether the usage event is rated by subscription management or not. -
RelatedBatchId: integer
(int64)
Title:
Related Batch ID
The related batch ID of the event. -
RelatedEventId: integer
(int64)
Title:
Related Event ID
The related event ID of the event. -
ReportedUsageQuantity: number
Title:
Reported Usage Quantity
The reported usage quantity of the event. -
ReportedUsageUnitOfMeasure: string
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. -
ReverseFlag: boolean
Title:
Reverse
Read Only:true
Maximum Length:1
Indicates whether the event can be reversed or not. -
ServiceId: string
Title:
Service Identifier
Maximum Length:120
The unique identifier of the service identifier. -
SourceInterfaceType: string
Title:
Source Interface Type
Maximum Length:30
The source interface type of the event. -
SubscriptionProductPuid: string
Title:
Subscription Product PUID
Maximum Length:120
The subscription product PUID which is unique for each product. -
UsageBatchId: integer
(int64)
Title:
Batch ID
The identifier of the batch associated with an usage event. -
usageCharges: array
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. -
usageMessages: array
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. -
UsageQuantity: number
Title:
Usage Quantity
The usage quantity of the event. -
UsageUnitOfMeasure: string
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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 : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : subscriptionUsageEventBatches-usageEvents-usageCharges-item-response
Type:
Show Source
object
-
AllowanceAmount: number
Title:
Allowance Amount
The allowance amount of the usage event charge. -
BilledAmount: number
Title:
Amount
The billed amount of the usage event charge. -
ChargeCurrency: string
Title:
Currency
Maximum Length:15
The currency of the usage event charge. -
ChargeDefinition: string
Title:
Charge Definitions
Maximum Length:30
The charge definition associated with the usage event charge. -
ChargeDefinitionId: integer
(int64)
The identifier of the charge definition associated with the usage event charge.
-
ChargeName: string
Title:
Charge Name
Maximum Length:120
The name of the usage event charge. -
ConversionRate: number
Title:
Conversion Rate
A multiplier used for converting a quantity from one unit of measure to another. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the usage event charge. -
CreationDate: string
(date-time)
Read Only:
true
The date when the usage event charge was created. -
EventId: integer
(int64)
Title:
Event Identifier
The unique identifier of the event to which this usage event charge is associated with. -
ExtendedAmount: number
Title:
Extended Amount
The extended amount of the usage event charge. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the usage event charge was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who has last updated the usage event charge. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the usage event charge. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
The object version number updated after every update of an usage event charge.
-
ParentEntity: string
Title:
Reference Object
Maximum Length:30
The parent entity associated with the usage event charge. -
ParentEntityId: integer
(int64)
Title:
Reference Object ID
The unique identifier of the parent entity associated with the usage event charge. -
PricedQuantity: number
Title:
Priced Quantity
The quantity priced for an usage event charge. -
PricedQuantityUnitOfMeasure: string
Title:
Priced Quantity Unit of Measure
Maximum Length:3
The unit of measure of the priced quantity of an usage event charge. -
SequenceNumber: integer
(int32)
Title:
Sequence Number
The sequence number associated with an usage event charge. -
SubscriptionId: integer
(int64)
Title:
Subscription ID
The unique identifier of a subscription to which this usage event change belongs. -
SubscriptionProductId: integer
(int64)
Title:
Subscription Product ID
The PUID of a subscription product to which this usage event charge belongs. -
UsageChargeId: integer
(int64)
The unique identifier of the usage event charge.
-
UsageChargePuid: string
Title:
Usage Charge PUID
Maximum Length:120
The PUID of the usage event charge. -
UserReportedQuantity: number
Title:
User Reported Quantity
The user-reported usage quantity for the event. -
UserReportedUnitOfMeasure: string
Title:
User Reported UOM
Maximum Length:3
The user-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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionUsageEventBatches-usageEvents-usageMessages-item-response
Type:
Show Source
object
-
AdditionalMessageText: string
Title:
Error
Read Only:true
Maximum Length:255
Parameterized error message text. -
BatchId: integer
(int64)
Title:
Batch ID
The identifier of the batch associated with an usage event. -
BatchNumber: string
Title:
Batch Number
Read Only:true
Maximum Length:120
The batch number associated with the usage event message. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the usage event message. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the usage event message was created. -
EventNumber: string
Title:
Event Number
Read Only:true
Maximum Length:120
The event number associated with the usage event message. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the usage event message was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the usage event message. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the usage event message. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageName: string
Title:
Message Name
Maximum Length:30
The name of the usage event message. -
MessageText: string
Title:
Message Text
Maximum Length:2000
The text of the usage event message. -
MessageType: string
Title:
Message Type
Maximum Length:30
The type of the usage event message. -
MessageUserDetails: string
Title:
Message User Details
Read Only:true
Maximum Length:4000
Recommendation based on the message text. -
ObjectVersionNumber: integer
(int32)
Title:
Object Version Number
The object version number updated after every update of an usage event message. -
ParentEntity: string
Title:
Reference Object
Maximum Length:30
The parent entity associated with the usage event message. -
ParentEntityId: integer
(int64)
Title:
Reference Object ID
The unique identifier of the parent entity associated with the usage event message. -
TranslatedMessageText: string
Title:
Error
Read Only:true
Maximum Length:240
The error message text. -
UsageMessageId: integer
(int64)
Title:
Usage Message
The unique identifier of an usage event message.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- CurrencyCodeVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: CurrencyCode; Target Attribute: CurrencyCode
- Display Attribute: Name
- EventRatingTypeVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_EVENTS_RATING_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: EventRatingType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- EventStatusVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_EVENT_STATUS
The following properties are defined on the LOV link relation:- Source Attribute: EventStatus; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- EventTypeVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: EventType; Target Attribute: EventType
- Display Attribute: EventType
- RatingSourceVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_USAGE_RATING_SOURCE
The following properties are defined on the LOV link relation:- Source Attribute: RatingSource; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- SourceInterfaceTypeVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_EVENTS_SOURCE_IF_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: SourceInterfaceType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- SubscriptionProductVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: SubscriptionProductPuid; Target Attribute: SubscriptionProductPuid
- Display Attribute: SubscriptionProductPuid
- TimezoneVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: EventTimeZone; Target Attribute: TimezoneCode
- Display Attribute: TimezoneCode
- UsageEventBatchesVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: BatchNumber; Target Attribute: BatchNumber
- Display Attribute: BatchNumber
- UsageEventErrorKeysVVOVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: Error; Target Attribute: MessageName
- Display Attribute: MessageText
- UsageUomVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: ReportedUsageUnitOfMeasure; Target Attribute: UOMCode
- Display Attribute: UOM
- usageCharges
-
Parameters:
- BatchNumber:
$request.path.BatchNumber
- EventNumber:
$request.path.EventNumber
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. - BatchNumber:
- usageMessages
-
Parameters:
- BatchNumber:
$request.path.BatchNumber
- EventNumber:
$request.path.EventNumber
The usage event messages resource is used to view, create, update, and delete an usage event message. - BatchNumber: