すべてのアカウント・チーム・メンバーの取得
get
/crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountTeam
リクエスト
パス・パラメータ
- PartyNumber(required): string
アカウント・パーティの一意の代替識別子。 プロファイル・オプションHZ_GENERATE_PARTY_NUMBERがTrueに設定されている場合、値を更新できます。 デフォルト値は、プロファイル・オプションZCA_PUID_PREFIXで指定された値と一意のシステム生成順序番号を連結した値です。 非アクティブなレコードは更新できません。
問合せパラメータ
- 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 : 指定した主キーを持つアカウント・チームを検索します。
ファインダ変数:- AccountTeamId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
- AccessLevelCode; string; リソース階層内の組織のアカウント・チーム・メンバー、マネージャおよび管理者に付与されるアクセス・レベル。
- AccountTeamId; integer; アカウント・チーム・メンバーを識別する一意のキー。
- AddedOnDateTime; string;リソースがアカウント・リソースに追加された日付またはテリトリがアカウント・テリトリに追加された日付に基づいて、アカウント・チーム・メンバーが作成された日付。
- AssignmentTypeCode; string; リソースがアカウント・チームに追加される方法を示します。 たとえば、アドホックは、リソースが手動またはルール・ベースの割当によって追加されたことを示し、テリトリは、そのリソースがテリトリ・ベースの割当によって追加されたことを示します。
- City; string;リソースの市。
- CorpCurrencyCode; string; アカウントに関連付けられた企業通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
- Country; string;リソースの国コード。
- CreatedBy; string; アカウント・チーム・メンバーを作成したユーザー。
- CreationDate; string;レコードが作成された日付。
- CurcyConvRateType; string;通貨換算レート・タイプ。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
- CurrencyCode; string;通貨コード。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
- EndDateActive; string; アカウント・チーム・メンバーがアクティブである終了日。
- ForecastParticipationCode; string;テリトリの予測参加タイプ。
- FunctionCode; string;テリトリ・チーム・メンバーの機能またはロールのコード。
- LastUpdateDate; string; アカウント・チームが最後に更新された日付。
- LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン。
- LastUpdatedBy; string; アカウント・チーム・レコードを最後に更新したユーザー。
- LockAssignmentFlag; boolean;自動割当によって、アカウント・チーム・メンバーをチームから削除できないことを示します。
- MemberFunctionCode; string; アカウント・チーム・メンバー関数のコード。
- ObjectVersionNumber; integer;オブジェクト・バージョン番号。
- PartyId; integer;アカウントの一意の識別子。
- ResourceEmailAddress; string;リソースの電子メール・アドレス。
- ResourceId; integer; アカウント・チームに関連付けられたリソース・パーティの一意の識別子。
- ResourceName; string;アカウント・チーム・メンバーのフルネーム。
- ResourcePartyNumber; string;リソースのパーティ番号。
- SalesProfileId; integer;販売アカウントの一意の識別子。
- StartDateActive; string; アカウント・チーム・メンバーがアクティブである開始日。
- State; string;リソースの状態。
- TeamMemberId; integer;アカウント・リソースの一意の識別子。
- TerritoryFunctionCode; string;テリトリのビジネス機能のコード。
- TerritoryName; string;取引先チームに関連付けられたテリトリの名前。
- TerritoryNumber; string;テリトリの番号。
- TerritoryVersionId; integer;テリトリ・ベース割当を介してアカウントに割り当てられたリソースのテリトリ・バージョンの一意の識別子。
- TypeCode; string; アカウント・チームに関連付けられているテリトリのタイプのコード。
- UserLastUpdateDate; 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のデフォルト・バージョンを選択します。
ルート・スキーマ : accounts-AccountTeam
タイプ:
ソースを表示
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"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : accounts-AccountTeam-item-response
タイプ:
ソースを表示
object
-
AccessLevelCode: string
タイトル:
Access
読取り専用:true
最大長:30
リソース階層内の組織のアカウント・チーム・メンバー、マネージャおよび管理者に付与されるアクセス・レベル。 -
AccountTeamId: integer (int64)
取引先チーム・メンバーを識別する一意のキー。
-
AddedOnDateTime: string (date-time)
タイトル:
Joining Date
アカウント・リソースにリソースが追加された日付またはテリトリがアカウント・テリトリに追加された日付に基づいて、アカウント・チーム・メンバーが作成された日付。 -
AssignmentTypeCode: string
読取り専用:
true
最大長:30
リソースがアカウント・チームに追加される方法を示します。 たとえば、アドホックは、リソースが手動またはルール・ベースの割当によって追加されたことを示し、テリトリは、そのリソースがテリトリ・ベースの割当によって追加されたことを示します。 -
City: string
タイトル:
City
読取り専用:true
最大長:60
リソースの市区町村。 -
CorpCurrencyCode: string
読取り専用:
true
最大長:15
アカウントに関連付けられた企業通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
Country: string
タイトル:
Country
読取り専用:true
最大長:2
リソースの国コード。 -
CreatedBy: string
読取り専用:
true
最大長:64
取引先チーム・メンバーを作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
レコードが作成された日付。 -
CurcyConvRateType: string
読取り専用:
true
最大長:30
通貨換算レート・タイプ。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
CurrencyCode: string
読取り専用:
true
最大長:15
通貨コード。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
EndDateActive: 文字列(日付)
読取り専用:
true
取引先チーム・メンバーがアクティブな終了日。 -
ForecastParticipationCode: string
タイトル:
Enable Forecasting
読取り専用:true
最大長:30
デフォルト値:REVENUE
テリトリの予測参加タイプ。 -
FunctionCode: string
タイトル:
Function
読取り専用:true
最大長:30
テリトリ・チーム・メンバーの機能またはロールのコード。 -
LastUpdateDate: string (date-time)
読取り専用:
true
取引先チームが最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
取引先チーム・レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
レコードを最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
LockAssignmentFlag: boolean
タイトル:
Locked
読取り専用:true
最大長:1
自動割当によってアカウント・チーム・メンバーをチームから削除できないことを示します。 -
MemberFunctionCode: string
タイトル:
Function
読取り専用:true
最大長:30
アカウント・チーム・メンバー機能のコード。 -
ObjectVersionNumber: 整数(int32)
読取り専用:
true
オブジェクト・バージョン番号。 -
OwnerFlag: boolean
読取り専用:
true
取引先チーム・メンバーが取引先の所有者であるかどうかを示します。 -
PartyId: integer (int64)
アカウントの一意の識別子。
-
PrimaryPhoneNumber: string
タイトル:
Primary Phone
読取り専用:true
リソースのプライマリ書式付き電話番号。 -
ResourceEmailAddress: string
読取り専用:
true
最大長:320
リソースのEメール・アドレス。 -
ResourceId: integer (int64)
アカウント・チームに関連付けられたリソース・パーティの一意の識別子。
-
ResourceName: string
タイトル:
Name
読取り専用:true
最大長:360
取引先チーム・メンバーの正式名。 -
ResourcePartyNumber: string
タイトル:
Registry ID
読取り専用:true
最大長:30
リソースのパーティ番号。 -
ResourceRoleName: string
読取り専用:
true
最大長:255
アカウント・チームに関連付けられたリソースのロール。 -
SalesProfileId: integer (int64)
販売アカウントの一意の識別子。
-
StartDateActive: 文字列(日付)
読取り専用:
true
取引先チーム・メンバーがアクティブである開始日。 -
State: string
タイトル:
State
読取り専用:true
最大長:60
リソースの状態。 -
TeamMemberId: integer (int64)
読取り専用:
true
アカウント・リソースの一意の識別子。 -
TerritoryFunctionCode: string
タイトル:
Territory Function
読取り専用:true
最大長:30
テリトリのビジネス機能のコード。 -
TerritoryName: string
タイトル:
Territory Name
読取り専用:true
最大長:60
取引先チームに関連付けられているテリトリの名前。 -
TerritoryNumber: string
タイトル:
Number
読取り専用:true
最大長:30
テリトリの番号。 -
TerritoryOwnerFlag: boolean
読取り専用:
true
アカウント・チーム・メンバーがテリトリ所有者であるかどうかを示します。 -
TerritoryVersionId: integer
テリトリ・ベース割当を介してアカウントに割り当てられたリソースのテリトリ・バージョンの一意の識別子。
-
TypeCode: string
タイトル:
Type
読取り専用:true
最大長:30
デフォルト値:PRIME
アカウント・チームに関連付けられているテリトリのタイプのコード。 -
UserLastUpdateDate: string (date-time)
読取り専用:
true
取引先チーム・メンバーが最後に更新された日時。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。