Jump to

• Request
• Response

Get an usage event batch

get

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

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=

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: 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.

There's no request body for this operation.

Back to Top

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.

Body ()

Root Schema : subscriptionUsageEventBatches-item-response

Type: object

Show Source

• BatchDescription: string
  Title: Batch Description

  Maximum Length: 2000

  The description of the batch.
• BatchNumber: string
  Title: Batch Number

  Maximum Length: 120

  The number of the usage event batch.
• BatchStatus: string
  Title: Batch Status

  Maximum Length: 30

  The status of the usage event batch.
• BusinessUnitId: integer (int64)
  Title: Business Unit

  Business unit identifier associated with the batch.
• CountOfUsageEvents: integer
  Title: Total Events

  Number of usage events in the batch.
• CountOfUsageEventsErrored: integer
  Title: Total Events with Errors

  Number of usage events in the batch which have errors.
• CountOfUsageEventsInprocess: integer
  Title: Total Events in Process

  Number of usage events in the batch which are in process.
• CountOfUsageEventsProcessed: integer
  Title: Total Processed Events

  Number of usage events in the batch which are processed.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created an usage event batch.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when an usage event batch was created.
• CriteriaJson: string (byte)
  Title: Criteria JSON

  The criteria JSON of usage event batch.
• DistinctErrorsCount: integer
  Title: Error Count

  The count of distinct errors for a usage event batch.
• ErrorCount: integer
  Title: Error Count

  The count of the errors that occurred maximum number of times for a usage event batch.
• IncludeReversalEventFlag: boolean
  Title: Include reversal events

  Maximum Length: 1

  Indicates if rerating should also include reversal events.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when an usage event batch was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated an usage event batch.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the usage event batch.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OwnerResourceId: integer (int64)
  Title: Owner Resource Party ID

  The party identifier of the user who created the batch.
• PricerType: string
  Title: Pricer Type

  Read Only: true

  Maximum Length: 30

  The price type used for rating.
• ProcessedDate: string (date)
  Title: Processed Date

  The processed date when the batch was processed.
• ruleBuilderConditions: array Rule Builder Conditions
  Title: Rule Builder Conditions

  The rule builder condition is a filter used to query the usage events for rerating purpose.
• TrueupFlag: boolean
  Title: True-up Flag

  Read Only: true

  Maximum Length: 1

  Indicates if the batch can be used for creating usage events for the true-up process.
• UsageBatchId: integer (int64)
  Title: Batch ID

  The unique identifier of the usage event batch.
• usageEventBatchErrors: array Subscription Usage Event Errors
  Title: Subscription Usage Event Errors

  The usage event errors is used to view the distinct error messages for a batch. This resource displays all the distinct usage event errors created for a specific batch of a business unit.
• usageEvents: array Subscription Usage Events
  Title: Subscription Usage Events

  The usage events resource is used to view, create, update, and delete an usage event. It provides details of subscription usage event information.
• UsageEventsErrors: string
  Title: Error

  Maximum Length: 255

  List of values indicating the attribute which shows all the event errors associated with the batch.
