Jump to

• Request
• Response

Update a usage event

patch

/crmRestApi/resources/11.13.18.05/subscriptionUsageEvents/{EventNumber}

Request

Path Parameters

• EventNumber(required): string
  The usage event number (PUID).

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CorpCurrencyCode: string
  Maximum Length: 15

  The corporate currency code.
• 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.
• 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.
• PricedOn: string (date-time)
  The date on which the usage event is priced.
• 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.
• 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.

{
    "type":"object",
    "properties":{
        "EventStartTime":{
            "title":"Event Start Time",
            "type":"string",
            "description":"The time when the event starts.",
            "format":"date-time",
            "nullable":false
        },
        "ReportedUsageQuantity":{
            "type":"number",
            "description":"The reported usage quantity of the event.",
            "nullable":true
        },
        "EventType":{
            "title":"Event Type",
            "maxLength":"30",
            "type":"string",
            "description":"The usage event type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SubscriptionProductPuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The subscription product PUID which is unique for each product.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EventStatus":{
            "title":"Event Status",
            "maxLength":"30",
            "type":"string",
            "description":"The usage event status.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EventTypeId":{
            "type":"integer",
            "description":"The unique identifier of the event type.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "UsageQuantity":{
            "title":"Usage Quantity",
            "type":"number",
            "description":"The consumed usage of the event.",
            "nullable":true
        },
        "PricedOn":{
            "type":"string",
            "description":"The date on which the usage event is priced.",
            "format":"date-time",
            "nullable":true
        },
        "CurcyConvRateType":{
            "maxLength":"30",
            "type":"string",
            "description":"The currency conversion rate type.",
            "nullable":true,
            "x-queryable":false
        },
        "ServiceId":{
            "title":"Service Identifier",
            "maxLength":"120",
            "type":"string",
            "description":"The unique identifier of the service identifier.",
            "nullable":true
        },
        "EventEndTime":{
            "title":"Event End Time",
            "type":"string",
            "description":"The time when the event ends.",
            "format":"date-time",
            "nullable":true
        },
        "CurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The currency code associated with the event.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UsageUnitOfMeasure":{
            "title":"Usage UOM Code",
            "maxLength":"3",
            "type":"string",
            "description":"The unit of measure of the usage.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EventTimeZone":{
            "maxLength":"50",
            "type":"string",
            "description":"The usage event time zone.This is the Time Zone of the logged in user.",
            "nullable":true,
            "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/subscriptionUsageEvents-usageCharges-item-patch-request"
            }
        },
        "CorpCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code.",
            "nullable":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/subscriptionUsageEvents-usageMessages-item-patch-request"
            }
        }
    }
}

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 subscriptionUsageEvents-usageCharges-item-patch-request

{
    "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/subscriptionUsageEvents-usageCharges-item-patch-request"
    }
}

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 subscriptionUsageEvents-usageMessages-item-patch-request

{
    "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/subscriptionUsageEvents-usageMessages-item-patch-request"
    }
}

Nested Schema : subscriptionUsageEvents-usageCharges-item-patch-request

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "ParentEntityId":{
            "type":"integer",
            "description":"The unique identifier of the parent entity associated with the usage event charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ChargeCurrency":{
            "maxLength":"15",
            "type":"string",
            "description":"The currency of the usage event charge.",
            "nullable":true
        },
        "ChargeDefinition":{
            "maxLength":"30",
            "type":"string",
            "description":"The charge definition associated with the usage event charge.",
            "nullable":true
        },
        "BilledAmount":{
            "type":"number",
            "description":"The billed amount of the usage event charge.",
            "nullable":true
        },
        "ChargeName":{
            "maxLength":"120",
            "type":"string",
            "description":"The name of the usage event charge.",
            "nullable":true
        },
        "PricedQuantity":{
            "type":"number",
            "description":"The quantity priced for an usage event charge.",
            "nullable":true
        },
        "ExtendedAmount":{
            "type":"number",
            "description":"The extended amount of the usage event charge.",
            "nullable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of a subscription to which this usage event change belongs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "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"
            }
        },
        "ChargeDefinitionId":{
            "type":"integer",
            "description":"The identifier of the charge definition associated with the usage event charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"The sequence number associated with an usage event charge.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            }
        },
        "AllowanceAmount":{
            "type":"number",
            "description":"The allowance amount of the usage event charge.",
            "nullable":true
        },
        "EventId":{
            "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"
            }
        },
        "ParentEntity":{
            "maxLength":"30",
            "type":"string",
            "description":"The parent entity associated with the usage event charge.",
            "nullable":true
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The PUID of a subscription product to which this usage event charge belongs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "PricedQuantityUnitOfMeasure":{
            "maxLength":"3",
            "type":"string",
            "description":"The unit of measure of the priced quantity of an usage event charge.",
            "nullable":true
        }
    }
}

