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

すべての商談を取得

get

/crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/LeadOpportunity

リクエスト

パス・パラメータ
  • これは、営業リード・リソースの複合キーを構成し、営業リードのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、営業リードの特定のインスタンスに移動してハッシュ・キーを取得するために、営業リード・コレクション・リソースを問い合せる必要があります。
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: 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 : 指定したLeadNumberでリードを変換して作成された商談のリストを検索します。
      ファインダ変数:
      • LeadNumber; string;リード番号を表示します。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • アカウント、文字列。リードに関連付けられているアカウント。
    • 通貨;文字列;商談売上額に関連付けられた通貨。
    • LeadName; string;リードの識別に使用されるリード名。
    • LeadNumber; string;商談が発生したリードのリード番号。
    • OptyCloseDate; string;商談がクローズする日付。
    • OptyId; integer;リードに関連付けられた商談の一意の識別子。
    • OptyName; string;リードに関連付けられた商談の名前。
    • OptyNumber; string;リードに関連付けられた商談の代替キー識別子。
    • OptyStatus; string;リードに関連付けられた商談のステータス。
    • RevenueAmount; integer;リードに関連付けられた商談の売上額。
    • SalesStageId; integer; リードに関連付けられた商談の営業ステージの一意の識別子。
    • SalesStageName; string; リードに関連付けられた商談の営業ステージの名前。
    • WinProbability; integer;リードに関連付けられた商談の受注確度。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : leads-LeadOpportunity
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : leads-LeadOpportunity-item-response
タイプ: object
ソースを表示
  • タイトル: Customer Name
    読取り専用: true
    見込み客に関連付けられている取引先。
  • タイトル: Currency
    読取り専用: true
    商談売上額に関連付けられた通貨。
  • タイトル: Lead Name
    読取り専用: true
    リードの識別に使用されるリード名。
  • タイトル: Lead Number
    読取り専用: true
    商談の発生元の見込み客のリード番号。
  • Links
  • タイトル: Close Date
    読取り専用: true
    商談がクローズする日付。
  • タイトル: Opportunity ID
    読取り専用: true
    リードに関連付けられた商談の一意の識別子。
  • タイトル: Opportunity
    読取り専用: true
    見込み客に関連付けられている商談の名前。
  • タイトル: Opportunity Number
    読取り専用: true
    リードに関連付けられた商談の代替キー識別子。
  • タイトル: Status
    読取り専用: true
    見込み客に関連付けられている商談の状況。
  • タイトル: Line Revenue
    読取り専用: true
    見込み客に関連付けられている商談の売上額。
  • タイトル: Sales Stage ID
    読取り専用: true
    見込み客に関連付けられている商談のセールス・ステージの一意の識別子。
  • タイトル: Name
    読取り専用: true
    見込み客に関連付けられている商談のセールス・ステージの名前。
  • タイトル: Win Probability
    読取り専用: true
    見込み客に関連付けられている商談の成約確度。
トップに戻る

例:

cURLコマンド

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

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/{lead_id}/child/LeadOpportunity

レスポンス本文の例

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

{ 
 "items" : [ {
    "LeadName" : "nov7aj1",
    "LeadNumber" : "CDRM_235875",
    "Account" : null,
    "OptyId" : 300100092363928,
    "OptyName" : "Advantage Corp (COLUMBUS, US) CDRM_47006",
    "OptyNumber" : "CDRM_335580",
    "OptyStatus" : "OPEN",
    "OptyCloseDate" : "2016-11-07T00:00:00-08:00",
    "SalesStageId" : 100000012430007,
    "SalesStageName" : "01 - Qualification",
    "WinProbability" : 0,
    "RevenueAmount" : 0,
    "Currency" : "USD",
    "links" : [ {
      "rel" : "self",
      "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/{lead_id}/child/LeadOpportunity/CDRM_235875",
      "name" : "LeadOpportunity",
      "kind" : "item"
    }, .......
 .........
 ]
  }, {
    "LeadName" : "nov7aj1",
    "LeadNumber" : "CDRM_235875",
    "Account" : null,
    "OptyId" : 300100092516644,
    "OptyName" : "Apple Corporation",
    "OptyNumber" : "CDRM_344583",
    "OptyStatus" : "OPEN",
    "OptyCloseDate" : "2016-11-23T00:00:00-08:00",
    "SalesStageId" : 100000012430007,
    "SalesStageName" : "01 - Qualification",
    "WinProbability" : 50,
    "RevenueAmount" : 0,
    "Currency" : "USD",
    "links" : [ ....
    } ]
.........
  } ],
  "count" : 2,
  "hasMore" : false,
  "limit" : 25,
  "offset" : 0,
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/{lead_id}/child/LeadOpportunity",
    "name" : "LeadOpportunity",
    "kind" : "Collection"
  } ]
}
「トップに戻る」