機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 標準補償内容
  4. 修正

すべての調整の取得

get

/crmRestApi/resources/11.13.18.05/subscriptionCoverageHeaders/{CoverageHeaderPuid}/child/CoverageChargeDiscounts

リクエスト

パス・パラメータ
  • このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: products?q=InventoryItemId=
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2

    フォーマット: <attr1>=<val1>,<attr2>=<value2>
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

    フォーマット : ?fields=Attribute1,Attribute2

    子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    使用可能なファインダ名および対応するファインダ変数を次に示します

    • PrimaryKey指定した主キー基準に一致する調整を検索します。
      ファインダ変数
      • ChargeDiscountId; integer;調整の一意の識別子。
    • PuidAltKey指定した代替キーで調整を検索します。
      ファインダ変数
      • CoverageDiscountPuid; string;調整PUIDの一意の識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
  • このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
  • この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY

    フォーマット : ?q=expression1;expression2

    次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • AdjustmentAmount; number;調整タイプに入力された金額。
    • AdjustmentTypeCode; string;調整タイプ参照の一意のコード。 有効な値は、割引率または値入れ率です。 受け入れられる値のリストは、参照タイプORA_QP_LINE_ADJ_TYPESで定義されます。
    • AdjustmentTypeMeaning; string;調整タイプ参照の表示値。 代替有効値には、割引率または値入れ率が含まれます。 受け入れられる値のリストは、参照タイプORA_QP_LINE_ADJ_TYPESで定義されます。
    • AllowCustomAdjustmentsFlag; boolean;カスタム調整が許可されるかどうかを示します。 デフォルト値はTrueです。
    • AllowPricingDiscountsFlag; boolean;価格設定割引が許可されるかどうかを示します。 デフォルト値は「False」です。
    • BillingTypeCode; string;請求タイプ参照の一意のコード。 受け入れられる値のリストは、請求タイプ・コードの参照タイプEGP_MATERIAL_BILLABLE_TYPEで定義されます。 「設定およびメンテナンス」作業領域および「サービス・ロジスティクス参照の管理」タスクを使用して、値リストをレビューおよび更新します。
    • BillingTypeMeaning; string;請求タイプ参照コードの表示値。 受け入れられる値のリストは、参照タイプEGP_MATERIAL_BILLABLE_TYPEに請求タイプの意味のために定義されます。 「設定およびメンテナンス」作業領域および「サービス・ロジスティクス参照の管理」タスクを使用して、値リストをレビューおよび更新します。
    • BusinessProcessCode; string;ビジネス・プロセス・タイプ参照の一意のコード。 受け入れられる値のリストは、ビジネス・プロセス・コードの参照タイプORA_RCL_BUSINESS_PROCESSで定義されます。 「設定およびメンテナンス」作業領域および「サービス・ロジスティクス参照の管理」タスクを使用して、値リストをレビューおよび更新します。
    • BusinessProcessMeaning; string;ビジネス・プロセス・タイプ参照の表示値。 受け入れられる値のリストは、ビジネス・プロセスの意味を示す参照タイプORA_RCL_BUSINESS_PROCESSで定義されます。 「設定およびメンテナンス」作業領域および「サービス・ロジスティクス参照の管理」タスクを使用して、値リストをレビューおよび更新します。
    • ChargeDiscountId; integer;調整の一意の識別子。
    • CoverageDiscountPuid; string; 調整を一意に識別する値。
    • CoverageHeaderId; integer;調整に対する親カバレッジ・ヘッダーの一意の識別子。
    • CreatedBy; string; 調整を作成したユーザー。
    • CreationDate; string;調整が作成された日付。
    • EndDate; string;カバレッジ調整が終了する日付。
    • LastUpdateDate; string; 調整が最後に更新された日付。
    • LastUpdateLogin; string; 調整を最後に更新したユーザーの名前。
    • LastUpdatedBy; string; 調整を最後に更新したユーザー。
    • PricingBasisId; integer;価格設定基準の一意の識別子。 受け入れられる値のリストは、価格設定基準IDのビューqp_pricing_basis_vlで定義されます。
    • PricingBasisName; string;価格設定基準の名前。 受け入れられる値のリストは、価格設定基準名のビューqp_pricing_basis_vlで定義されます。
    • PricingTermId; integer;価格設定条件の一意の識別子。
    • ServiceActivityId; integer;サービス・アクティビティの一意の識別子。 受け入れられる値のリストは、サービス・アクティビティIDのビューRCL_SERVICE_ACTIVITIES_VLで定義されます。
    • StartDate; string;調整が開始される日付。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : subscriptionCoverageHeaders-CoverageChargeDiscounts
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : subscriptionCoverageHeaders-CoverageChargeDiscounts-item-response
タイプ: object
ソースを表示
  • タイトル: Value
    調整タイプに入力された金額。
  • 最大長: 30
    調整タイプ参照の一意のコード。 有効な値は、割引率または値入れ率です。 受け入れられる値のリストは、参照タイプORA_QP_LINE_ADJ_TYPESで定義されます。
  • タイトル: Adjustment Type
    調整タイプ参照の表示値。 代替有効値には、割引率または値入れ率が含まれます。 受け入れられる値のリストは、参照タイプORA_QP_LINE_ADJ_TYPESで定義されます。
  • タイトル: Allow custom adjustments
    最大長: 1
    カスタム調整が許可されるかどうかを示します。 デフォルト値はTrueです。
  • タイトル: Allow pricing discounts
    最大長: 1
    価格設定割引が許可されるかどうかを示します。 デフォルト値は「False」です。
  • 最大長: 30
    請求タイプ参照の一意のコード。 受け入れられる値のリストは、請求タイプ・コードの参照タイプEGP_MATERIAL_BILLABLE_TYPEで定義されます。 「設定およびメンテナンス」作業領域および「サービス・ロジスティクス参照の管理」タスクを使用して、値リストをレビューおよび更新します。
  • タイトル: Billing Type
    請求タイプ参照コードの表示値。 受け入れられる値のリストは、参照タイプEGP_MATERIAL_BILLABLE_TYPEに請求タイプの意味のために定義されます。 「設定およびメンテナンス」作業領域および「サービス・ロジスティクス参照の管理」タスクを使用して、値リストをレビューおよび更新します。
  • 最大長: 30
    ビジネス・プロセス・タイプ参照の一意のコード。 受け入れられる値のリストは、ビジネス・プロセス・コードの参照タイプORA_RCL_BUSINESS_PROCESSで定義されます。 「設定およびメンテナンス」作業領域および「サービス・ロジスティクス参照の管理」タスクを使用して、値リストをレビューおよび更新します。
  • タイトル: Business Process
    ビジネス・プロセス・タイプ参照の表示値。 受け入れられる値のリストは、ビジネス・プロセスの意味を示す参照タイプORA_RCL_BUSINESS_PROCESSで定義されます。 「設定およびメンテナンス」作業領域および「サービス・ロジスティクス参照の管理」タスクを使用して、値リストをレビューおよび更新します。
  • 調整の一意の識別子。
  • 最大長: 120
    調整を一意に識別する値。
  • 調整に対する親カバレッジ・ヘッダーの一意の識別子。
  • 読取り専用: true
    最大長: 64
    調整を作成したユーザー。
  • 読取り専用: true
    調整が作成された日付。
  • タイトル: End Date
    カバレッジ調整が終了する日付。
  • 読取り専用: true
    調整が最後に更新された日付。
  • 読取り専用: true
    最大長: 64
    調整を最後に更新したユーザー。
  • 読取り専用: true
    最大長: 32
    調整を最後に更新したユーザーの名前。
  • Links
  • 価格設定基準の一意の識別子。 受け入れられる値のリストは、価格設定基準IDのビューqp_pricing_basis_vlで定義されます。
  • タイトル: Adjustment Basis
    価格設定基準の名前。 受け入れられる値のリストは、価格設定基準名のビューqp_pricing_basis_vlで定義されます。
  • 価格設定条件の一意の識別子。
  • サービス・アクティビティの一意の識別子。 受け入れられる値のリストは、サービス・アクティビティIDのビューRCL_SERVICE_ACTIVITIES_VLで定義されます。
  • タイトル: Service Activity
    最大長: 80
    サービス活動の名前。 受け入れられる値のリストは、サービス・アクティビティ名のビューRCL_SERVICE_ACTIVITIES_VLで定義されます。
  • タイトル: Start Date
    調整が開始する日付。
「トップに戻る」