機械翻訳について

ジャンプ先

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

残高プロファイル手数料の更新

patch

/crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}/child/profileCharges/{BalanceProfileChargeNumber}

リクエスト

パス・パラメータ

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

ソースを表示

• BalanceProfileId: integer (int64)
  サブスクリプション残高プロファイル手数料の残高プロファイル識別子。
• ChargeDefinitionCode: string
  最大長: 30

  サブスクリプション残高プロファイル手数料の手数料定義コード。
• ChargeDefinitionId: integer (int64)
  タイトル: Charge Name

  サブスクリプション残高プロファイル手数料の残高手数料定義識別子。
• ChargePeriod: string
  タイトル: Periodicity

  最大長: 30

  サブスクリプション残高プロファイル手数料の手数料期間。
• ChargePeriodUnitOfMeasure: string
  タイトル: Periodicity

  最大長: 25

  サブスクリプション残高プロファイル手数料の手数料期間単位。
• ObjectVersionNumber: 整数(int32)
  サブスクリプション・プロファイル料金のすべての更新後に更新されるオブジェクト・バージョン番号。
• QuantityUnitOfMeasure: string
  タイトル: Usage UOM

  最大長: 25

  サブスクリプション残高プロファイル料金の数量単位。
• QuantityUnitOfMeasureCode: string
  タイトル: Usage UOM

  最大長: 3

  サブスクリプション残高プロファイル手数料の数量単位コード。

{
    "type":"object",
    "properties":{
        "BalanceProfileId":{
            "type":"integer",
            "description":"The balance profile identifier of the subscription balance profile charges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of a subscription profile charge.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "ChargeDefinitionId":{
            "title":"Charge Name",
            "type":"integer",
            "description":"The balance charge definition identifier of the subscription balance profile charges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "QuantityUnitOfMeasure":{
            "title":"Usage UOM",
            "maxLength":25,
            "type":"string",
            "description":"The quantity unit of measure of the subscription balance profile charges.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code of the subscription balance profile charges.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChargePeriodUnitOfMeasure":{
            "title":"Periodicity",
            "maxLength":25,
            "type":"string",
            "description":"The charge period unit of measure of the subscription balance profile charges.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ChargePeriod":{
            "title":"Periodicity",
            "maxLength":30,
            "type":"string",
            "description":"The charge period of the subscription balance profile charges.",
            "nullable":true
        },
        "QuantityUnitOfMeasureCode":{
            "title":"Usage UOM",
            "maxLength":3,
            "type":"string",
            "description":"The quantity unit of measure code of the subscription balance profile charges.",
            "nullable":true
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : subscriptionBalanceProfiles-profileCharges-item-response

タイプ: object

ソースを表示

• BalanceProfileChargeId: integer (int64)
  サブスクリプション残高プロファイル手数料の残高プロファイル手数料識別子。
• BalanceProfileChargeNumber: string
  タイトル: Profile Charge Number

  最大長: 120

  サブスクリプション残高プロファイル手数料の残高プロファイル手数料番号。
• BalanceProfileId: integer (int64)
  サブスクリプション残高プロファイル手数料の残高プロファイル識別子。
• ChargeDefinitionCode: string
  最大長: 30

  サブスクリプション残高プロファイル手数料の手数料定義コード。
• ChargeDefinitionId: integer (int64)
  タイトル: Charge Name

  サブスクリプション残高プロファイル手数料の残高手数料定義識別子。
• ChargePeriod: string
  タイトル: Periodicity

  最大長: 30

  サブスクリプション残高プロファイル手数料の手数料期間。
• ChargePeriodUnitOfMeasure: string
  タイトル: Periodicity

  最大長: 25

  サブスクリプション残高プロファイル手数料の手数料期間単位。
• 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

  リソース・インスタンスに関連付けられたリンク関係。
• ObjectVersionNumber: 整数(int32)
  サブスクリプション・プロファイル料金のすべての更新後に更新されるオブジェクト・バージョン番号。
• QuantityUnitOfMeasure: string
  タイトル: Usage UOM

  最大長: 25

  サブスクリプション残高プロファイル料金の数量単位。
• QuantityUnitOfMeasureCode: string
  タイトル: Usage UOM

  最大長: 3

  サブスクリプション残高プロファイル手数料の数量単位コード。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who has last updated the subscription balance criterion.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the subscription balance profile charge was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription balance profile charges.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BalanceProfileChargeId":{
            "type":"integer",
            "description":"The balance profile charge identifier of the subscription balance profile charges.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code of the subscription balance profile charges.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "QuantityUnitOfMeasureCode":{
            "title":"Usage UOM",
            "maxLength":3,
            "type":"string",
            "description":"The quantity unit of measure code of the subscription balance profile charges.",
            "nullable":true,
            "x-queryable":true
        },
        "BalanceProfileChargeNumber":{
            "title":"Profile Charge Number",
            "maxLength":120,
            "type":"string",
            "description":"The balance profile charge number of the subscription balance profile charges.",
            "nullable":false,
            "x-queryable":true
        },
        "BalanceProfileId":{
            "type":"integer",
            "description":"The balance profile identifier of the subscription balance profile charges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of a subscription profile charge.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ChargeDefinitionId":{
            "title":"Charge Name",
            "type":"integer",
            "description":"The balance charge definition identifier of the subscription balance profile charges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QuantityUnitOfMeasure":{
            "title":"Usage UOM",
            "maxLength":25,
            "type":"string",
            "description":"The quantity unit of measure of the subscription balance profile charges.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ChargePeriodUnitOfMeasure":{
            "title":"Periodicity",
            "maxLength":25,
            "type":"string",
            "description":"The charge period unit of measure of the subscription balance profile charges.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ChargePeriod":{
            "title":"Periodicity",
            "maxLength":30,
            "type":"string",
            "description":"The charge period of the subscription balance profile charges.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription profile 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 subscription profile 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."
        }
    }
}

「トップに戻る」