機械翻訳について

ジャンプ先

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

サブスクリプション調整の更新

patch

/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid2}/child/adjustments/{ChargeAdjustmentPuid}

リクエスト

パス・パラメータ

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

ソースを表示

• AdjustmentBasis: string
  タイトル: Basis

  最大長: 30

  修正基準
• AdjustmentName: string
  タイトル: Adjustment

  最大長: 120

  調整名
• AdjustmentReasonCode: string
  タイトル: Reason

  最大長: 30

  調整事由のコード。
• AdjustmentReasonMeaning: string
  タイトル: Reason

  換算済修正事由。
• AdjustmentType: string
  タイトル: Type

  最大長: 30

  調整タイプ
• AdjustmentValue: number
  タイトル: Value

  調整値
• AutoAdjustmentFlag: boolean
  最大長: 3

  調整が自動かどうかを示すフラグ
• ChargeAdjustmentId: integer (int64)
  手数料修正ID
• ChargeAdjustmentPuid: string
  最大長: 120

  手数料調整PUID
• ChargeId: integer (int64)
  手数料ID
• Effectivity: string
  タイトル: Effectivity

  最大長: 30

  調整の有効性
• NumberOfPeriods: number
  期間数
• ObjectVersionNumber: 整数(int32)
  オブジェクト・バージョン番号
• PeriodFrom: number
  期間:自
• PeriodUntil: number
  期間:至
• Reason: string
  タイトル: Reason Description

  最大長: 120

  調整事由
• SequenceNumber: 整数(int32)
  タイトル: Sequence

  連番
• SubscriptionId: integer (int64)
  サブスクリプションID
• SubscriptionProductId: integer (int64)
  サブスクリプション製品ID

