商談担当者の取得
get
/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityContact/{OptyConId}
リクエスト
パス・パラメータ
- OptyConId(required): integer(int64)
商談に関連付けられている担当者の一意の識別子。
- OptyNumber(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のデフォルト・バージョンを選択します。
ルート・スキーマ : opportunities-OpportunityContact-item-response
タイプ:
ソースを表示
object
-
AffinityLvlCd: string
タイトル:
Affinity Level
最大長:30
商談担当者の当該組織との親和性を示すコード。 受け入れられる値のリストは、参照HZ_SLS_CNTCT_AFFINITY_CODEで定義されます。 「設定およびメンテナンス」作業領域、「担当者参照の管理」タスクを使用して、この属性の値をレビューおよび更新します。 -
Comments: string
タイトル:
Comments
最大長:255
現在の商談の担当者に関するテキストによるコメント。 -
ConflictId: integer (int64)
タイトル:
Conflict ID
デフォルト値:0
モバイル・データベースやサーバーなどの切断されたモバイルの場合に、異なるデータベースに重複が作成される場合に、行の一意性を保証するために使用される値。 -
ContactedFlg: string
タイトル:
Contacted
最大長:1
デフォルト値:N
この商談の担当者に連絡があるかどうかを示します。 値がTrueの場合、担当者に連絡がありました。 デフォルト値は「False」です。 -
ContactPartyNumber: string
タイトル:
Registry ID
読取り専用:true
最大長:30
商談担当者パーティの代替キー識別子。 -
ContactPointId: integer
商談担当者の担当者の一意の識別子。
-
CreatedBy: string
読取り専用:
true
最大長:64
商談担当者レコードを作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
担当者レコードが作成された日時。 -
DoNotContactFlag: boolean
タイトル:
Do Not Contact
読取り専用:true
最大長:1
ユーザーが電話、Eメールまたは郵送で個人に連絡できるかどうかを示します。 値がTrueの場合、ユーザーは個人に連絡できません。 デフォルトはFalseです。 -
EmailAddress: string
タイトル:
Email
読取り専用:true
担当者のEメール・アドレス。 -
EmailPreference: string
タイトル:
Email Preference
読取り専用:true
最大長:255
商談担当者のEメール・プリファレンスがEメール送信不可、Eメール送信可または値なしのいずれであるかを示します。 -
FormattedAddress: string
タイトル:
Address
読取り専用:true
最大長:255
担当者の書式設定された住所。 -
FormattedPhoneNumber: string
タイトル:
Phone
読取り専用:true
担当者の書式設定された電話番号。 -
InfluenceLvlCd: string
タイトル:
Influence Level
最大長:30
商談担当者が当該組織に与える影響を示すコード。 受け入れられる値のリストは、参照HZ_SLS_CNTCT_INFLUENCE_LVL_CDで定義されます。 「設定およびメンテナンス」作業領域、「担当者参照の管理」タスクを使用して、この属性の値をレビューおよび更新します。 -
JobTitle: string
タイトル:
Title
読取り専用:true
最大長:100
商談担当者の肩書の自由形式テキスト。 -
LastUpdateDate: string (date-time)
読取り専用:
true
レコードが最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
最大長:
32
レコードを最後に更新したユーザーに関連付けられたセッション・ログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
OptyConId: integer (int64)
タイトル:
Contact ID
商談に関連付けられている担当者の一意の識別子。 -
OptyId: integer (int64)
タイトル:
Opportunity
商談の一意の識別子。 -
OptyNumber: string
タイトル:
Opportunity Number
最大長:30
商談の一意の代替識別子。 -
OrganizationPartyId: integer (int64)
タイトル:
Party ID
読取り専用:true
担当者の組織の一意の識別子。 -
OrganizationPartyName: string
タイトル:
Organization
読取り専用:true
最大長:360
担当者の組織の名前。 -
OrgContactId: integer (int64)
読取り専用:
true
商談の組織担当者の一意の識別子。 -
PartyName: string
タイトル:
Opportunity Contact Name
読取り専用:true
最大長:360
商談の担当者の名前。 -
PartyUniqueName: string
タイトル:
Related Account
読取り専用:true
最大長:900
パーティ関連画面に表示される一意の担当者名。 担当者のデフォルト値は、属性ContactNameとUniqueNameSuffixを連結したものです。 組織のデフォルト値は、一意の名前別名とUniqueNameSuffixを連結したものです。 -
PERPartyId: integer (int64)
タイトル:
Opportunity Contact
商談担当者のパーティ識別子。 -
PersonCentricJobTitle: string
タイトル:
Job Title
読取り専用:true
最大長:100
担当者個人のジョブ・タイトル。 -
PhonePreference: string
タイトル:
Phone Preference
読取り専用:true
最大長:255
商談担当者の電話プリファレンスが電話不可、電話可または値なしのいずれであるかを示します。 -
PreferredContactMethod: string
タイトル:
Preferred Contact Method
読取り専用:true
最大長:30
個人への連絡メソッド。 受け入れられる値のリストは、参照HZ_PREFERRED_CONTACT_METHODで定義されます。 「設定およびメンテナンス」作業領域の担当者参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
PrimaryFlg: string
タイトル:
Primary
担当者が商談のプライマリ担当者であるかどうかを示します。 値がTrueの場合、担当者は商談のプライマリ担当者になります。 デフォルト値は「False」です。 -
RelationshipCode: string
タイトル:
Relationship Code
読取り専用:true
最大長:30
フォワード関係かバック・ワード関係かを示すコード。 受け入れられる関係値のリストは、参照PARTY_RELATIONS_TYPEで定義されます。 「設定およびメンテナンス」作業領域の関係参照の管理を使用して、この属性の値をレビューおよび更新します。 -
RelationshipId: integer (int64)
商談担当者の関係の識別子。
-
RoleCd: string
タイトル:
Function
最大長:30
商談の担当者が果たしたロールを識別するコード。 受け入れられる値のリストは、参照HZ_SLS_CNTCT_BUY_ROLE_CODEで定義されます。 「設定およびメンテナンス」作業領域の担当者参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
SalesAffinityCode: string
タイトル:
Affinity
読取り専用:true
最大長:30
商談担当者の当該組織との親和性を示すコード。 受け入れられる値のリストは、参照HZ_SLS_CNTCT_AFFINITY_CODEで定義されます。 「設定およびメンテナンス」作業領域、「担当者参照の管理」タスクを使用して、この属性の値をレビューおよび更新します。 -
SalesBuyingRoleCode: string
タイトル:
Buying Role
読取り専用:true
最大長:30
購買プロセスで担当が果たしたロールを識別するコードです。 受け入れられる値のリストは、参照HZ_SLS_CNTCT_BUY_ROLE_CODEで定義されます。 「設定およびメンテナンス」作業領域の担当者参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
SalesInfluenceLevelCode: string
タイトル:
Influence Level
読取り専用:true
最大長:30
商談担当者が現在の商談の購買プロセスに与える影響を示すコード。 受け入れられる値のリストは、参照HZ_SLS_CNTCT_INFLUENCE_LVL_CDで定義されます。 「設定およびメンテナンス」作業領域、「担当者参照の管理」タスクを使用して、この属性の値をレビューおよび更新します。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。
リンク
- OptyContactYesNoLOV
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BBindLookupType%3DYES_NO
参照リソースは、標準参照コードの表示に使用されます。 - ファインダ:
- PreferredContactMethodLookupPVO
-
パラメータ:
- ファインダ:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DHZ_PREFERRED_CONTACT_METHOD%2CBindLookupCode%3D{PreferredContactMethod}
参照リソースは、標準参照コードの表示に使用されます。 - ファインダ:
- ZbsBuyingRoleTypesLOV
-
パラメータ:
- ファインダ:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DHZ_SLS_CNTCT_BUY_ROLE_CODE%2CBindLookupCode%3D{RoleCd}
参照リソースは、標準参照コードの表示に使用されます。 - ファインダ:
- ZbsContactAffinityTypesLOV
-
パラメータ:
- ファインダ:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DHZ_SLS_CNTCT_AFFINITY_CODE%2CBindLookupCode%3D{AffinityLvlCd}
参照リソースは、標準参照コードの表示に使用されます。 - ファインダ:
- ZbsInfluenceLevelTypesLOV
-
パラメータ:
- ファインダ:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DHZ_SLS_CNTCT_INFLUENCE_LVL_CD%2CBindLookupCode%3D{InfluenceLvlCd}
参照リソースは、標準参照コードの表示に使用されます。 - ファインダ:
例:
次の例は、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_3341580/child/OpportunityContact/300100092629555
レスポンス本文の例
次に、JSON形式のレスポンス本文の例を示します。
{ AffinityLvlCd: null, Comments: null, ContactedFlg: "N", PartyName: "Juan BELL", OptyConId: 300100092629555, PERPartyId: 100000018544431, CreatorPartyId: 100010025532672, CreatedBy: "MHoope", CreationDate: "2016-11-16T05:15:38-08:00", LastUpdateDate: "2016-11-16T05:15:43-08:00", ContactPointId: 100000018544441, FormattedAddress: "1625 19th Ave,SEATTLE, WA 98122", FormattedPhoneNumber: "2065584951", ContactPartyNumber: "100000018544430", ... }