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

登録のプログラム特典の取得

get

/crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/ProgramBenefitDetails/{ProgramBenefitDetailId}

リクエスト

パス・パラメータ
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: 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
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

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

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : programEnrollments-ProgramBenefitDetails-item-response
タイプ: object
ソースを表示
  • 特典の価値。 DataTypeがList型の場合、属性に値があります。
  • タイトル: Benefit Value
    最大長: 150
    特典の価値。
  • タイトル: Category
    読取り専用: true
    最大長: 30
    特典のカテゴリを示すコード。 たとえば、Financial、Sales、Technical Supportなどです。 有効な値のリストは、参照ORA_ZPM_BENEFIT_CATEGORYで定義されます。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    レコードが最後に更新された日時。
  • タイトル: Creation Date
    読取り専用: true
    レコードを最後に作成したユーザー。
  • タイトル: Value Type
    読取り専用: true
    最大長: 30
    特典の値タイプ。 たとえば、金額、リスト、数値、テキスト、はい/いいえです。
  • 読取り専用: true
    レコードを削除できるかどうかを示します。 デフォルト値はfalseです。
  • タイトル: 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
    レコードを更新できるかどうかを示します。 デフォルト値はfalseです。
リンク
BenefitCategoryCodes
パラメータ:
  • ファインダ: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZPM_BENEFIT_CATEGORY%2CBindLookupCode%3D{CategoryCode}
財務、マーケティング、営業など、福利厚生カテゴリの値リスト。 このフィールドは更新できません。

LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: CategoryCode;ターゲット属性: LookupCode
  • 表示属性: 意味
BenefitListTypeValues
福利厚生リスト・タイプの値リスト。 ユーザーは、リスト・タイプの特典を定義する際に値を作成します。

LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: BenefitListValue;ターゲット属性: BenefitListTypeValId
  • 表示属性: ValueName
福利厚生
プログラム・ベネフィットの名前の値リスト。 ユーザーは、benefit(s)の定義中に値を作成します。

LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: 名前;ターゲット属性: 名前
  • 表示属性: 名前
ProgramTiers
プログラムtier.Theユーザーの値リストでは、プログラムに階層を追加して値を作成します。

LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: TierId;ターゲット属性: TierId
  • 表示属性: 名前
トップに戻る

例:

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

cURLコマンド

curl -v -u user:password -X GET "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/programEnrollments/CDRM_12005/child/ProgramBenefitDetails/300100071293762"

レスポンス本文の例

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

{
  "BenefitValue" : null,
  "CreatedBy" : "CHANNEL_PARTNER_MANAGER",
  "CreationDate" : "2016-02-17T16:53:58-08:00",
  "LastUpdateDate" : "2016-02-17T16:53:58-08:00",
  "LastUpdatedBy" : "CHANNEL_PARTNER_MANAGER",
  "PartnerProgramId": "300100000339515",
  "ProgramName": "PLATINUM PROGRAM",
  "ProgramDescription": "PLATINUM PROGRAM"
  "TierId" : null,
  "DataType" : "ORA_NUMBER",
  "Name" : "Discount Sale",
  "Description" : null,
  "TierName" : null,
  "CategoryCode" : null,
  "BenefitListValue" : null,
  "UpdateFlag" : "true",
  "DeleteFlag" : "true",
...
}
「トップに戻る」