すべての営業チーム・メンバーの取得
get
/crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/SalesTeamMember
リクエスト
パス・パラメータ
- PartyNumber(required): string
世帯パーティの一意のプライマリ識別子。 プロファイル・オプションHZ_GENERATE_PARTY_NUMBERは、属性値をシステム生成にできるか、作成中にユーザー指定にできるかを制御します。 「設定およびメンテナンス」作業領域、「取引先コミュニティ共通プロファイル・オプションの管理」タスクを使用して、この属性の値をレビューおよび更新します。 非アクティブなレコードは更新できません。
問合せパラメータ
- 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>
使用可能なファインダ名および対応するファインダ変数を次に示します:- PrimaryKey : 主キーを持つ営業チーム・メンバーを検索します。
ファインダ変数:- TeamMemberId; integer;販売アカウント・リソース・チームのメンバーのサロゲート主キー。
- SalesAccountIdAndResourceIdAltKey : アカウントとリソースの一意のキーを持つ営業チーム・メンバーを検索します。
ファインダ変数:- ResourceId; integer;リソースの一意の識別子。
- SalesProfileId; integer;販売アカウントの識別子。
- PrimaryKey : 主キーを持つ営業チーム・メンバーを検索します。
- 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問合せパラメータを使用してこの収集リソースをフィルタできます:
- LockAssignmentFlag; boolean;自動テリトリ割当を設定できるかどうかを示します。 値がTrueの場合、自動テリトリ割当では販売アカウント・チーム・リソースを削除できません。 販売アカウント・チーム・メンバーを手動で追加すると、このフラグはYにデフォルト設定されます。
- PartyId; integer;営業チーム・メンバー・レコードの関連パーティ・レコードの一意の識別子。
- PartyNumber; string;関連パーティ・レコードの公開識別子。
- PartySourceSystem; string;関連パーティ・レコードの外部ソース・システムの名前。
- PartySourceSystemReferenceValue; string;関連パーティ・レコードの外部ソース・システムからの一意の識別子。
- ResourceEmailAddress; string; リソースの電子メール・アドレス。
- ResourcePartyNumber; string; このチーム・メンバーが属するリソースの代替キー識別子。
- TeamMemberId; integer;販売アカウント・リソース・チームのメンバーの一意の識別子。
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : households-SalesTeamMember
タイプ:
ソースを表示
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"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : households-SalesTeamMember-item-response
タイプ:
ソースを表示
object
-
AccessLevelCode: string
タイトル:
Access
最大長:30
リソースに付与されたアクセス・レベルと組織のマネージャを示すコード。 指定可能な値は、ZCA_ACCESS_LEVEL参照で定義されます。 「設定およびメンテナンス」作業領域の標準参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
AssignmentTypeCode: string
タイトル:
Assignment Type
最大長:30
デフォルト値:MANUAL
リソースが販売アカウント・チームにどのように割り当てられるかを示すコード。 指定可能な値は、ZCA_ASSIGNMENT_TYPE参照に含まれています。 -
CorpCurrencyCode: string
タイトル:
Corporate Currency Code
最大長:15
営業チーム・メンバーに関連付けられた企業通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
レコードを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
レコードが作成された日時。 -
CurcyConvRateType: string
タイトル:
Currency Conversion Rate Type
最大長:30
住所に関連付けられた通貨換算レート・タイプ。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
CurrencyCode: string
タイトル:
Currency Code
最大長:15
世帯オブジェクトの営業チーム・メンバーに関連付けられた通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
EndDateActive: 文字列(日付)
タイトル:
Archived Date
リソースが販売アカウントから分離された日付。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
レコードが最後に更新された日時。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login
読取り専用:true
最大長:32
レコードを最後に更新したユーザーのログイン詳細。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
LockAssignmentFlag: boolean
タイトル:
Locked
最大長:1
デフォルト値:false
自動テリトリ割当を設定できるかどうかを示します。 値がTrueの場合、自動テリトリ割当では販売アカウント・チーム・リソースを削除できません。 販売アカウント・チーム・メンバーを手動で追加すると、このフラグはYにデフォルト設定されます。 -
MemberFunctionCode: string
タイトル:
Function
最大長:30
インテグレータ、エグゼクティブ・スポンサ、技術アカウント・マネージャなど、リソース・チームの営業チーム・メンバーのロールを示すコード。 受け入れられる値のリストは、参照FND_LOOKUPSで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
ObjectVersionNumber: 整数(int32)
オプティミスティック・ロックの実装に使用される数。 この番号は、行を更新するたびに増分されます。 問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
-
OwnerFlag: boolean
タイトル:
Owner
デフォルト値:false
リソースが所有者かどうかを示します。 -
PartyId: integer
営業チーム・メンバー・レコードの関連パーティ・レコードの一意の識別子。
-
PartyNumber: string
関連パーティ・レコードの公開識別子。
-
PartySourceSystem: string
関連パーティ・レコードの外部ソース・システムの名前。
-
PartySourceSystemReferenceValue: string
関連パーティ・レコードの外部ソース・システムからの一意の識別子。
-
ResourceEmailAddress: string
タイトル:
Resource Email
リソースの電子メール・アドレス。 -
ResourceId: integer (int64)
タイトル:
Resource ID
世帯リソースの一意の識別子。 -
ResourceName: string
タイトル:
Resource Name
読取り専用:true
営業チーム・メンバーの名前。 -
ResourceOrgName: string
読取り専用:
true
営業チーム・メンバーが属する組織の名前。 -
ResourcePartyNumber: string
タイトル:
Resource Party Number
このチーム・メンバーが属するリソースの代替キー識別子。 -
ResourcePhoneNumber: string
タイトル:
Phone
読取り専用:true
営業チーム・メンバーのプライマリ電話番号。 -
ResourceRoleName: string
タイトル:
Role
読取り専用:true
営業チーム・メンバーに割り当てられたロールの名前。 -
SalesProfileId: integer (int64)
タイトル:
Sales Account ID
販売アカウントの一意の識別子。 -
StartDateActive: 文字列(日付)
タイトル:
Start Date
リソースが販売アカウントに関連付けられている日付。 -
TeamMemberId: integer (int64)
タイトル:
Sales Account Resource ID
販売アカウント・リソース・チームのメンバーの一意の識別子。 -
UserLastUpdateDate: string (date-time)
タイトル:
User Last Update Date
レコードが最後に更新された日時。 更新が最初に別のデータベースで発生した場合、この値はLAST_UPDATE_DATEとは異なります。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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コマンド
次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、すべての営業チーム・メンバーを取得する方法を示しています。
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/households/CDRM_ 61285/child/SalesTeamMember
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{ "TeamMemberId": 100100019286509, "SalesProfileId": 100100018128609, "ResourceId": 100010025532138, "AccessLevelCode": "300", "LockAssignmentFlag": true, "AssignmentTypeCode": "MANUAL", "CreationDate": "2014-04-07T02:08:43-07:00", "CreatedBy": "DATA_STEWARD_MGR", "LastUpdateDate": "2014-04-07T02:08:43-07:00", "LastUpdatedBy": "DATA_STEWARD_MGR", "StartDateActive": "2014-04-07", "ResourcePartyNumber": "100010025532138", "ResourceEmailAddress": Tenng.lean@oracle.com ... }