営業リード製品の取得
get
/crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/MklProdAssoc1/{LeadProductId}
リクエスト
パス・パラメータ
- LeadProductId(required): integer(int64)
現在の営業リード製品の一意の識別子。
- 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-MklProdAssoc1-item-response
タイプ:
ソースを表示
object
-
金額: number
タイトル:
Amount
営業リード製品に関連付けられた金額。 -
AverageTimeToClose: number
タイトル:
Average Time to Close
この営業リード製品の平均クローズ時間。 -
ConflictId: integer
タイトル:
Conflict Identifier
デフォルト値:0
この値によって、モバイル・データベースやサーバーなどの異なるデータベースに重複が作成された場合に、行の一意性が保証されます。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
この営業リード製品を作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
この営業リード製品が作成された日時。 -
CurrencyCode: string
タイトル:
Currency
最大長:15
リード製品明細金額に関連付けられた通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 この属性の値は、「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用してレビューおよび更新できます。 -
Description: string
タイトル:
Item Description
最大長:240
製品が見込み客に関連付けられている製品説明。 -
EstimatedUnitPrice: number
タイトル:
Estimated Unit Price
このリード製品の見積単価。 -
InventoryItemId: integer (int64)
タイトル:
Inventory Number
リード製品に関連付けられた一意の在庫品目識別子。 -
ItemNumber: string
タイトル:
Inventory Item Number
読取り専用:true
最大長:300
参照在庫品目の代替キー。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
営業リード製品の最終更新日時。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
営業リード製品を最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Updated Login
読取り専用:true
最大長:32
レコードを最後に更新したユーザーのログイン。 -
LeadId: integer (int64)
タイトル:
Lead ID
この営業リード製品の営業リードの一意の識別子。 -
LeadNumber: string
タイトル:
Lead Number
最大長:30
リードの代替一意識別子。 -
LeadProductId: integer (int64)
タイトル:
Lead Product ID
現在の営業リード製品の一意の識別子。 -
LeadProductNumber: string
タイトル:
Lead Product Number
最大長:30
見込み客製品の代替キー。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
LongDescription: string
タイトル:
Long Description
読取り専用:true
最大長:4000
営業リード製品の詳細な説明。 -
OrganizationId: integer (int64)
タイトル:
Organization
このリード製品に関連付けられた一意の在庫組織識別子。 -
PrimaryFlag: boolean
タイトル:
Primary
最大長:1
この製品がこのリードのプライマリ製品であるかどうかを示します。 -
ProductGroupDescription: string
タイトル:
Product Group Description
読取り専用:true
最大長:1000
製品グループの簡単な説明。 -
ProductGroupId: integer (int64)
タイトル:
Product Group ID
製品グループの一意の識別子。 -
ProductGroupName: string
タイトル:
Product Group Name
最大長:250
営業リード製品リソースに関連付けられている製品グループの名前。 -
ProductGroupReferenceNumber: string
タイトル:
Product Group Reference Number
最大長:50
参照製品グループの代替キー。 -
ProductType: string
タイトル:
Product Type
製品のタイプ(品目または製品グループなど)。 -
数量: number
タイトル:
Quantity
リードのこの製品に対して識別される製品数量。 -
UOMCode: string
タイトル:
UOM
最大長:3
この営業リード製品明細に関連付けられた単位。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object
-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
リンク
- ProductGroupExtnLovVA
-
パラメータ:
- ファインダ:
ProductGroupList%3BBind_UsageCode%3DBASE%2CBind_UsageModeCode%3DMKL
製品グループ詳細ベース・パブリック・ビュー・オブジェクトの名前。 - ファインダ:
- ProductTypeLookupVOVA
-
パラメータ:
- ファインダ:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKL_LEAD_PRODUCT_TYPE
参照リソースは、標準参照コードの表示に使用されます。 - ファインダ:
- RatedCurrenciesVA
-
レート通貨リソースは、CRMの通貨コードの詳細を表示するために使用されます。 ルックアップZCA_COMMON_CORPORATE_CURRENCYに定義されている、受け入れられる値のリストが表示されます。
- SalesCatalogExtnProductsLovVA
-
パラメータ:
- ファインダ:
ProductList%3BBind_UsageCode%3DBASE%2CBind_UsageModeCode%3DMKL
製品リソースは、製品の表示、作成または変更に使用されます。 製品とは、組織または会社が販売する予定の品目です。 - ファインダ:
例:
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/MklProdAssoc1/300100092582203
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{ "LeadProductId" : 300100092582203, "LeadId" : 300100092582093, "OrganizationId" : null, "CurrencyCode" : "USD", "EstimatedUnitPrice" : null, "InventoryItemId" : null, "PrimaryFlag" : null, "ProductGroupId" : 999997826071065, "Quantity" : null, "UOMCode" : null, "Description" : null, "CreatedBy" : "MHoope", "CreationDate" : "2016-11-07T04:31:04-08:00", "LastUpdatedBy" : "MHoope", "LastUpdateDate" : "2016-11-07T04:31:36-08:00", "AverageTimeToClose" : null, "ProductGroupName" : "550VR Servers", "ProductGroupDescription" : "550VR Servers", "LongDescription" : null, "Amount" : null, "links" : [ { ............. }] }