機械翻訳について

ジャンプ先

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

手数料マイルストン・イベントの更新

patch

/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid2}/child/chargeMilestoneEvents/{MilestonePuid}

リクエスト

パス・パラメータ

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

ヘッダー・パラメータ

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

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

• application/json

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

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

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

タイプ: object

ソースを表示

• BillingOffset: number
  マイルストン・イベントに関連付けられた請求オフセット。
• BillLineId: integer (int64)
  マイルストン・イベントに関連付けられた請求明細ID。
• ChargeId: integer (int64)
  マイルストン・イベントが関連付けられている手数料ID。
• ChargePuid: string
  最大長: 120

  デフォルト値: Charges.ChargePuid

  マイルストン・イベントが関連付けられている手数料のPUID。
• CompletionDate: 文字列(日付)
  マイルストン・イベントの完了日。
• EventSource: string
  最大長: 30

  マイルストン・イベントのソース。
• EventSourceReference: string
  最大長: 120

  マイルストン・イベントのソース参照。
• EventType: string
  最大長: 30

  マイルストン・イベントのタイプ。
• ExpectedCompletionDate: 文字列(日付)
  マイルストン・イベントの予定完了日。
• MilestoneComment: string
  最大長: 300

  マイルストン・イベント・コメント。
• MilestoneName: string
  最大長: 30

  マイルストン・イベントの名前。
• MilestonePuid: string
  最大長: 120

  マイルストン・イベントPUID。
• ObjectVersionNumber: 整数(int32)
  マイルストン・イベントのオブジェクト・バージョン番号。
• パーセント: number
  マイルストン・イベントに関連付けられたパーセント。

{
    "type":"object",
    "properties":{
        "BillingOffset":{
            "type":"number",
            "description":"The billing offset associated with a milestone event.",
            "nullable":true
        },
        "ChargePuid":{
            "maxLength":120,
            "type":"string",
            "description":"The PUID of the charge to which the milestone event is associated.",
            "nullable":true,
            "default":"Charges.ChargePuid",
            "x-queryable":false
        },
        "ExpectedCompletionDate":{
            "type":"string",
            "description":"The expected completion date of a milestone event.",
            "format":"date",
            "nullable":true
        },
        "EventType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of the milestone event.",
            "nullable":false
        },
        "Percentage":{
            "type":"number",
            "description":"The percentage associated with a milestone event.",
            "nullable":false,
            "x-hints":{
                "precision":5,
                "scale":2
            }
        },
        "MilestoneName":{
            "maxLength":30,
            "type":"string",
            "description":"The name of the milestone event.",
            "nullable":false
        },
        "MilestoneComment":{
            "maxLength":300,
            "type":"string",
            "description":"The milestone event comment.",
            "nullable":true
        },
        "MilestonePuid":{
            "maxLength":120,
            "type":"string",
            "description":"The milestone event PUID.",
            "nullable":true
        },
        "EventSource":{
            "maxLength":30,
            "type":"string",
            "description":"The source of the milestone event.",
            "nullable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the milestone event.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "EventSourceReference":{
            "maxLength":120,
            "type":"string",
            "description":"The source reference of the milestone event.",
            "nullable":true
        },
        "BillLineId":{
            "type":"integer",
            "description":"The bill line ID associated with the milestone event.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeId":{
            "type":"integer",
            "description":"The charge ID with which the milestone event is associated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CompletionDate":{
            "type":"string",
            "description":"The completion date of the milestone event.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BillingOffset"
                ]
            }
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : subscriptions-products-coveredLevels-charges-chargeMilestoneEvents-item-response

タイプ: object

ソースを表示

• BillingOffset: number
  マイルストン・イベントに関連付けられた請求オフセット。
• BillLineId: integer (int64)
  マイルストン・イベントに関連付けられた請求明細ID。
• ChargeId: integer (int64)
  マイルストン・イベントが関連付けられている手数料ID。
• ChargePuid: string
  最大長: 120

  デフォルト値: Charges.ChargePuid

  マイルストン・イベントが関連付けられている手数料のPUID。
• CompletionDate: 文字列(日付)
  マイルストン・イベントの完了日。
• CreatedBy: string
  読取り専用: true

  最大長: 64

  マイルストン・イベントを作成したログイン。
• CreationDate: string (date-time)
  読取り専用: true

  マイルストン・イベントが作成された日付。
• EventId: integer (int64)
  マイルストン・イベントのID。
• EventSource: string
  最大長: 30

  マイルストン・イベントのソース。
• EventSourceReference: string
  最大長: 120

  マイルストン・イベントのソース参照。
• EventType: string
  最大長: 30

  マイルストン・イベントのタイプ。
• ExpectedCompletionDate: 文字列(日付)
  マイルストン・イベントの予定完了日。
• LastUpdateDate: string (date-time)
  読取り専用: true

  マイルストン・イベントが最後に更新された日付。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  マイルストン・イベントを最後に更新したユーザー。
• LastUpdateLogin: string
  読取り専用: true

  最大長: 32

  マイルストン・イベントを最後に更新したログイン。
• links: array Links
  タイトル: Links

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

  マイルストン・イベント・コメント。
• MilestoneName: string
  最大長: 30

  マイルストン・イベントの名前。
• MilestonePuid: string
  最大長: 120

  マイルストン・イベントPUID。
• ObjectVersionNumber: 整数(int32)
  マイルストン・イベントのオブジェクト・バージョン番号。
• パーセント: number
  マイルストン・イベントに関連付けられたパーセント。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the milestone event the last.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date on which the milestone event was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillingOffset":{
            "type":"number",
            "description":"The billing offset associated with a milestone event.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargePuid":{
            "maxLength":120,
            "type":"string",
            "description":"The PUID of the charge to which the milestone event is associated.",
            "nullable":true,
            "default":"Charges.ChargePuid",
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The login which created the milestone event.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpectedCompletionDate":{
            "type":"string",
            "description":"The expected completion date of a milestone event.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EventType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of the milestone event.",
            "nullable":false,
            "x-queryable":true
        },
        "Percentage":{
            "type":"number",
            "description":"The percentage associated with a milestone event.",
            "nullable":false,
            "x-hints":{
                "precision":5,
                "scale":2
            },
            "x-queryable":true
        },
        "MilestoneName":{
            "maxLength":30,
            "type":"string",
            "description":"The name of the milestone event.",
            "nullable":false,
            "x-queryable":true
        },
        "MilestoneComment":{
            "maxLength":300,
            "type":"string",
            "description":"The milestone event comment.",
            "nullable":true,
            "x-queryable":true
        },
        "MilestonePuid":{
            "maxLength":120,
            "type":"string",
            "description":"The milestone event PUID.",
            "nullable":true,
            "x-queryable":true
        },
        "EventSource":{
            "maxLength":30,
            "type":"string",
            "description":"The source of the milestone event.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the milestone event.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "EventId":{
            "type":"integer",
            "description":"The ID of the milestone event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EventSourceReference":{
            "maxLength":120,
            "type":"string",
            "description":"The source reference of the milestone event.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BillLineId":{
            "type":"integer",
            "description":"The bill line ID associated with the milestone event.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The charge ID with which the milestone event is associated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CompletionDate":{
            "type":"string",
            "description":"The completion date of the milestone event.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BillingOffset"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date of which the milestone event was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login which updated the milestone event the last.",
            "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."
        }
    }
}

「トップに戻る」