• UsageType: string
  Title: Usage Type

  Maximum Length: 30

  The usage type of usage event batch.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when an usage event batch was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "usageEventBatchErrors":{
            "title":"Subscription Usage Event Errors",
            "type":"array",
            "description":"The usage event errors is used to view the distinct error messages for a batch. This resource displays all the distinct usage event errors created for a specific batch of a business unit.",
            "items":{
                "$ref":"#/components/schemas/subscriptionUsageEventBatches-usageEventBatchErrors-item-response"
            }
        },
        "ErrorCount":{
            "title":"Error Count",
            "type":"integer",
            "description":"The count of the errors that occurred maximum number of times for a usage event batch.",
            "nullable":true,
            "x-queryable":false
        },
        "UsageType":{
            "title":"Usage Type",
            "maxLength":30,
            "type":"string",
            "description":"The usage type of usage event batch.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_FK_WHEREATTR_ADDL":"LookupType",
                "controlType":"choice",
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.fnd.applcore.lookups.model.publicView.LookupPVO",
                "fnd:FND_AUDIT_VALUE_ADDL":"'ORA_OSS_BATCH_USAGE_TYPE'",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"Meaning",
                "fnd:FND_AUDIT_FK_WHEREATTR":"LookupCode"
            },
            "x-queryable":true
        },
        "ProcessedDate":{
            "title":"Processed Date",
            "type":"string",
            "description":"The processed date when the batch was processed.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "TrueupFlag":{
            "title":"True-up Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the batch can be used for creating usage events for the true-up process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "IncludeReversalEventFlag":{
            "title":"Include reversal events",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if rerating should also include reversal events.",
            "nullable":true,
            "x-queryable":true
        },
        "usageEvents":{
            "title":"Subscription Usage Events",
            "type":"array",
            "description":"The usage events resource is used to view, create, update, and delete an usage event. It provides details of subscription usage event information.",
            "items":{
                "$ref":"#/components/schemas/subscriptionUsageEventBatches-usageEvents-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PricerType":{
            "title":"Pricer Type",
            "maxLength":30,
            "type":"string",
            "description":"The price type used for rating.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerResourceId":{
            "title":"Owner Resource Party ID",
            "type":"integer",
            "description":"The party identifier of the user who created the batch.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CountOfUsageEventsProcessed":{
            "title":"Total Processed Events",
            "type":"integer",
            "description":"Number of usage events in the batch which are processed.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "ISBLANK"
                ]
            },
            "x-queryable":true
        },
        "CountOfUsageEventsInprocess":{
            "title":"Total Events in Process",
            "type":"integer",
            "description":"Number of usage events in the batch which are in process.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "ISBLANK"
                ]
            },
            "x-queryable":true
        },
        "UsageEventsErrors":{
            "title":"Error",
            "maxLength":255,
            "type":"string",
            "description":"List of values indicating the attribute which shows all the event errors associated with the batch.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>"
                ]
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated an usage event batch.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CountOfUsageEvents":{
            "title":"Total Events",
            "type":"integer",
            "description":"Number of usage events in the batch.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "ISBLANK"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created an usage event batch.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BatchNumber":{
            "title":"Batch Number",
            "maxLength":120,
            "type":"string",
            "description":"The number of the usage event batch.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>"
                ]
            },
            "x-queryable":true
        },
        "BusinessUnitId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"Business unit identifier associated with the batch.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>"
                ],
                "precision":18
            },
            "x-queryable":true
        },
        "UsageBatchId":{
            "title":"Batch ID",
            "type":"integer",
            "description":"The unique identifier of the usage event batch.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "=",
                    "<",
                    "<=",
                    ">",
                    ">="
                ],
                "precision":18
            },
            "x-queryable":true
        },
        "CountOfUsageEventsErrored":{
            "title":"Total Events with Errors",
            "type":"integer",
            "description":"Number of usage events in the batch which have errors.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "ISBLANK"
                ]
            },
            "x-queryable":true
        },
        "ruleBuilderConditions":{
            "title":"Rule Builder Conditions",
            "type":"array",
            "description":"The rule builder condition is a filter used to query the usage events for rerating purpose.",
            "items":{
                "$ref":"#/components/schemas/subscriptionUsageEventBatches-ruleBuilderConditions-item-response"
            }
        },
        "BatchDescription":{
            "title":"Batch Description",
            "maxLength":2000,
            "type":"string",
            "description":"The description of the batch.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "BatchStatus":{
            "title":"Batch Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the usage event batch.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK"
                ]
            },
            "x-queryable":true
        },
        "DistinctErrorsCount":{
            "title":"Error Count",
            "type":"integer",
            "description":"The count of distinct errors for a usage event batch.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "=",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN"
                ]
            },
            "x-queryable":true
        },
        "CriteriaJson":{
            "title":"Criteria JSON",
            "type":"string",
            "description":"The criteria JSON of usage event batch.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when an usage event batch was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the usage event batch.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Rule Builder Conditions

Type: array

Title: Rule Builder Conditions

The rule builder condition is a filter used to query the usage events for rerating purpose.

Show Source

• Array of: object subscriptionUsageEventBatches-ruleBuilderConditions-item-response

{
    "title":"Rule Builder Conditions",
    "type":"array",
    "description":"The rule builder condition is a filter used to query the usage events for rerating purpose.",
    "items":{
        "$ref":"#/components/schemas/subscriptionUsageEventBatches-ruleBuilderConditions-item-response"
    }
}

Nested Schema : Subscription Usage Event Errors

Type: array

Title: Subscription Usage Event Errors

The usage event errors is used to view the distinct error messages for a batch. This resource displays all the distinct usage event errors created for a specific batch of a business unit.

Show Source

• Array of: object subscriptionUsageEventBatches-usageEventBatchErrors-item-response

{
    "title":"Subscription Usage Event Errors",
    "type":"array",
    "description":"The usage event errors is used to view the distinct error messages for a batch. This resource displays all the distinct usage event errors created for a specific batch of a business unit.",
    "items":{
        "$ref":"#/components/schemas/subscriptionUsageEventBatches-usageEventBatchErrors-item-response"
    }
}

Nested Schema : Subscription Usage Events

Type: array

Title: Subscription Usage Events

The usage events resource is used to view, create, update, and delete an usage event. It provides details of subscription usage event information.

Show Source

• Array of: object subscriptionUsageEventBatches-usageEvents-item-response

{
    "title":"Subscription Usage Events",
    "type":"array",
    "description":"The usage events resource is used to view, create, update, and delete an usage event. It provides details of subscription usage event information.",
    "items":{
        "$ref":"#/components/schemas/subscriptionUsageEventBatches-usageEvents-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : subscriptionUsageEventBatches-ruleBuilderConditions-item-response

Type: object

Show Source

• ConditionGroupName: string
  Title: Condition Group Name

  Maximum Length: 30

  The condition group name of rule builder condition.
• ConditionGroupType: string
  Title: Condition Group Type

  Maximum Length: 30

  The condition group type of rule builder condition.
• ConditionId: integer (int64)
  Title: Condition ID

  The condition identifier of rule builder condition.
• ConditionJson: string (byte)
  Title: Condition JSON

  The condition JSON of rule builder condition.
• ConditionNumber: string
  Title: Condition

  Maximum Length: 120

  The condition number of rule builder condition.
• ConditionRestQParam: string (byte)
  The query parameter expression of the rule builder condition.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created a rule builder condition.
• CreationDate: string (date-time)
  Read Only: true

  The date when a rule builder condition was created.
• DisplaySequence: integer (int64)
  Title: Display Sequence

  The display sequence of rule builder condition.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when a rule builder condition was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated a rule builder condition.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the rule builder condition.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  The object version number updated after every update of a rule builder condition.
• QualifiedRestObjectName: string
  Title: Qualified Rest Object Name

  Maximum Length: 120

  The qualified REST object name of rule builder condition.
• ReferenceEntityId: integer (int64)
  Title: Object ID

  The unique identifier for the reference entity associated with the rule builder condition.
• ReferenceEntityName: string
  Title: Reference Entity Name

  Maximum Length: 30

  Default Value: OSS_USAGE_EVENT_BATCHES

  The name of the reference entity name associated with the rule builder condition.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated a rule builder condition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when a rule builder condition was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConditionGroupName":{
            "title":"Condition Group Name",
            "maxLength":30,
            "type":"string",
            "description":"The condition group name of rule builder condition.",
            "nullable":true,
            "x-queryable":true
        },
        "ReferenceEntityId":{
            "title":"Object ID",
            "type":"integer",
            "description":"The unique identifier for the reference entity associated with the rule builder condition.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created a rule builder condition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The display sequence of rule builder condition.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ConditionJson":{
            "title":"Condition JSON",
            "type":"string",
            "description":"The condition JSON of rule builder condition.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ConditionRestQParam":{
            "type":"string",
            "description":"The query parameter expression of the rule builder condition.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "ReferenceEntityName":{
            "title":"Reference Entity Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the reference entity name associated with the rule builder condition.",
            "nullable":true,
            "default":"OSS_USAGE_EVENT_BATCHES",
            "x-queryable":true
        },
        "ConditionGroupType":{
            "title":"Condition Group Type",
            "maxLength":30,
            "type":"string",
            "description":"The condition group type of rule builder condition.",
            "nullable":true,
            "x-queryable":true
        },
        "QualifiedRestObjectName":{
            "title":"Qualified Rest Object Name",
            "maxLength":120,
            "type":"string",
            "description":"The qualified REST object name of rule builder condition.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of a rule builder condition.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ConditionNumber":{
            "title":"Condition",
            "maxLength":120,
            "type":"string",
            "description":"The condition number of rule builder condition.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ConditionId":{
            "title":"Condition ID",
            "type":"integer",
            "description":"The condition identifier of rule builder condition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when a rule builder condition was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the rule builder condition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionUsageEventBatches-usageEventBatchErrors-item-response

Type: object

Show Source

• BatchId: integer (int64)
  Title: Batch ID

  The unique batch identifier of the specific usage event batch.
• BatchNumber: string
  Title: Batch

  Maximum Length: 120

  The batch number of the specific usage event batch.
• CountOfErroredEvents: integer
  Title: Events with Errors

  Count of events having errors in the batch.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created a usage event batch error.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when a usage event batch error was created.
• EventBatchErrorId: integer (int64)
  The unique identifier of usage event batch error.
• EventBatchErrorNumber: string
  Title: Event Batch Error Number

  Maximum Length: 120

  The alternate unique identifier of usage event batch error.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when an usage event batch error was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who has last updated a usage event batch error.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageName: string
  Title: Message Name

  Maximum Length: 30

  The message name for the usage event batch error.
• MessageText: string
  Title: Error

  Read Only: true

  Maximum Length: 240

  The message text for the usage event batch error.
• MessageUserDetails: string
  Title: Recommendation

  Read Only: true

  Maximum Length: 4000

  Recommendation based on the message text.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who has last updated a usage event batch error.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CountOfErroredEvents":{
            "title":"Events with Errors",
            "type":"integer",
            "description":"Count of events having errors in the batch.",
            "nullable":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when a usage event batch error was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created a usage event batch error.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "BatchNumber":{
            "title":"Batch",
            "maxLength":120,
            "type":"string",
            "description":"The batch number of the specific usage event batch.",
            "nullable":false,
            "x-queryable":true
        },
        "BatchId":{
            "title":"Batch ID",
            "type":"integer",
            "description":"The unique batch identifier of the specific usage event batch.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MessageUserDetails":{
            "title":"Recommendation",
            "maxLength":4000,
            "type":"string",
            "description":"Recommendation based on the message text.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageText":{
            "title":"Error",
            "maxLength":240,
            "type":"string",
            "description":"The message text for the usage event batch error.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "MessageName":{
            "title":"Message Name",
            "maxLength":30,
            "type":"string",
            "description":"The message name for the usage event batch error.",
            "nullable":true,
            "x-queryable":true
        },
        "EventBatchErrorNumber":{
            "title":"Event Batch Error Number",
            "maxLength":120,
            "type":"string",
            "description":"The alternate unique identifier of usage event batch error.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EventBatchErrorId":{
            "type":"integer",
            "description":"The unique identifier of usage event batch error.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when an usage event batch error was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionUsageEventBatches-usageEvents-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when a usage event was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LeEventStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The legal entity date when usage event starts.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ReportedUsageQuantity":{
            "title":"Reported Usage Quantity",
            "type":"number",
            "description":"The reported usage quantity of the event.",
            "nullable":true,
            "x-queryable":false
        },
        "EventType":{
            "title":"Event Type",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RatingSource":{
            "title":"Rating Source",
            "maxLength":30,
            "type":"string",
            "description":"The rating source of an usage event. This attributes gives information on whether the usage event is rated by subscription management or not.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ReportedUsageUnitOfMeasure":{
            "title":"Reported UOM",
            "maxLength":3,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FileName":{
            "title":"File Name",
            "maxLength":300,
            "type":"string",
            "description":"The file name of the event.",
            "nullable":true,
            "x-queryable":false
        },
        "EventStatus":{
            "title":"Event Status",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EventTypeId":{
            "type":"integer",
            "description":"The unique identifier of the event type.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SourceInterfaceType":{
            "title":"Source Interface Type",
            "maxLength":30,
            "type":"string",
            "description":"The source interface type of the event.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CurcyConvRateType":{
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type associated with the usage event.",
            "nullable":true,
            "x-queryable":false
        },
        "ServiceId":{
            "title":"Service Identifier",
            "maxLength":120,
            "type":"string",
            "description":"The unique identifier of the service identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "EventEndTime":{
            "title":"Event End Time",
            "type":"string",
            "description":"The date and time when a usage event ends.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the usage event. A list of accepted values is defined in the FND_CURRENCIES_VL view for currency code",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UsageUnitOfMeasure":{
            "title":"Usage UOM",
            "maxLength":3,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EventId":{
            "title":"Event Identifier",
            "type":"integer",
            "description":"The unique identifier of the event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "=",
                    "<",
                    "<=",
                    ">",
                    ">="
                ],
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CorpCurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code associated with the usage event.",
            "nullable":true,
            "x-queryable":false
        },
        "ReverseFlag":{
            "title":"Reverse",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the event can be reversed or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who has last updated a usage event.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created a usage event.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EventStartTime":{
            "title":"Event Start Time",
            "type":"string",
            "description":"The date and time when usage event starts.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "BatchNumber":{
            "title":"Batch Number",
            "maxLength":120,
            "type":"string",
            "description":"The number of the batch associated with an usage event.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SubscriptionProductPuid":{
            "title":"Subscription Product PUID",
            "maxLength":120,
            "type":"string",
            "description":"The subscription product PUID which is unique for each product.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EventRatingType":{
            "title":"Event Rating Type",
            "maxLength":30,
            "type":"string",
            "description":"The event rating type of an event.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UsageQuantity":{
            "title":"Usage Quantity",
            "type":"number",
            "description":"The usage quantity of the event.",
            "nullable":true,
            "x-queryable":false
        },
        "PricedOn":{
            "title":"Priced on Date",
            "type":"string",
            "description":"The date on which the usage event is priced.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "Error":{
            "title":"Error",
            "maxLength":255,
            "type":"string",
            "description":"The error message text for the usage event.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>"
                ]
            },
            "x-queryable":true
        },
        "UsageBatchId":{
            "title":"Batch ID",
            "type":"integer",
            "description":"The identifier of the batch associated with an usage event.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RelatedBatchId":{
            "title":"Related Batch ID",
            "type":"integer",
            "description":"The related batch ID of the event.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EventNumber":{
            "title":"Event Number",
            "maxLength":120,
            "type":"string",
            "description":"The alternate unique identifier of the event.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>"
                ]
            },
            "x-queryable":true
        },
        "RelatedEventId":{
            "title":"Related Event ID",
            "type":"integer",
            "description":"The related event ID of the event.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EventTimeZone":{
            "title":"Event End Time",
            "maxLength":50,
            "type":"string",
            "description":"The usage event time zone.This is the Time Zone of the logged in user.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "usageCharges":{
            "title":"Subscription Usage Event Charges",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionUsageEventBatches-usageEvents-usageCharges-item-response"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when a usage event was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the usage event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "usageMessages":{
            "title":"Subscription Usage Event Messages",
            "type":"array",
            "description":"The usage event messages resource is used to view, create, update, and delete an usage event message.",
            "items":{
                "$ref":"#/components/schemas/subscriptionUsageEventBatches-usageEvents-usageMessages-item-response"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object subscriptionUsageEventBatches-usageEvents-usageCharges-item-response

{
    "title":"Subscription Usage Event Charges",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionUsageEventBatches-usageEvents-usageCharges-item-response"
    }
}

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

• Array of: object subscriptionUsageEventBatches-usageEvents-usageMessages-item-response

{
    "title":"Subscription Usage Event Messages",
    "type":"array",
    "description":"The usage event messages resource is used to view, create, update, and delete an usage event message.",
    "items":{
        "$ref":"#/components/schemas/subscriptionUsageEventBatches-usageEvents-usageMessages-item-response"
    }
}

Nested Schema : subscriptionUsageEventBatches-usageEvents-usageCharges-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the usage event charge was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UserReportedQuantity":{
            "title":"User Reported Quantity",
            "type":"number",
            "description":"The user-reported usage quantity for the event.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargeDefinition":{
            "title":"Charge Definitions",
            "maxLength":30,
            "type":"string",
            "description":"The charge definition associated with the usage event charge.",
            "nullable":true,
            "x-queryable":true
        },
        "ExtendedAmount":{
            "title":"Extended Amount",
            "type":"number",
            "description":"The extended amount of the usage event charge.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "title":"Subscription ID",
            "type":"integer",
            "description":"The unique identifier of a subscription to which this usage event change belongs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of an usage event charge.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence Number",
            "type":"integer",
            "description":"The sequence number associated with an usage event charge.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "AllowanceAmount":{
            "title":"Allowance Amount",
            "type":"number",
            "description":"The allowance amount of the usage event charge.",
            "nullable":true,
            "x-queryable":true
        },
        "EventId":{
            "title":"Event Identifier",
            "type":"integer",
            "description":"The unique identifier of the event to which this usage event charge is associated with.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscriptionProductId":{
            "title":"Subscription Product ID",
            "type":"integer",
            "description":"The PUID of a subscription product to which this usage event charge belongs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PricedQuantityUnitOfMeasure":{
            "title":"Priced Quantity Unit of Measure",
            "maxLength":3,
            "type":"string",
            "description":"The unit of measure of the priced quantity of an usage event charge.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who has last updated the usage event charge.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentEntityId":{
            "title":"Reference Object ID",
            "type":"integer",
            "description":"The unique identifier of the parent entity associated with the usage event charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the usage event charge.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeCurrency":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency of the usage event charge.",
            "nullable":true,
            "x-queryable":true
        },
        "UsageChargeId":{
            "type":"integer",
            "description":"The unique identifier of the usage event charge.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BilledAmount":{
            "title":"Amount",
            "type":"number",
            "description":"The billed amount of the usage event charge.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeName":{
            "title":"Charge Name",
            "maxLength":120,
            "type":"string",
            "description":"The name of the usage event charge.",
            "nullable":true,
            "x-queryable":true
        },
        "PricedQuantity":{
            "title":"Priced Quantity",
            "type":"number",
            "description":"The quantity priced for an usage event charge.",
            "nullable":true,
            "x-queryable":true
        },
        "UserReportedUnitOfMeasure":{
            "title":"User Reported UOM",
            "maxLength":3,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "ConversionRate":{
            "title":"Conversion Rate",
            "type":"number",
            "description":"A multiplier used for converting a quantity from one unit of measure to another.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargeDefinitionId":{
            "type":"integer",
            "description":"The identifier of the charge definition associated with the usage event charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UsageChargePuid":{
            "title":"Usage Charge PUID",
            "maxLength":120,
            "type":"string",
            "description":"The PUID of the usage event charge.",
            "nullable":false,
            "x-queryable":true
        },
        "ParentEntity":{
            "title":"Reference Object",
            "maxLength":30,
            "type":"string",
            "description":"The parent entity associated with the usage event charge.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the usage event charge was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the usage event charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionUsageEventBatches-usageEvents-usageMessages-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the usage event message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the usage event message was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentEntityId":{
            "title":"Reference Object ID",
            "type":"integer",
            "description":"The unique identifier of the parent entity associated with the usage event message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the usage event message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BatchNumber":{
            "title":"Batch Number",
            "maxLength":120,
            "type":"string",
            "description":"The batch number associated with the usage event message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BatchId":{
            "title":"Batch ID",
            "type":"integer",
            "description":"The identifier of the batch associated with an usage event.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MessageUserDetails":{
            "title":"Message User Details",
            "maxLength":4000,
            "type":"string",
            "description":"Recommendation based on the message text.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalMessageText":{
            "title":"Error",
            "maxLength":255,
            "type":"string",
            "description":"Parameterized error message text.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UsageMessageId":{
            "title":"Usage Message",
            "type":"integer",
            "description":"The unique identifier of an usage event message.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MessageText":{
            "title":"Message Text",
            "maxLength":2000,
            "type":"string",
            "description":"The text of the usage event message.",
            "nullable":true,
            "x-queryable":true
        },
        "TranslatedMessageText":{
            "title":"Error",
            "maxLength":240,
            "type":"string",
            "description":"The error message text.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageName":{
            "title":"Message Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the usage event message.",
            "nullable":true,
            "x-queryable":true
        },
        "EventNumber":{
            "title":"Event Number",
            "maxLength":120,
            "type":"string",
            "description":"The event number associated with the usage event message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The object version number updated after every update of an usage event message.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParentEntity":{
            "title":"Reference Object",
            "maxLength":30,
            "type":"string",
            "description":"The parent entity associated with the usage event message.",
            "nullable":true,
            "x-queryable":true
        },
        "MessageType":{
            "title":"Message Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the usage event message.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the usage event message was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the usage event message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

BatchStatusVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_USAGE_BATCH_STATUS

The following properties are defined on the LOV link relation:

• Source Attribute: BatchStatus; Target Attribute: LookupCode
• Display Attribute: LookupCode

BusinessUnitLOVVOVA

Operation: /crmRestApi/resources/11.13.18.05/crmBusinessUnits

The following properties are defined on the LOV link relation:

• Source Attribute: BusinessUnitId; Target Attribute: BusinessUnitId
• Display Attribute: Name

UsageBatchErrorMessagesVVOVA

Operation: /crmRestApi/resources/11.13.18.05/usageBatchErrors

The following properties are defined on the LOV link relation:

• Source Attribute: UsageEventsErrors; Target Attribute: MessageName
• Display Attribute: MessageText

UsageTypeVA

Operation: /crmRestApi/resources/11.13.18.05/contactRoles

Parameters:

• finder: LookupTypeAndCodeIsEnabledFinderForUsageType

The following properties are defined on the LOV link relation:

• Source Attribute: UsageType; Target Attribute: LookupCode
• Display Attribute: Meaning

ruleBuilderConditions

Operation: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventBatches/{BatchNumber}/child/ruleBuilderConditions

Parameters:

• BatchNumber: $request.path.BatchNumber

The rule builder condition is a filter used to query the usage events for rerating purpose.

usageEventBatchErrors

Operation: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventBatches/{BatchNumber}/child/usageEventBatchErrors

Parameters:

• BatchNumber: $request.path.BatchNumber

The usage event errors is used to view the distinct error messages for a batch. This resource displays all the distinct usage event errors created for a specific batch of a business unit.

usageEvents

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

Parameters:

• BatchNumber: $request.path.BatchNumber

The usage events resource is used to view, create, update, and delete an usage event. It provides details of subscription usage event information.

Back to Top