機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 商談
  4. 商談リード

すべての商談リードの取得

get

/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityLead

リクエスト

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

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

    • OpportunityLeadAltKeyFinder : リードまたは商談の一意の公開識別子に基づいて商談リードを検索します。
      ファインダ変数:
      • LeadNumber; string;リードの一意の公開識別子。
      • OptyNumber; string;商談の一意の公開識別子。
    • OptyLeadUserKey : リードの一意の公開識別子または商談主キーに基づいて商談リードを検索します。
      ファインダ変数:
      • LeadNumber; string;リードの一意の公開識別子。
      • OptyId; integer;商談の主キー。
    • PrimaryKey : 主キー別に商談リードを検索します。
      ファインダ変数:
      • OptyLeadId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • ConflictId; integer; モバイル・データベースやサーバーなどの切断されたモバイルの場合に、異なるデータベースに重複が作成された場合に、行の一意性を保証するために使用される値。
    • CreatedByModule; string; レコードの作成に使用されたモジュール。
    • LeadId; integer;商談のリードの一意の識別子。
    • LeadNumber; string;リードの代替キー識別子。
    • OptyLeadId; integer;商談のリードの一意の識別子。
    • OptyNumber; string; 商談の一意の公開識別子である商談の番号。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : opportunities-OpportunityLead
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : opportunities-OpportunityLead-item-response
タイプ: object
ソースを表示
  • タイトル: Conflict ID
    デフォルト値: 0
    モバイル・データベースやサーバーなどの切断されたモバイルの場合に、異なるデータベースに重複が作成される場合に、行の一意性を保証するために使用される値。
  • タイトル: Contact
    読取り専用: true
    最大長: 450
    プライマリ・リード担当者の名前。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    レコードを作成したユーザー。
  • タイトル: Created by Module
    読取り専用: true
    最大長: 30
    レコードの作成に使用されたモジュール。
  • タイトル: Creation Date
    読取り専用: true
    レコードが作成された日時。
  • タイトル: Customer Identifier
    読取り専用: true
    TCAスキーマの顧客レコードの一意の識別子。
  • タイトル: Customer
    読取り専用: true
    最大長: 360
    顧客の名前。
  • タイトル: Deal Registration Estimated Close Date
    商談の取引交渉登録がクローズされると予想される日付。
  • タイトル: Deal Expiration Date
    リード登録が失効する日付。
  • タイトル: Partner Program ID
    リード登録に関連付けられたパートナ・プログラムの一意の識別子。
  • タイトル: Deal Size
    読取り専用: true
    商談に関連付けられている取引の取引サイズ。
  • タイトル: Lead Registration Type
    最大長: 30
    商談のディールまたはリード登録タイプ。
  • タイトル: Last Updated Date
    読取り専用: true
    レコードが最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    レコードを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    レコードを最後に更新したユーザーに関連付けられたセッション・ログイン。
  • タイトル: Age in Days
    読取り専用: true
    リードが作成されてから経過した日数。
  • タイトル: Lead Identifier
    読取り専用: true
    商談のリードの一意の識別子。
  • タイトル: Lead Name
    読取り専用: true
    最大長: 250
    商談に関連付けられている見込み客の名前。
  • タイトル: Lead Number
    最大長: 64
    リードの代替キー識別子。
  • Links
  • タイトル: Object Usage
    最大長: 30
    現在のレコードがリードまたはディールのどちらを表すかを示します。
  • タイトル: Opportunity ID
    商談の一意の識別子。
  • タイトル: Opportunity Lead ID
    商談のリードの一意の識別子。
  • タイトル: Opportunity Number
    最大長: 30
    商談の一意の公開識別子である商談の番号。
  • タイトル: Partner Type
    最大長: 250
    リード登録のパートナのタイプを示すコード。
  • タイトル: Partner Organization Party ID
    リード登録のパートナの一意の識別子。
  • タイトル: Primary Partner Resource ID
    リード登録のプライマリ・パートナ・リソースの一意の識別子。
  • タイトル: Primary Contact Identifier
    読取り専用: true
    プライマリ・リード担当者としてマークされた営業リード担当の一意の識別子。
  • タイトル: Rank
    読取り専用: true
    最大長: 30
    商談に関連付けられているリードのランク。
  • タイトル: Rank
    読取り専用: true
    関連付けられたリードのランク・コードの意味。
  • タイトル: Registration Number
    最大長: 120
    商談のリードの一意の登録番号。
  • タイトル: Status
    読取り専用: true
    最大長: 30
    商談リードのステータスを示すコード。
  • タイトル: Status
    読取り専用: true
    関連リードのステータス・コードの意味。
  • タイトル: User Last Update Date
    商談リードがモバイルから最後に更新された日時。
トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、すべての商談リードを取得する方法を示しています。

cURLコマンド

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

レスポンス本文の例

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

{
items: [1]
0:  
{
OptyLeadId: 300100111705721
OptyId: 300100111705686
LeadNumber: "102"
                 
 }
}
「トップに戻る」