{
    "type":"object",
    "properties":{
        "AutoAdjustmentFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Flag indicating whether the adjustment is automatic or not",
            "nullable":true
        },
        "ChargeAdjustmentPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The charge adjustment PUID",
            "nullable":true
        },
        "AdjustmentBasis":{
            "title":"Basis",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment basis",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChargeAdjustmentId":{
            "type":"integer",
            "description":"The charge adjustment ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AdjustmentReasonCode":{
            "title":"Reason",
            "maxLength":30,
            "type":"string",
            "description":"The code of the adjustment reason.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Effectivity":{
            "title":"Effectivity",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment effectivity",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Reason":{
            "title":"Reason Description",
            "maxLength":120,
            "type":"string",
            "description":"The adjustment reason",
            "nullable":true
        },
        "AdjustmentType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment type",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The subscription ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AdjustmentValue":{
            "title":"Value",
            "type":"number",
            "description":"The adjustment value",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object version number",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"integer",
            "description":"The sequence number",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "NumberOfPeriods":{
            "type":"number",
            "description":"The number of periods",
            "nullable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The charge ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The subscription product ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PeriodUntil":{
            "type":"number",
            "description":"The period until",
            "nullable":true
        },
        "AdjustmentReasonMeaning":{
            "title":"Reason",
            "type":"string",
            "description":"The translated adjustment reason.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "AdjustmentName":{
            "title":"Adjustment",
            "maxLength":120,
            "type":"string",
            "description":"The adjustment name",
            "nullable":true
        },
        "PeriodFrom":{
            "type":"number",
            "description":"The period from",
            "nullable":true
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

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

タイプ: object

ソースを表示

• AdjustmentBasis: string
  タイトル: Basis

  最大長: 30

  修正基準
• AdjustmentName: string
  タイトル: Adjustment

  最大長: 120

  調整名
• AdjustmentReasonCode: string
  タイトル: Reason

  最大長: 30

  調整事由のコード。
• AdjustmentReasonMeaning: string
  タイトル: Reason

  換算済修正事由。
• AdjustmentType: string
  タイトル: Type

  最大長: 30

  調整タイプ
• AdjustmentValue: number
  タイトル: Value

  調整値
• AutoAdjustmentFlag: boolean
  最大長: 3

  調整が自動かどうかを示すフラグ
• ChargeAdjustmentId: integer (int64)
  手数料修正ID
• ChargeAdjustmentPuid: string
  最大長: 120

  手数料調整PUID
• ChargeId: integer (int64)
  手数料ID
• CreatedBy: string
  読取り専用: true

  最大長: 64

  作成者
• CreationDate: string (date-time)
  読取り専用: true

  作成日
• Effectivity: string
  タイトル: Effectivity

  最大長: 30

  調整の有効性
• LastUpdateDate: string (date-time)
  読取り専用: true

  最終更新日
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  最終更新者
• LastUpdateLogin: string
  読取り専用: true

  最大長: 32

  最終更新ログイン
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• NumberOfPeriods: number
  期間数
• ObjectVersionNumber: 整数(int32)
  オブジェクト・バージョン番号
• PeriodFrom: number
  期間:自
• PeriodUntil: number
  期間:至
• Reason: string
  タイトル: Reason Description

  最大長: 120

  調整事由
• SequenceNumber: 整数(int32)
  タイトル: Sequence

  連番
• SubscriptionId: integer (int64)
  サブスクリプションID
• SubscriptionProductId: integer (int64)
  サブスクリプション製品ID

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The creation date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AutoAdjustmentFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Flag indicating whether the adjustment is automatic or not",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentBasis":{
            "title":"Basis",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment basis",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Reason":{
            "title":"Reason Description",
            "maxLength":120,
            "type":"string",
            "description":"The adjustment reason",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The subscription ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object version number",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"integer",
            "description":"The sequence number",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "NumberOfPeriods":{
            "type":"number",
            "description":"The number of periods",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The subscription product ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PeriodUntil":{
            "type":"number",
            "description":"The period until",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodFrom":{
            "type":"number",
            "description":"The period from",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The last updated by",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The created by",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeAdjustmentPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The charge adjustment PUID",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeAdjustmentId":{
            "type":"integer",
            "description":"The charge adjustment ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AdjustmentReasonCode":{
            "title":"Reason",
            "maxLength":30,
            "type":"string",
            "description":"The code of the adjustment reason.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Effectivity":{
            "title":"Effectivity",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment effectivity",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment type",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentValue":{
            "title":"Value",
            "type":"number",
            "description":"The adjustment value",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The charge ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AdjustmentReasonMeaning":{
            "title":"Reason",
            "type":"string",
            "description":"The translated adjustment reason.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "AdjustmentName":{
            "title":"Adjustment",
            "maxLength":120,
            "type":"string",
            "description":"The adjustment name",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The last update date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The last update login",
            "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."
        }
    }
}

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対してPATCHリクエストを発行することによって、サブスクリプション調整を更新する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptions/GP-5678/child/products/GP-5678-PRDT-1/child/coveredLevels/GP-7788-PRDT-13-PASS-5/child/charges/GP-5678-PRDT-1-CHRG-9/child/adjustments/GP-5678-PRDT-1-CHRG-9-MADJ-1

リクエスト本文の例

次の例は、JSON形式のリクエスト本文のコンテンツを示しています。

{
    "AdjustmentValue": 600
}

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
    "ChargeAdjustmentId": 300100177242432,
    "ChargeAdjustmentPuid": "GP-5678-PRDT-1-CHRG-9-MADJ-1",
    "ChargeId": 300100177231506,
    "PeriodFrom": null,
    "PeriodUntil": null,
    "AdjustmentType": "ORA_DISCOUNT_AMOUNT",
    "AdjustmentValue": 600,
    "AdjustmentBasis": null,
    "Reason": "Special offer",
    "SequenceNumber": 1,
    "SubscriptionId": 300100177254423,
    "SubscriptionProductId": 300100177254429,
    "AdjustmentName": "One Time Off",
    "AutoAdjustmentFlag": null,
    "Effectivity": "ORA_ALL_TERM",
    "NumberOfPeriods": null,
    "ObjectVersionNumber": 1,
    "CreatedBy": "CONMGR",
    "CreationDate": "2019-06-04T14:06:49+00:00",
    "LastUpdateDate": "2019-06-04T14:06:49.706+00:00",
    "LastUpdateLogin": "8A5689BEEA6839CBE05322EAF40A0656",
    "LastUpdatedBy": "CONMGR",
    ...
}

「トップに戻る」