すべての商談チーム・メンバーを取得
get
/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityResource
リクエスト
パス・パラメータ
- 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 - finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。
フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
使用可能なファインダ名および対応するファインダ変数を次に示します:- OpportunityResourceAltKeyFinder : リソースまたは商談の一意の公開識別子に基づいて商談リソースを検索します。
ファインダ変数:- OptyNumber; string;商談の一意の公開識別子。
- ResourcePartyNumber; string;リソースの一意の公開識別子。
- OptyResourceViewAltKey : 担当者IDで商談を検索します。
ファインダ変数:- OptyId; integer;商談の一意のID。
- ResourceId; integer;商談リソースの一意の識別子。
- PrimaryKey : 主キー別に商談を検索します。
ファインダ変数:- OptyResourceId; integer;商談リソースの一意の識別子。
- OpportunityResourceAltKeyFinder : リソースまたは商談の一意の公開識別子に基づいて商談リソースを検索します。
- limit: integer
このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
- links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- offset: integer
リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
- onlyData: boolean
リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
- orderBy: string
このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
- q: string
この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY
フォーマット : ?q=expression1;expression2
次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- ConflictId; integer; モバイル・データベースやサーバーなどの切断されたモバイルの場合に、異なるデータベースに重複が作成された場合に、行の一意性を保証するために使用される値。
- DealExpirationDate; string; 商談チーム・メンバーのディール保護期間が終了する日付。 テリトリ再編成のために商談から割当解除されると、テリトリ・メンバーの日付が更新されます。
- DealProtectedDate; string;商談チーム・メンバーのディール保護期間が開始する日付。 テリトリ再編成のために商談から割当解除されると、テリトリ・メンバーの日付が更新されます。
- OptyId; integer;商談の一意の識別子。
- OptyNumber; string;商談の一意の代替識別子。
- OptyResourceId; integer; 既存の商談リソースの一意のパーティ識別子。
- PartnerOrgId; integer;パートナ組織の一意の識別子。
- PartyName; string;商談チーム・メンバーの名前。
- ResourceId; integer; 既存のリソースの一意のパーティ識別子。
- ResourcePartyNumber; string;商談リソース・パーティの代替キー識別子。
- totalResults: boolean
"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
- 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-OpportunityResource
タイプ:
ソースを表示
object-
count(required): integer
現在の範囲で返されたリソース・インスタンスの数。
-
hasMore(required): boolean
サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。 値がtrueの場合、サーバーから取得するリソースがさらにあります。 デフォルト値はfalseです。
-
items: array Items
タイトル:
Itemsコレクション内のアイテム。 -
limit(required): integer
サーバーで使用される実際のページング・サイズ。
-
links(required): array Links
タイトル:
Linksリソース・インスタンスに関連付けられたリンク関係。 -
offset(required): integer
現在のページで使用されるオフセット値。
-
totalResults: integer
"?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : opportunities-OpportunityResource-item-response
タイプ:
ソースを表示
object-
AccessLevelCode: string
タイトル:
Access最大長:30リソースに付与されたアクセス・レベルと組織のマネージャを示すコード。 受け入れられる値のリストは、参照ZCA_ACCESS_LEVELで定義されます。 「設定およびメンテナンス」作業領域の標準参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
AsgnTerritoryVersionId: integer (int64)
タイトル:
Territoryテリトリ・ベース割当を介して商談に割り当てられたリソースのテリトリ・バージョンの一意の識別子。 -
AssignmentType: string
タイトル:
Assignment Type読取り専用:trueリソースが販売アカウント・チームにどのように割り当てられるかを示すコード。 受け入れられる値のリストは、参照ZCA_ASSIGNMENT_TYPEで定義されます。 「設定およびメンテナンス」作業領域の標準参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
ConflictId: integer (int64)
タイトル:
Conflict IDデフォルト値:0モバイル・データベースやサーバーなどの切断されたモバイルの場合に、異なるデータベースに重複が作成される場合に、行の一意性を保証するために使用される値。 -
CreatedBy: string
読取り専用:
true最大長:64商談リソース・レコードを作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
trueリソース・レコードが作成された日時。 -
DealExpirationDate: 文字列(日付)
タイトル:
Deal Protected to Date商談チーム・メンバーの取引保護期間が終了する日付。 テリトリ再編成のために商談から割当解除されると、テリトリ・メンバーの日付が更新されます。 -
DealProtected: string
タイトル:
Deal Protected読取り専用:trueリソースがディール保護中かどうかを示します。 値がTrueの場合、リソースはディール保護の対象になります。 デフォルト値は「False」です。 -
DealProtectedDate: 文字列(日付)
タイトル:
Deal Protected from Date商談チーム・メンバーの取引保護期間が開始する日付。 テリトリ再編成のために商談から割当解除されると、テリトリ・メンバーの日付が更新されます。 -
EmailAddress: string
タイトル:
Primary Email読取り専用:true最大長:320商談チーム・メンバーの電子メール・アドレス。 -
FormattedPhoneNumber: string
タイトル:
Phone読取り専用:true商談チーム・メンバーの書式設定された電話番号。 -
LastUpdateDate: string (date-time)
読取り専用:
trueレコードが最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true最大長:64レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true最大長:32レコードを最後に更新したユーザーに関連付けられたセッション・ログイン。 -
links: array Links
タイトル:
Linksリソース・インスタンスに関連付けられたリンク関係。 -
LockAssignmentFlag: boolean
タイトル:
Lock Assignment最大長:1デフォルト値:true自動テリトリ割当を設定できるかどうかを示します。 値がTrueの場合、自動テリトリ割当では販売アカウント・チーム・リソースを削除できません。 販売アカウント・チーム・メンバーを手動で追加すると、このフラグはYにデフォルト設定されます。 -
MemberFunctionCode: string
タイトル:
Function最大長:30インテグレータ、エグゼクティブ・スポンサ、技術アカウント・マネージャなど、リソース・チームの営業チーム・メンバーのロールを示すコード。 受け入れられる値のリストは、参照FND_LOOKUPSで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
MgrResourceId: integer
読取り専用:
trueリソース・チーム・メンバーのマネージャの一意の識別子。 -
OptyId: integer (int64)
商談の一意の識別子。
-
OptyNumber: string
タイトル:
Opportunity Number最大長:30商談の一意の代替識別子。 -
OptyResourceId: integer (int64)
タイトル:
Opportunity Resource ID既存の商談リソースの一意のパーティ識別子。 -
OptyResourceNumber: string
タイトル:
Opportunity Resource Number最大長:30商談リソースの代替キー識別子。 -
OwnerFlag: boolean
タイトル:
Primary商談チーム・メンバーが商談の所有者であるかどうかを示します。 値がTrueの場合、商談チーム・メンバーも商談の所有者になります。 デフォルト値は「False」です。 -
PartnerOrgId: integer (int64)
タイトル:
Nameパートナ組織の一意の識別子。 -
PartnerPartyName: string
タイトル:
Name読取り専用:true最大長:360パートナ・リソースに関連付けられたパートナの名前。 -
PartyName: string
タイトル:
Team Member読取り専用:true最大長:360商談チーム・メンバーの名前。 -
PersonFirstName: string
タイトル:
First Name読取り専用:true最大長:150商談チーム・メンバーの名。 -
PersonLastName: string
タイトル:
Last Name読取り専用:true最大長:150商談チーム・メンバーの姓。 -
ResourceId: integer (int64)
タイトル:
Team Member既存のリソースの一意のパーティ識別子。 -
ResourcePartyNumber: string
タイトル:
Registry ID読取り専用:true最大長:30商談リソース・パーティの代替キー識別子。 -
RoleName: string
タイトル:
Role読取り専用:true最大長:60リソース組織の商談チーム・メンバーのロール。 -
TerritoryName: string
タイトル:
Territory読取り専用:true最大長:60商談チーム・メンバーのテリトリの名前。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。
例:
次の例は、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_341580/child/OpportunityResource
レスポンス本文の例
次に、JSON形式のレスポンス本文の例を示します。
{
"items": 2[0]:
{
"AccessLevelCode": "200",
"PartyName": "Matt Brown",
"ResourceId": 73620,
"OptyResourceId": 300100092629556,
"OptyId": 300100092516122,
"DealExpirationDate": null,
"CreationDate": "2016-11-16T05:02:42-08:00",
"LastUpdateDate": "2016-11-16T05:03:04-08:00",
"DealProtected": "N",
"MemberFunctionCode": "INTEGRATOR",
"OwnerFlag": false,
"LockAssignmentFlag": true,
"AssignmentType": "Ad hoc assignment",
"CreatedBy": "MHoope",
"LastUpdatedBy": "MHoope",
"LastUpdateLogin": "415B9500195B1E30E05354C0F20ADDA7",
"PersonFirstName": "Matt",
"PersonLastName": "Brown",
"AsgnTerritoryVersionId": null,
"TerritoryName": null.
"EmailAddress": "sendmail-test-discard@oracle.com",
"FormattedPhoneNumber": "+1",
"PartnerOrgId": null,
"PartnerPartyName": null,
"RoleName": null,
"MgrResourceId": null,
"OptyResourceNumber": "CDRM_366561",
"ResourcePartyNumber": "34724",
"DealProtectedDate": null
}
-1:
{
"AccessLevelCode": "300",
"PartyName": "Matt Hooper",
"ResourceId": 100010037456865,
"OptyResourceId": 300100092516124,
"OptyId": 300100092516122,
"DealExpirationDate": null,
"CreationDate": "2016-11-16T05:02:42-08:00",
"LastUpdateDate": "2016-11-16T05:03:04-08:00",
"DealProtected": "N",
"MemberFunctionCode": "INTEGRATOR",
"OwnerFlag": true,
"LockAssignmentFlag": true,
"AssignmentType": "Ad hoc assignment",
"CreatedBy": "MHoope",
"LastUpdatedBy": "MHoope",
"LastUpdateLogin": "415B9500195B1E30E05354C0F20ADDA7",
"PersonFirstName": "Matt",
"PersonLastName": "Hooper",
"AsgnTerritoryVersionId": null,
"TerritoryName": null.
"EmailAddress": "sendmail-test-discard@oracle.com",
"FormattedPhoneNumber": "+1",
"PartnerOrgId": null,
"PartnerPartyName": null,
"RoleName": "Sales Administrator",
"MgrResourceId": 300100027465158,
"OptyResourceNumber": "CDRM_346561",
"ResourcePartyNumber": "100010037456865",
"DealProtectedDate": null
}
}