Nested Schema : subscriptionUsageEvents-usageMessages-item-patch-request

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "ParentEntityId":{
            "type":"integer",
            "description":"The unique identifier of the parent entity associated with the usage event message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of an usage event message.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "UsageMessageId":{
            "type":"integer",
            "description":"The unique identifier of an usage event message.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ParentEntity":{
            "maxLength":"30",
            "type":"string",
            "description":"The parent entity associated with the usage event message.",
            "nullable":true
        },
        "MessageText":{
            "maxLength":"2000",
            "type":"string",
            "description":"The text of the usage event message.",
            "nullable":true
        },
        "MessageName":{
            "maxLength":"30",
            "type":"string",
            "description":"The name of the usage event message.",
            "nullable":true
        },
        "MessageType":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of the usage event message.",
            "nullable":true
        }
    }
}

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 : subscriptionUsageEvents-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReportedUsageQuantity":{
            "type":"number",
            "description":"The reported usage quantity of the event.",
            "nullable":true,
            "x-queryable":true
        },
        "EventType":{
            "title":"Event Type",
            "maxLength":"30",
            "type":"string",
            "description":"The usage event type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RatingSource":{
            "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-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EventStatus":{
            "title":"Event Status",
            "maxLength":"30",
            "type":"string",
            "description":"The 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-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "maxLength":"30",
            "type":"string",
            "description":"The currency conversion rate type.",
            "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 time when the event ends.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The currency code associated with the event.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UsageUnitOfMeasure":{
            "title":"Usage UOM Code",
            "maxLength":"3",
            "type":"string",
            "description":"The unit of measure of the usage.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EventId":{
            "title":"Event Identifier",
            "type":"integer",
            "description":"The unique identifier of the usage event.",
            "format":"int64",
            "nullable":false,
            "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"
            }
        },
        "CorpCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EventStartTime":{
            "title":"Event Start Time",
            "type":"string",
            "description":"The time when the event starts.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "BatchNumber":{
            "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":{
            "maxLength":"120",
            "type":"string",
            "description":"The subscription product PUID which is unique for each product.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UsageQuantity":{
            "title":"Usage Quantity",
            "type":"number",
            "description":"The consumed usage of the event.",
            "nullable":true,
            "x-queryable":true
        },
        "PricedOn":{
            "type":"string",
            "description":"The date on which the usage event is priced.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "UsageBatchId":{
            "type":"integer",
            "description":"The identifier of the batch associated with an usage event.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EventNumber":{
            "title":"Event Number",
            "maxLength":"120",
            "type":"string",
            "description":"The usage event number (PUID).",
            "nullable":false,
            "x-queryable":true
        },
        "EventTimeZone":{
            "maxLength":"50",
            "type":"string",
            "description":"The usage event time zone.This is the Time Zone of the logged in user.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "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/subscriptionUsageEvents-usageCharges-item-response"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record 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 record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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/subscriptionUsageEvents-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 subscriptionUsageEvents-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/subscriptionUsageEvents-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 subscriptionUsageEvents-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/subscriptionUsageEvents-usageMessages-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 : subscriptionUsageEvents-usageCharges-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who has last updated the usage event charge.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the usage event charge was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentEntityId":{
            "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":{
            "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
        },
        "ChargeDefinition":{
            "maxLength":"30",
            "type":"string",
            "description":"The charge definition associated with the usage event charge.",
            "nullable":true,
            "x-queryable":true
        },
        "BilledAmount":{
            "type":"number",
            "description":"The billed amount of the usage event charge.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeName":{
            "maxLength":"120",
            "type":"string",
            "description":"The name of the usage event charge.",
            "nullable":true,
            "x-queryable":true
        },
        "PricedQuantity":{
            "type":"number",
            "description":"The quantity priced for an usage event charge.",
            "nullable":true,
            "x-queryable":true
        },
        "ExtendedAmount":{
            "type":"number",
            "description":"The extended amount of the usage event charge.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "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
        },
        "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
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"The sequence number associated with an usage event charge.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "AllowanceAmount":{
            "type":"number",
            "description":"The allowance amount of the usage event charge.",
            "nullable":true,
            "x-queryable":true
        },
        "UsageChargePuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The PUID of the usage event charge.",
            "nullable":false,
            "x-queryable":true
        },
        "EventId":{
            "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"
            }
        },
        "ParentEntity":{
            "maxLength":"30",
            "type":"string",
            "description":"The parent entity associated with the usage event charge.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionProductId":{
            "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":{
            "maxLength":"3",
            "type":"string",
            "description":"The unit of measure of the priced quantity of an 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 : subscriptionUsageEvents-usageMessages-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the usage event message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the usage event message was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentEntityId":{
            "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":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the usage event message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UsageMessageId":{
            "type":"integer",
            "description":"The unique identifier of an usage event message.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MessageText":{
            "maxLength":"2000",
            "type":"string",
            "description":"The text of the usage event message.",
            "nullable":true,
            "x-queryable":true
        },
        "MessageName":{
            "maxLength":"30",
            "type":"string",
            "description":"The name of the usage event message.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "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":{
            "maxLength":"30",
            "type":"string",
            "description":"The parent entity associated with the usage event message.",
            "nullable":true,
            "x-queryable":true
        },
        "MessageType":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of the usage event message.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the usage event message 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 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

CurrencyCodeVA

Operation: /crmRestApi/resources/11.13.18.05/ratedCurrencies

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

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

EventTypeVA

Operation: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventTypes

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

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

SubscriptionProductVA

Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts

The following properties are defined on the LOV link relation:

• Source Attribute: SubscriptionProductPuid; Target Attribute: SubscriptionProductPuid
• Display Attribute: SubscriptionProductPuid

TimezoneVA

Operation: /fscmRestApi/resources/11.13.18.05/timezonesLOV

The following properties are defined on the LOV link relation:

• Source Attribute: EventTimeZone; Target Attribute: TimezoneCode
• Display Attribute: TimezoneCode

UsageEventBatchesVA

Operation: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventBatches

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/usageCharges

Parameters:

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

usageMessages

Operation: /crmRestApi/resources/11.13.18.05/subscriptionUsageEvents/{EventNumber}/child/usageMessages

Parameters:

• EventNumber: $request.path.EventNumber

The usage event messages resource is used to view, create, update, and delete an usage event message.

Back to Top