機械翻訳について

ジャンプ先

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

使用イベント料金の更新

patch

/crmRestApi/resources/11.13.18.05/subscriptionUsageEvents/{EventNumber}/child/usageCharges/{UsageChargePuid}

リクエスト

パス・パラメータ

• EventNumber(required): string
  使用イベント番号(PUID)。
• UsageChargePuid(required): string
  このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: products?q=InventoryItemId=

ヘッダー・パラメータ

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

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

• application/json

リクエスト本文 - application/json ()

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

• ChargeCurrency: string
  最大長: 15

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

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

  使用イベント手数料の名前。
• EventId: integer (int64)
  この使用イベント料金が関連付けられているイベントの一意の識別子。
• ExtendedAmount: number
  使用イベント料金の拡張金額。
• ObjectVersionNumber: 整数(int32)
  使用イベント手数料のすべての更新後に更新されるオブジェクト・バージョン番号。
• ParentEntity: string
  最大長: 30

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

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

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

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : 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"
    }
}

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

タイプ: 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."
        }
    }
}

「トップに戻る」