1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Subscription Usage Event Batches
  4. Subscription Usage Events

Get all usage events

get

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

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=
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • EventNumber; string; Finds the usage event that matches the alternate key criteria specified.
      Finder Variables
      • EventNumber; string; The event number associated with the usage event.
    • PrimaryKey Finds the usage events with the specified primary key.
      Finder Variables
      • EventId; integer; The unique identifier of the usage events.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • BatchNumber; string; The number of the batch associated with an usage event.
    • CreatedBy; string; The user who created a usage event.
    • CreationDate; string; The date when a usage event was created.
    • CurrencyCode; string; The currency code associated with the usage event. A list of accepted values is defined in the FND_CURRENCIES_VL view for currency code
    • EventEndTime; string; The date and time when a usage event ends.
    • EventId; integer; The unique identifier of the event.
    • EventNumber; string; The alternate unique identifier of the event.
    • EventStartTime; string; The date and time when usage event starts.
    • EventStatus; string; 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; The usage event time zone.This is the Time Zone of the logged in user.
    • EventType; string; 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; The unique identifier of the event type.
    • LastUpdateDate; string; The date when a usage event was last updated.
    • LastUpdateLogin; string; The login of the user who last updated the usage event.
    • LastUpdatedBy; string; The user who has last updated a usage event.
    • PricedOn; string; The date on which the usage event is priced.
    • RatingSource; string; The rating source of an usage event. This attributes gives information on whether the usage event is rated by subscription management or not.
    • ReportedUsageQuantity; number; The reported usage quantity of the event.
    • ServiceId; string; The unique identifier of the service identifier.
    • SubscriptionProductPuid; string; The subscription product PUID which is unique for each product.
    • UsageBatchId; integer; The identifier of the batch associated with an usage event.
    • UsageQuantity; number; The usage quantity of the event.
    • UsageUnitOfMeasure; string; 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.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.

There's no request body for this operation.

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
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested 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