機械翻訳について

ジャンプ先

• リクエスト
• レスポンス

すべての使用状況イベントの取得

get

/crmRestApi/resources/11.13.18.05/subscriptionUsageEvents

リクエスト

問合せパラメータ

• expand: string
  このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
• fields: string
  このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。
  
  フォーマット : ?fields=Attribute1,Attribute2
  
  子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  コレクションを検索するための事前定義済ファインダとして使用されます。
  
  フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  使用可能なファインダ名および対応するファインダ変数を次に示します:
  
  

  • EventNumber : 指定したイベント番号の使用イベントを検索します。
    ファインダ変数:
    • EventNumber; string;イベントのイベント番号。
  • PrimaryKey : 指定した主キーの使用イベントを検索します。
    ファインダ変数:
    • EventId; integer; イベントの一意の識別子。
• limit: integer
  このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
• links: string
  このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
  
  例:
  self,canonical
  
• offset: integer
  リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
• onlyData: boolean
  リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
• orderBy: string
  このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
• q: string
  この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY
  
  フォーマット : ?q=expression1;expression2
  
  次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
  

  • BatchNumber; string;使用イベントに関連付けられたバッチの番号。
  • CreatedBy; string; レコードを作成したユーザー。
  • CreationDate; string;レコードが作成された日付。
  • CurrencyCode; string; イベントに関連付けられた通貨コード。
  • EventEndTime; string; イベントが終了する時間。
  • EventId; integer;使用イベントの一意の識別子。
  • EventNumber; string;使用イベント番号(PUID)。
  • EventStartTime; string; イベントが開始される時間。
  • EventStatus; string;使用イベントのステータス。
  • EventTimeZone; string;使用イベント時間zone.Thisは、ログインしているユーザーのタイムゾーンです。
  • EventType; string;使用イベント・タイプ。
  • LastUpdateDate; string; レコードが最後に更新された日付。
  • LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン。
  • LastUpdatedBy; string; レコードを最後に更新したユーザー。
  • PricedOn; string;使用イベントが価格設定される日付。
  • RatingSource; string;使用イベントの評価ソース。 この属性は、使用イベントがサブスクリプション管理によって評価されるかどうかに関する情報を提供します。
  • ServiceId; string;サービス識別子の一意の識別子。
  • SubscriptionProductPuid; string; 製品ごとに一意のサブスクリプション製品PUID。
  • UsageBatchId; integer; 使用イベントに関連付けられたバッチの識別子。
  • UsageQuantity; number;イベントの使用量。
  • UsageUnitOfMeasure; string;使用量の単位。
• totalResults: boolean
  "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

サポートされるメディア・タイプ

• application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

• Metadata-Context(required):
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

本文( )

ルート・スキーマ : subscriptionUsageEvents

タイプ: object

ソースを表示

• count(required): integer
  現在の範囲で返されたリソース・インスタンスの数。
• hasMore(required): boolean
  サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。 値がtrueの場合、サーバーから取得するリソースがさらにあります。 デフォルト値はfalseです。
• items: array Items
  タイトル: Items

  コレクション内のアイテム。
• limit(required): integer
  サーバーで使用される実際のページング・サイズ。
• links(required): array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• offset(required): integer
  現在のページで使用されるオフセット値。
• totalResults: integer
  "?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/subscriptionUsageEvents-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

ネストされたスキーマ : アイテム

タイプ: array

タイトル: Items

コレクション内のアイテム。

ソースを表示

• Array of: object subscriptionUsageEvents-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/subscriptionUsageEvents-item-response"
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

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

ネストされたスキーマ : subscriptionUsageEvents-item-response

タイプ: object

ソースを表示

• BatchNumber: string
  最大長: 120

  使用イベントに関連付けられたバッチの番号。
• CorpCurrencyCode: string
  最大長: 15

  企業通貨コード。
• CreatedBy: string
  読取り専用: true

  最大長: 64

  レコードを作成したユーザー。
• CreationDate: string (date-time)
  読取り専用: true

  レコードが作成された日付。
• CurcyConvRateType: string
  最大長: 30

  通貨換算レート・タイプ。
• CurrencyCode: string
  最大長: 15

  イベントに関連付けられた通貨コード。
• EventEndTime: string (date-time)
  タイトル: Event End Time

  イベントが終了する時間。
• EventId: integer (int64)
  タイトル: Event Identifier

  使用イベントの一意の識別子。
• EventNumber: string
  タイトル: Event Number

  最大長: 120

  使用イベント番号(PUID)。
• EventStartTime: string (date-time)
  タイトル: Event Start Time

  イベントが開始する時間。
• EventStatus: string
  タイトル: Event Status

  最大長: 30

  使用イベント・ステータス。
• EventTimeZone: string
  最大長: 50

  使用イベント時間zone.Thisは、ログイン・ユーザーのタイム・ゾーンです。
• EventType: string
  タイトル: Event Type

  最大長: 30

  使用イベント・タイプ。
• LastUpdateDate: string (date-time)
  読取り専用: true

  レコードが最後に更新された日付。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  レコードを最後に更新したユーザー。
• LastUpdateLogin: string
  読取り専用: true

  最大長: 32

  レコードを最後に更新したユーザーのログイン。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• PricedOn: string (date-time)
  使用イベントが価格設定される日付。
• RatingSource: string
  最大長: 30

  使用イベントの評点ソース。 この属性は、使用イベントがサブスクリプション管理によって評価されるかどうかに関する情報を提供します。
• ServiceId: string
  タイトル: Service Identifier

  最大長: 120

  サービス識別子の一意の識別子。
• SubscriptionProductPuid: string
  最大長: 120

  製品ごとに一意のサブスクリプション製品PUID。
• UsageBatchId: integer (int64)
  使用イベントに関連付けられたバッチの識別子。
• usageCharges: array Subscription Usage Event Charges
  タイトル: Subscription Usage Event Charges

  使用イベント料金リソースは、使用イベント料金の表示、作成、更新および削除に使用されます。 サブスクリプション製品に関連付けられた使用イベント料金の詳細を提供します。
• usageMessages: array Subscription Usage Event Messages
  タイトル: Subscription Usage Event Messages

  使用イベント・メッセージ・リソースは、使用イベント・メッセージの表示、作成、更新および削除に使用されます。
• UsageQuantity: number
  タイトル: Usage Quantity

  イベントの消費済使用。
• UsageUnitOfMeasure: string
  タイトル: Usage UOM Code

  最大長: 3

  使用の単位。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":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
        },
        "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"
            }
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

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

ネストされたスキーマ : サブスクリプション使用イベント料金

タイプ: array

タイトル: Subscription Usage Event Charges

使用イベント料金リソースは、使用イベント料金の表示、作成、更新および削除に使用されます。 サブスクリプション製品に関連付けられた使用イベント料金の詳細を提供します。

ソースを表示

• 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"
    }
}

ネストされたスキーマ : サブスクリプション使用イベント・メッセージ

タイプ: array

タイトル: Subscription Usage Event Messages

使用イベント・メッセージ・リソースは、使用イベント・メッセージの表示、作成、更新および削除に使用されます。

ソースを表示

• 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"
    }
}

ネストされたスキーマ : リンク

タイプ: object

ソースを表示

• href: string
  タイトル: hyperlink reference

  関連リソースへのURI。
• kind: string
  タイトル: kind

  許可された値: [ "collection", "item", "describe", "other" ]

  関連リソースの種類。
• name: string
  タイトル: name

  関連リソースへのリンクの名前。
• properties: object properties
• rel: string
  タイトル: relation

  許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  リソース・インスタンスとの関係の名前。 例: 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."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

• changeIndicator: string
  リソース・インスタンスのインジケータまたはETag値を変更します。

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

ネストされたスキーマ : subscriptionUsageEvents-usageCharges-item-response

タイプ: object

ソースを表示

• ChargeCurrency: string
  最大長: 15

  使用イベント手数料の通貨。
• ChargeDefinition: string
  最大長: 30

  使用イベント手数料に関連付けられた手数料定義。
• ChargeDefinitionId: integer (int64)
  使用イベント手数料に関連付けられた手数料定義の識別子。
• ChargeName: string
  最大長: 120

  使用イベント手数料の名前。
• CreatedBy: string
  読取り専用: true

  最大長: 64

  使用イベント料金を作成したユーザー。
• CreationDate: string (date-time)
  読取り専用: true

  使用イベント料金が作成された日付。
• EventId: integer (int64)
  この使用イベント料金が関連付けられているイベントの一意の識別子。
• ExtendedAmount: number
  使用イベント料金の拡張金額。
• LastUpdateDate: string (date-time)
  読取り専用: true

  使用イベント料金が最後に更新された日付。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  使用イベント料金を最後に更新したユーザー。
• LastUpdateLogin: string
  読取り専用: true

  最大長: 32

  使用イベント料金を最後に更新したユーザーのログイン。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• ObjectVersionNumber: 整数(int32)
  使用イベント手数料のすべての更新後に更新されるオブジェクト・バージョン番号。
• ParentEntity: string
  最大長: 30

  使用イベント手数料に関連付けられた親エンティティ。
• ParentEntityId: integer (int64)
  使用イベント手数料に関連付けられた親エンティティの一意の識別子。
• PricedQuantity: number
  使用イベント手数料に対して価格設定された数量。
• PricedQuantityUnitOfMeasure: string
  最大長: 3

  使用イベント手数料の価格設定済数量の単位。
• SequenceNumber: 整数(int32)
  使用イベント手数料に関連付けられた連番。
• SubscriptionId: integer (int64)
  この使用イベント変更が属するサブスクリプションの一意の識別子。
• SubscriptionProductId: integer (int64)
  この使用イベント料金が属するサブスクリプション製品のPUID。
• UsageChargeId: integer (int64)
  使用イベント手数料の一意の識別子。
• UsageChargePuid: string
  最大長: 120

  使用イベント手数料のPUID。

{
    "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
        },
        "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
        },
        "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
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

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

ネストされたスキーマ : subscriptionUsageEvents-usageMessages-item-response

タイプ: object

ソースを表示

• CreatedBy: string
  読取り専用: true

  最大長: 64

  使用イベント・メッセージを作成したユーザー。
• CreationDate: string (date-time)
  読取り専用: true

  使用イベント・メッセージが作成された日付。
• LastUpdateDate: string (date-time)
  読取り専用: true

  使用イベント・メッセージが最後に更新された日付。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  使用イベント・メッセージを最後に更新したユーザー。
• LastUpdateLogin: string
  読取り専用: true

  最大長: 32

  使用イベント・メッセージを最後に更新したユーザーのログイン。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• MessageName: string
  最大長: 30

  使用イベント・メッセージの名前。
• MessageText: string
  最大長: 2000

  使用イベント・メッセージのテキスト。
• MessageType: string
  最大長: 30

  使用イベント・メッセージのタイプ。
• ObjectVersionNumber: 整数(int32)
  使用イベント・メッセージのすべての更新後に更新されるオブジェクト・バージョン番号。
• ParentEntity: string
  最大長: 30

  使用イベント・メッセージに関連付けられた親エンティティ。
• ParentEntityId: integer (int64)
  使用イベント・メッセージに関連付けられた親エンティティの一意の識別子。
• UsageMessageId: integer (int64)
  使用イベント・メッセージの一意の識別子。

{
    "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
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

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

「トップに戻る」