Get a usage event
get
/crmRestApi/resources/11.13.18.05/subscriptionUsageEvents/{EventNumber}
Request
Path Parameters
-
EventNumber(required): string
The usage event number (PUID).
Query Parameters
-
dependency: string
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> -
expand: string
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).
-
fields: string
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 -
links: string
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
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.
There's no request body for this operation.
Back to TopResponse
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 : subscriptionUsageEvents-item-response
Type:
Show Source
object
-
BatchNumber: string
Maximum Length:
120
The number of the batch associated with an usage event. -
CorpCurrencyCode: string
Maximum Length:
15
The corporate currency code. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
CurcyConvRateType: string
Maximum Length:
30
The currency conversion rate type. -
CurrencyCode: string
Maximum Length:
15
The currency code associated with the event. -
EventEndTime: string
(date-time)
Title:
Event End Time
The time when the event ends. -
EventId: integer
(int64)
Title:
Event Identifier
The unique identifier of the usage event. -
EventNumber: string
Title:
Event Number
Maximum Length:120
The usage event number (PUID). -
EventStartTime: string
(date-time)
Title:
Event Start Time
The time when the event starts. -
EventStatus: string
Title:
Event Status
Maximum Length:30
The usage event status. -
EventTimeZone: string
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 type. -
EventTypeId: integer
(int64)
The unique identifier of the event type.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PricedOn: string
(date-time)
The date on which the usage event is priced.
-
RatingSource: string
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. -
ReportedUsageQuantity: number
The reported usage quantity of the event.
-
ServiceId: string
Title:
Service Identifier
Maximum Length:120
The unique identifier of the service identifier. -
SubscriptionProductPuid: string
Maximum Length:
120
The subscription product PUID which is unique for each product. -
UsageBatchId: integer
(int64)
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 consumed usage of the event. -
UsageUnitOfMeasure: string
Title:
Usage UOM Code
Maximum Length:3
The unit of measure of the usage.
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 : subscriptionUsageEvents-usageCharges-item-response
Type:
Show Source
object
-
AllowanceAmount: number
The allowance amount of the usage event charge.
-
BilledAmount: number
The billed amount of the usage event charge.
-
ChargeCurrency: string
Maximum Length:
15
The currency of the usage event charge. -
ChargeDefinition: string
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
Maximum Length:
120
The name of the usage event charge. -
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)
The unique identifier of the event to which this usage event charge is associated with.
-
ExtendedAmount: number
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
Maximum Length:
30
The parent entity associated with the usage event charge. -
ParentEntityId: integer
(int64)
The unique identifier of the parent entity associated with the usage event charge.
-
PricedQuantity: number
The quantity priced for an usage event charge.
-
PricedQuantityUnitOfMeasure: string
Maximum Length:
3
The unit of measure of the priced quantity of an usage event charge. -
SequenceNumber: integer
(int32)
The sequence number associated with an usage event charge.
-
SubscriptionId: integer
(int64)
The unique identifier of a subscription to which this usage event change belongs.
-
SubscriptionProductId: integer
(int64)
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
Maximum Length:
120
The PUID of the usage event charge.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionUsageEvents-usageMessages-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the usage event message. -
CreationDate: string
(date-time)
Read Only:
true
The date when the usage event message was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the usage event message was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the usage event message. -
LastUpdateLogin: string
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
Maximum Length:
30
The name of the usage event message. -
MessageText: string
Maximum Length:
2000
The text of the usage event message. -
MessageType: string
Maximum Length:
30
The type of the usage event message. -
ObjectVersionNumber: integer
(int32)
The object version number updated after every update of an usage event message.
-
ParentEntity: string
Maximum Length:
30
The parent entity associated with the usage event message. -
ParentEntityId: integer
(int64)
The unique identifier of the parent entity associated with the usage event message.
-
UsageMessageId: integer
(int64)
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 list of values indicating the currency code for the notes associated to the usage event such as USD, CAD, or EUR.
The following properties are defined on the LOV link relation:- Source Attribute: CurrencyCode; Target Attribute: CurrencyCode
- Display Attribute: Name
- EventStatusVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_EVENT_STATUS
The list of values indicating the status of usage events.
The following properties are defined on the LOV link relation:- Source Attribute: EventStatus; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- EventTypeVA
-
The list of values indicating the types of usage events.
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: LookupCode
- 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, UsageBatchId
- UsageUomVA
-
The list of values to indicate the usage unit of measure for the usage quantity associated to the usage event such as Ea, FT, and GAL.
The following properties are defined on the LOV link relation:- Source Attribute: UsageUnitOfMeasure; Target Attribute: UOMCode
- Display Attribute: UOM
- usageCharges
-
Operation: /crmRestApi/resources/11.13.18.05/subscriptionUsageEvents/{EventNumber}/child/usageChargesParameters:
- 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. - EventNumber:
- usageMessages
-
Operation: /crmRestApi/resources/11.13.18.05/subscriptionUsageEvents/{EventNumber}/child/usageMessagesParameters:
- EventNumber:
$request.path.EventNumber
The usage event messages resource is used to view, create, update, and delete an usage event message. - EventNumber: