Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

調整の作成

post

/crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/adjustments

リクエスト

パス・パラメータ

ChargePuid(required): string

手数料の公開一意識別子。
SubscriptionProductPuid(required): string

サブスクリプション製品の公開一意識別子。

ヘッダー・パラメータ

Metadata-Context:

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

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
Upsert-Mode:

次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。

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

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)

手数料修正の一意の識別子です。
ChargeAdjustmentPuid: string

最大長: 120

手数料修正の公開一意識別子。
ChargeId: integer (int64)

手数料の一意の識別子。
Effectivity: string

タイトル: Effectivity

最大長: 30

調整の有効性
NumberOfPeriods: number

期間数
ObjectVersionNumber: 整数(int32)

オプティミスティック・ロックの実装に使用される数。この番号は、行を更新するたびに増分されます。この数値は、トランザクションの開始時と終了時に比較され、別のセッションがその行を更新したかどうかが判断されます。
PeriodFrom: number

調整が開始された期間。
PeriodUntil: number

調整が開始されるまでの期間。
Reason: string

タイトル: Reason Description

最大長: 120

修正の理由
SequenceNumber: 整数(int32)

タイトル: Sequence

調整の連番。
SubscriptionId: integer (int64)

サブスクリプションの一意の識別子。
SubscriptionProductId: integer (int64)

サブスクリプション製品の一意の識別子。

{
    "type":"object",
    "properties":{
        "AutoAdjustmentFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Indicates whether the adjustment is automatic or not.",
            "nullable":true
        },
        "ChargeAdjustmentPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the charge adjustment.",
            "nullable":true
        },
        "AdjustmentBasis":{
            "title":"Basis",
            "maxLength":30,
            "type":"string",
            "description":"The basis of the adjustment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChargeAdjustmentId":{
            "type":"integer",
            "description":"The unique identifier of the charge adjustment.",
            "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 reason for the adjustment.",
            "nullable":true
        },
        "AdjustmentType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the adjustment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AdjustmentValue":{
            "title":"Value",
            "type":"number",
            "description":"The value of the adjustment.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The number used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"integer",
            "description":"The sequence number of the adjustment.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "NumberOfPeriods":{
            "type":"number",
            "description":"The number of periods",
            "nullable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The unique identifier of the charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PeriodUntil":{
            "type":"number",
            "description":"The period until which the adjustment is initiated.",
            "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 name of the adjustment.",
            "nullable":true
        },
        "PeriodFrom":{
            "type":"number",
            "description":"The period from which the adjustment was initiated.",
            "nullable":true
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

手数料修正の一意の識別子です。
ChargeAdjustmentPuid: string

最大長: 120

手数料修正の公開一意識別子。
ChargeId: integer (int64)

手数料の一意の識別子。
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)

サブスクリプションの一意の識別子。
SubscriptionProductId: integer (int64)

サブスクリプション製品の一意の識別子。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the adjustment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AutoAdjustmentFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Indicates whether the adjustment is automatic or not.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentBasis":{
            "title":"Basis",
            "maxLength":30,
            "type":"string",
            "description":"The basis of the adjustment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Reason":{
            "title":"Reason Description",
            "maxLength":120,
            "type":"string",
            "description":"The reason for the adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The number used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"integer",
            "description":"The sequence number of the adjustment.",
            "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 unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PeriodUntil":{
            "type":"number",
            "description":"The period until which the adjustment is initiated.",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodFrom":{
            "type":"number",
            "description":"The period from which the adjustment was initiated.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the adjustment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the adjustment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeAdjustmentPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the charge adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeAdjustmentId":{
            "type":"integer",
            "description":"The unique identifier of the charge adjustment.",
            "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 type of the adjustment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentValue":{
            "title":"Value",
            "type":"number",
            "description":"The value of the adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The unique identifier of the charge.",
            "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 name of the adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the adjustment was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the adjustment.",
            "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リソースに対してPOSTリクエストを発行して調整を作成する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/

リクエスト本文の例

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

{
    "ChargeAdjustmentPuid": "GP-5678-PRDT-1-CHRG-9-MADJ-1",
    "AdjustmentType": "ORA_DISCOUNT_AMOUNT",
    "AdjustmentValue": 500,
    "Reason": "Special offer",
    "SequenceNumber": 1,
    "AdjustmentName": "One Time Off",
    "Effectivity": "ORA_ALL_TERM"
}

レスポンス本文の例

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

{
  "ChargeAdjustmentId": 300100192686414,
  "ChargeAdjustmentPuid": "GP-5678-PRDT-1-CHRG-9-MADJ-1",
  "ChargeId": 300100192686413,
  "PeriodFrom": null,
  "PeriodUntil": null,
  "AdjustmentType": "ORA_DISCOUNT_AMOUNT",
  "AdjustmentValue": 500,
  "AdjustmentBasis": null,
  "Reason": "Special offer",
  "SequenceNumber": 1,
  "SubscriptionId": 300100181994494,
  "SubscriptionProductId": 300100192686405,
  "AdjustmentName": "One Time Off",
  "AutoAdjustmentFlag": null,
  "Effectivity": "ORA_ALL_TERM",
  "NumberOfPeriods": null,
  "ObjectVersionNumber": 1,
  "CreatedBy": "SALES_ADMIN",
  "CreationDate": "2019-08-20T08:23:06+00:00",
  "LastUpdateDate": "2019-08-20T08:23:06.306+00:00",
  "LastUpdateLogin": "9062D47DF31EDAF6E0533EFDF40A2696",
  "LastUpdatedBy": "SALES_ADMIN",
  "links":
	...
}

「トップに戻る」