機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. パートナ・プログラム
  4. プログラム・ベネフィット詳細

パートナ・プログラムのすべてのプログラム特典を取得

get

/crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/ProgramBenefitDetails

リクエスト

パス・パラメータ
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: 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
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

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

    • PrimaryKey : プログラム特典詳細IDを使用して、パートナ・プログラム内のプログラム階層特典の詳細を検索します。
      ファインダ変数:
      • ProgramBenefitDetailId; integer; システム生成の一意の識別子およびプログラム層の主キーの利点。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • BenefitListValue; string; プログラム特典の値タイプが「List」の場合、プログラム層の特典のリスト値。
    • BenefitValue; string;プログラム階層の値は、プログラム特典の値タイプに適した形式で役立ちます。
    • CategoryCode; string; プログラムの特典のカテゴリを示すコード。 有効な値のリストは、参照ORA_ZPM_BENEFIT_CATEGORYで定義されます。
    • CreatedBy; string; 行を作成したユーザー。
    • CreationDate; string; 行が作成された日時。
    • DataType; string; プログラム特典の値タイプ。
    • 説明;文字列;プログラムの利点を説明するテキスト。
    • LastUpdateDate; string; 行が最後に更新された日時。
    • LastUpdateLogin; string;プログラム特典の詳細を最後に更新したユーザーのログイン。
    • LastUpdatedBy; string; 行を最後に更新したユーザー。
    • Name; string;プログラム階層特典の名前。
    • PartnerProgramId; integer; プログラム層の特典が追加されたパートナ・プログラムの一意の識別子。
    • ProgramBenefitDetailId; integer; システム生成の一意の識別子およびプログラム層の主キーの利点。
    • ProgramBenefitId; integer; プログラムまたはプログラム階層に追加されるプログラム特典の一意の識別子。
    • TierId; integer; プログラム層の特典が適用される階層の一意の識別子。
    • TierName; string; プログラム層の特典が適用される層の名前。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : partnerPrograms-ProgramBenefitDetails
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : partnerPrograms-ProgramBenefitDetails-item-response
タイプ: object
ソースを表示
  • プログラム特典の値タイプが「リスト」の場合のプログラム階層特典のリスト値。
  • タイトル: Benefit Value
    最大長: 150
    プログラム階層の値には、プログラム・ベネフィットの値タイプに適した書式の利点があります。
  • タイトル: Category
    読取り専用: true
    最大長: 30
    プログラム特典のカテゴリを示すコード。 有効な値のリストは、参照ORA_ZPM_BENEFIT_CATEGORYで定義されます。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    行を作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    行が作成された日時。
  • タイトル: Value Type
    読取り専用: true
    最大長: 30
    プログラム特典の値タイプ。
  • 読取り専用: true
    プログラム特典を削除できるかどうかを示します。 値がYの場合、プログラム特典は削除できます。 デフォルト値はNです。
  • タイトル: Benefits Description
    読取り専用: true
    最大長: 1000
    プログラム特典を説明するテキスト。
  • タイトル: Last Updated Date
    読取り専用: true
    行が最後に更新された日時。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    行を最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    プログラム特典詳細を最後に更新したユーザーのログイン。
  • Links
  • タイトル: Name
    最大長: 155
    プログラム階層特典の名前。
  • タイトル: Program
    プログラム階層特典が追加されたパートナ・プログラムの一意の識別子。
  • タイトル: Program Benefit Details
    システム生成の一意の識別子およびプログラム階層特典の主キー。
  • タイトル: Benefit
    プログラムまたはプログラム階層に追加されるプログラム・ベネフィットの一意の識別子。
  • タイトル: Tier
    プログラム階層特典が適用される階層の一意の識別子。
  • タイトル: Name
    読取り専用: true
    最大長: 155
    プログラム階層特典が適用される階層の名前。
  • 読取り専用: true
    プログラム特典を更新できるかどうかを示します。 値がYの場合、プログラム特典を更新できます。 デフォルト値はNです。
トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、パートナ・プログラムのすべてのプログラム・ベネフィットを取得する方法を示しています。

cURLコマンド

curl -v -u Username:Password -X GET "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/partnerPrograms/CDRM_12005/child/ProgramBenefitDetails"

レスポンス本文の例

次に、JSON形式のレスポンス本文の例を示します。

{
  "items" : [ {
    "BenefitValue" : null,
    "CreatedBy" : "CHANNEL_OPERATIONS_MANAGER",
    "CreationDate" : "2016-02-17T16:53:58-08:00",
    "LastUpdateDate" : "2016-02-17T16:53:58-08:00",
    "LastUpdatedBy" : "CHANNEL_OPERATIONS_MANAGER",
    "PartnerProgramId" : 300100071293754,
    "ProgramBenefitDetailId" : 300100071293762,
    "ProgramBenefitId" : 300100071293761,
    "TierId" : null,
    "DataType" : "ORA_NUMBER",
    "Name" : "Discount Sale",
    "Description" : null,
    "TierName" : null,
    "CategoryCode" : null,
    "BenefitListValue" : null,
    "UpdateFlag" : "true",
    "DeleteFlag" : "true",
....
}
「トップに戻る」