Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

機械翻訳について

商談の取得

get

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

リクエスト

パス・パラメータ

LeadNumber(required): string

商談の作成に使用されたリードの代替キー識別子。
leadsUniqID(required): string

これは、営業リード・リソースの複合キーを構成し、営業リードのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントは、営業リードの特定のインスタンスに移動してハッシュ・キーを取得するために、営業リード・コレクション・リソースを問い合せる必要があります。

問合せパラメータ

dependency: string

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

フォーマット: <attr1>=<val1>,<attr2>=<value2>
expand: string

このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。この問合せパラメータの値は"all"または""です。カンマをセパレータとして使用して、複数の子を指定できます。例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
fields: string

このパラメータは、リソース・フィールドをフィルタします。指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。両方を指定した場合、フィールドのみが考慮されます。

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

子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
links: string

このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

例:
self,canonical
onlyData: boolean

リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。

ヘッダー・パラメータ

Metadata-Context:

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

Metadata-Context(required):

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version(required):

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

ルート・スキーマ : leads-LeadOpportunity-item-response

タイプ: object

ソースを表示

Account: string

タイトル: Customer Name

読取り専用: true

見込み客に関連付けられている取引先。
Currency: string

タイトル: Currency

読取り専用: true

商談売上額に関連付けられた通貨。
LeadName: string

タイトル: Lead Name

読取り専用: true

リードの識別に使用されるリード名。
LeadNumber: string

タイトル: Lead Number

読取り専用: true

商談の発生元の見込み客のリード番号。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
OptyCloseDate: string (date-time)

タイトル: Close Date

読取り専用: true

商談がクローズする日付。
OptyId: integer

タイトル: Opportunity ID

読取り専用: true

リードに関連付けられた商談の一意の識別子。
OptyName: string

タイトル: Opportunity

読取り専用: true

見込み客に関連付けられている商談の名前。
OptyNumber: string

タイトル: Opportunity Number

読取り専用: true

リードに関連付けられた商談の代替キー識別子。
OptyStatus: string

タイトル: Status

読取り専用: true

見込み客に関連付けられている商談の状況。
RevenueAmount: integer

タイトル: Line Revenue

読取り専用: true

見込み客に関連付けられている商談の売上額。
SalesStageId: integer

タイトル: Sales Stage ID

読取り専用: true

見込み客に関連付けられている商談のセールス・ステージの一意の識別子。
SalesStageName: string

タイトル: Name

読取り専用: true

見込み客に関連付けられている商談のセールス・ステージの名前。
WinProbability: integer

タイトル: Win Probability

読取り専用: true

見込み客に関連付けられている商談の成約確度。

{
    "type":"object",
    "properties":{
        "Account":{
            "title":"Customer Name",
            "type":"string",
            "description":"The account associated with the lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OptyName":{
            "title":"Opportunity",
            "type":"string",
            "description":"The name of the opportunity associated with the lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OptyCloseDate":{
            "title":"Close Date",
            "type":"string",
            "description":"The date when the opportunity closes.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LeadNumber":{
            "title":"Lead Number",
            "type":"string",
            "description":"The lead number of the lead from which the opportunity originated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesStageId":{
            "title":"Sales Stage ID",
            "type":"integer",
            "description":"The unique identifier of the sales stage of the opportunity associated with the lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RevenueAmount":{
            "title":"Line Revenue",
            "type":"integer",
            "description":"The revenue amount of the opportunity associated with the lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity associated with the lead.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "RecentItemEntityName":"opportunities"
            },
            "x-queryable":true
        },
        "WinProbability":{
            "title":"Win Probability",
            "type":"integer",
            "description":"The win probability of the opportunity associated with the lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Currency":{
            "title":"Currency",
            "type":"string",
            "description":"The currency associated with the opportunity revenue amount.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesStageName":{
            "title":"Name",
            "type":"string",
            "description":"The name of the sales stage of the opportunity associated with the lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LeadName":{
            "title":"Lead Name",
            "type":"string",
            "description":"The lead name used for identifying the lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "type":"string",
            "description":"The alternate key identifier of the opportunity associated with the lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OptyStatus":{
            "title":"Status",
            "type":"string",
            "description":"The status of the opportunity associated with the lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : リンク

タイプ: object

ソースを表示

href: string

タイトル: hyperlink reference

関連リソースへのURI。
kind: string

タイトル: kind

許可された値: [ "collection", "item", "describe", "other" ]

関連リソースの種類。
name: string

タイトル: name

関連リソースへのリンクの名前。
properties: object properties
rel: string

タイトル: relation

許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

リソース・インスタンスとの関係の名前。例: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

changeIndicator: string

リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

トップに戻る

例:

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/{lead_number}

レスポンス本文の例

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

{
  "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"
  }, 
  ......
  ]
}

「トップに戻る」