すべてのテリトリの取得
get
/crmRestApi/resources/11.13.18.05/territories
リクエスト
問合せパラメータ
- 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>
使用可能なファインダ名および対応するファインダ変数を次に示します:- ActiveTerritoriesFinder: BindSysEffectiveDate変数で指定された日付時点でアクティブなすべてのテリトリを検索します。
ファインダ変数:- BindSysEffectiveDate; string;このバインド変数は、有効日エンティティ・オブジェクトから自動的に移入されます。 このバインド変数には値を入力しないでください。
- PrimaryKey : 指定した主キーでテリトリを検索します。
ファインダ変数:- TerritoryVersionId; integer;テリトリ・バージョンの一意の識別子。
- UniqueTerritoryNumberFinder : UniqueTerritoryNumber変数に指定された値を持つすべてのテリトリを検索します。
ファインダ変数:- UniqueTerritoryNumber; string;テリトリの一意のテリトリ番号。
- ActiveTerritoriesFinder: BindSysEffectiveDate変数で指定された日付時点でアクティブなすべてのテリトリを検索します。
- 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問合せパラメータを使用してこの収集リソースをフィルタできます:
- CoverageModel; string; テリトリのディメンションがアカウント属性またはパートナ属性に基づいているかどうかを示します。
- CreatedBy; string;テリトリを作成したユーザー。
- CreationDate; string;テリトリが作成された日付。
- 説明;文字列;テリトリの説明。
- EffectiveEndDate; string;テリトリ・バージョンが非アクティブになる日時。
- EffectiveStartDate; string;テリトリ・バージョンがアクティブになる日時。 StatusCodeがDRAFTの場合、この値は空である必要があります。 それ以外の場合は、StatusCodeがFINALIZEDの場合、この値は今日の日付にする必要があります。
- EligibleForQuotaFlag; boolean;テリトリの再編成中にテリトリが変更されるかどうかを示します。 値がTrueの場合、メジャー再編成中にテリトリが変更される可能性は低いため、提案された定義に対して目標を入力できます。 デフォルト値はtrueです。
- ForecastParticipationCode; string;予測参加のコード。 使用可能な値は次のとおりです: REVENUE、NONREVENUE、REVENUE_AND_NONREVENUEおよびNON_FORECASTING。
- ForecastedByParentTerritoryFlag; boolean;テリトリの予測が親テリトリによって作成されたかどうかを示します。 デフォルト値はfalseです。
- LastUpdateDate; string;テリトリが最後に更新された日付。
- LastUpdateLogin; string;テリトリを最後に更新したユーザーのログイン。
- LastUpdatedBy; string;テリトリを最後に更新したユーザー。
- LatestVersionFlag; boolean;テリトリが最新のアクティブ・バージョンであるかどうかを示します。 値がTrueの場合、テリトリ・バージョンはテリトリの最新アクティブ・バージョンです。
- Name; string;テリトリの名前。
- Owner; string;テリトリの所有者。
- OwnerEmail; string; 所有者の電子メール・アドレス。
- OwnerResourceId; integer;所有者リソースの一意の識別子。
- OwnerResourceNumber; string;所有者のレジストリID。
- ParentTerritoryId; integer;親テリトリの一意の識別子。
- ParentTerritoryLovSwitcher; string;フィールドは、UIでの親テリトリ値リストの表示を制御します。 この属性は内部目的で使用されます。
- ParentTerritoryNumber; string;親テリトリの番号。
- ParentUniqueTerritoryNumber; string; 親テリトリの一意のテリトリ番号。
- PartnerId; integer;テリトリに関連付けられたパートナの一意の識別子。
- PartnerName; string;テリトリに関連付けられたパートナの名前。
- PartnerNumber; string;パートナの番号。
- PartnerProgramId; integer; パートナが登録されているパートナ・プログラムの一意の識別子。
- ProgramName; string;パートナが登録されているパートナ・プログラムの名前。
- ProposalNumber; string;テリトリが関連付けられている提案の番号。
- ReviseQuotaFlag; boolean;送信した割当てを改訂する必要があるかどうかを示します。
- RevisionDescription; string;割り当てを改訂する理由の説明。
- RevisionReason; string; クォータを変更するためのユーザー定義の理由。
- SourceTerrId; integer; ディメンションの継承元のテリトリの一意の識別子。
- SourceTerrLastUpdateDate; string; ソース・テリトリが最後に更新された日時。 この属性は、ソース・テリトリからの受信者テリトリによるディメンションの継承に関連しています。
- SourceTerrName; string;選択したディメンションの継承元となるテリトリの名前。
- SourceTerrVersionId; integer;ソース・テリトリ・バージョンの一意の識別子。
- SourceUniqueTerritoryNumber; string; ソース・テリトリの一意のテリトリ番号。
- StatusCode; string; テリトリのステータスを示すコード。 受け入れられる値は、DRAFTおよびFINALIZEDです。
- TerrProposalId; integer;テリトリ提案の一意の識別子。
- TerritoryFunctionCode;文字列;テリトリに関連付けられたビジネス機能
- TerritoryHierarchyUniqueTerritoryNumber; string; エクスポートする階層の最上位にあるテリトリの一意の代替識別子。
- TerritoryId; integer;テリトリの一意の識別子。
- TerritoryLevel; integer;テリトリ階層内のテリトリのレベル。
- TerritoryNumber; string;テリトリの一意の代替識別番号。
- TerritoryVersionId; integer;テリトリ・バージョンの一意の識別子。
- TypeCode; string; テリトリのタイプを示すコード。 たとえば、PRIMEやOVERLAYです。
- UniqueTerritoryNumber;文字列;このテリトリの一意の識別番号
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : テリトリ
タイプ:
ソースを表示
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"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : territories-item-response
タイプ:
ソースを表示
object
-
CoverageModel: string
タイトル:
Coverage
最大長:30
デフォルト値:SALES_ACCOUNT_CENTRIC
テリトリのディメンションがアカウント属性またはパートナ属性に基づいているかどうかを示します。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
テリトリを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
テリトリが作成された日付。 -
DeleteFlag: boolean
読取り専用:
true
ログイン・ユーザーがテリトリを削除できるかどうかを示します。 -
Description: string
タイトル:
Description
最大長:240
テリトリの摘要。 -
EffectiveEndDate: 文字列(日付)
タイトル:
Effective End Date
テリトリ・バージョンが非アクティブになる日時。 -
EffectiveStartDate: 文字列(日付)
タイトル:
Effective Start Date
テリトリ・バージョンがアクティブになる日時。 StatusCodeがDRAFTの場合、この値は空である必要があります。 それ以外の場合は、StatusCodeがFINALIZEDの場合、この値は今日の日付にする必要があります。 -
EligibleForQuotaFlag: boolean
タイトル:
Eligible for Quota
最大長:1
デフォルト値:false
テリトリの再編成中にテリトリが変更されるかどうかを示します。 値がTrueの場合、メジャー再編成中にテリトリが変更される可能性は低いため、提案された定義に対して目標を入力できます。 デフォルト値はtrueです。 -
ForecastedByParentTerritoryFlag: boolean
タイトル:
Forecast Invisible to Owner
最大長:1
デフォルト値:false
テリトリの予測が親テリトリによって作成されたかどうかを示します。 デフォルト値はfalseです。 -
ForecastParticipationCode: string
タイトル:
Enable Forecasting
最大長:30
デフォルト値:REVENUE
予測参加のコード。 使用可能な値は次のとおりです: REVENUE、NONREVENUE、REVENUE_AND_NONREVENUEおよびNON_FORECASTING。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
テリトリが最後に更新された日付。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
テリトリを最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login
読取り専用:true
最大長:32
テリトリを最後に更新したユーザーのログイン。 -
LatestVersionFlag: boolean
タイトル:
Latest Version
最大長:1
デフォルト値:true
テリトリが最新のアクティブ・バージョンであるかどうかを示します。 値がTrueの場合、テリトリ・バージョンはテリトリの最新アクティブ・バージョンです。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
Name: string
タイトル:
Territory Name
最大長:60
テリトリの名前。 -
OrganizationName: string
タイトル:
Organization
読取り専用:true
所有者が属する組織の名前。 -
Owner: string
タイトル:
Owner
最大長:360
テリトリの所有者。 -
OwnerEmail: string
タイトル:
Owner Email
読取り専用:true
最大長:320
所有者の電子メール・アドレス。 -
OwnerResourceId: integer (int64)
タイトル:
Resource ID
所有者リソースの一意の識別子。 -
OwnerResourceNumber: string
タイトル:
Owner Registry ID
読取り専用:true
最大長:30
所有者のレジストリID。 -
OwnerTrans: string
タイトル:
Owner
最大長:255
所有者の名前。 -
ParentTerritoryId: integer (int64)
タイトル:
Parent Territory ID
親テリトリの一意の識別子。 -
ParentTerritoryLovSwitcher: string
このフィールドは、UIでの親テリトリ値リストの表示を制御します。 この属性は内部目的で使用されます。
-
ParentTerritoryNumber: string
タイトル:
Parent Territory Number
読取り専用:true
最大長:30
親テリトリの数。 -
ParentTerritoryTrans: string
親テリトリの名前。
-
ParentUniqueTerritoryNumber: string
タイトル:
Parent Territory Unique Number
最大長:30
親テリトリの一意のテリトリ番号。 -
PartnerId: integer (int64)
タイトル:
Partner ID
テリトリに関連付けられたパートナの一意の識別子。 -
PartnerName: string
タイトル:
Partner
最大長:360
テリトリに関連付けられたパートナの名前。 -
PartnerNumber: string
タイトル:
Partner Number
最大長:30
パートナの番号。 -
PartnerProgramId: integer (int64)
タイトル:
Partner Program ID
パートナが登録されているパートナ・プログラムの一意の識別子。 -
ProgramName: string
タイトル:
Partner Program
最大長:150
パートナが登録されているパートナ・プログラムの名前。 -
ProposalNumber: string
タイトル:
Proposal Number
最大長:30
テリトリが関連付けられている提案の番号。 -
ReviseQuotaFlag: boolean
タイトル:
Revise Quota
最大長:1
送信した目標を改訂する必要があるかどうかを示します。 -
RevisionDescription: string
タイトル:
Revision Description
最大長:1000
目標を改訂する理由の説明。 -
RevisionReason: string
タイトル:
Revision Reason
最大長:30
目標を改訂するためのユーザー定義の事由。 -
SourceTerrId: integer (int64)
タイトル:
Source Territory ID
ディメンションの継承元となるテリトリの一意の識別子。 -
SourceTerrLastUpdateDate: string (date-time)
タイトル:
Source Territory Last Update Date
ソース・テリトリが最後に更新された日時。 この属性は、ソース・テリトリからの受信者テリトリによるディメンションの継承に関連しています。 -
SourceTerrName: string
タイトル:
Source Territory
最大長:60
選択したディメンションの継承元となるテリトリの名前。 -
SourceTerrVersionId: integer (int64)
タイトル:
Source Territory Version ID
ソース・テリトリ・バージョンの一意の識別子。 -
SourceUniqueTerritoryNumber: string
タイトル:
Source Unique Territory Number
最大長:30
ソース・テリトリの一意のテリトリ番号。 -
StatusCode: string
タイトル:
Status
最大長:30
デフォルト値:DRAFT
テリトリのステータスを示すコード。 受け入れられる値は、DRAFTおよびFINALIZEDです。 -
TerritoryFunctionCode: string
タイトル:
Territory Function
最大長:30
テリトリに関連付けられたビジネス機能 -
TerritoryHierarchyUniqueTerritoryNumber: string
タイトル:
Territory Hierarchy Unique Territory Number
読取り専用:true
最大長:30
エクスポートする階層の最上位にあるテリトリの一意の代替識別子。 -
TerritoryId: integer (int64)
タイトル:
Territory ID
テリトリの一意の識別子。 -
TerritoryLevel: integer (int64)
タイトル:
Territory Level
テリトリ階層内のテリトリのレベル。 -
TerritoryLineOfBusiness: array Line of Business
タイトル:
Line of Business
ライン・オブ・ビジネス・リソースは、営業テリトリに関連付けられたライン・オブ・ビジネスを表示するために使用されます。 ライン・オブ・ビジネスは、会社または組織が提供する製品またはサービスを説明する一般的な用語です。 ライン・オブ・ビジネス・オブジェクトには、テリトリの履歴、アクティブおよび下書きバージョンのすべてのライン・オブ・ビジネスが含まれます。 営業テリトリにライン・オブ・ビジネスを関連付けることはオプションです。 -
TerritoryNumber: string
タイトル:
Territory Number
最大長:30
テリトリの一意の代替識別番号。 -
TerritoryResource: array Resources
タイトル:
Resources
リソース・リソースは、営業テリトリに関連付けられた所有者や営業担当などのリソースを表示するために使用されます。 リソースの同等の機能用語はチーム・メンバーです。 リソース・オブジェクトには、テリトリの履歴、アクティブおよび下書きバージョンのすべてのチーム・メンバーが含まれます。 各営業テリトリには所有者がいる必要があるため、各営業テリトリ・バージョンには少なくとも1つのリソース・レコードがあります。 -
TerritoryRule: array Rules
タイトル:
Rules
ルール・リソースは、営業テリトリに関連付けられたテリトリ・ルールを表示するために使用されます。 ルールの同等の機能用語はカバレッジです。 カバレッジは、市場空間の営業テリトリ・チームの職責範囲を識別するものです。 ルール・オブジェクトには、履歴、アクティブおよび下書きのテリトリ・バージョンのカバレッジごとに1つのレコードが含まれます。 テリトリ・バージョンには、カバレッジが関連付けられている場合と関連付けられていない場合があります。 -
TerritoryVersionId: integer (int64)
タイトル:
Territory Version ID
テリトリ・バージョンの一意の識別子。 -
TerrProposalId: integer (int64)
タイトル:
Territory Proposal ID
テリトリ提案の一意の識別子。 -
TypeCode: string
タイトル:
Type
最大長:30
デフォルト値:PRIME
テリトリのタイプを示すコード。 たとえば、PRIMEやOVERLAYです。 -
UniqueTerritoryNumber: string
タイトル:
Unique Territory Number
最大長:30
このテリトリの一意の識別番号 -
UpdateFlag: boolean
読取り専用:
true
ログイン・ユーザーがテリトリを更新できるかどうかを示します。
ネストされたスキーマ : 取扱商品
タイプ:
array
タイトル:
Line of Business
ライン・オブ・ビジネス・リソースは、営業テリトリに関連付けられたライン・オブ・ビジネスを表示するために使用されます。 ライン・オブ・ビジネスは、会社または組織が提供する製品またはサービスを説明する一般的な用語です。 ライン・オブ・ビジネス・オブジェクトには、テリトリの履歴、アクティブおよび下書きバージョンのすべてのライン・オブ・ビジネスが含まれます。 営業テリトリにライン・オブ・ビジネスを関連付けることはオプションです。
ソースを表示
ネストされたスキーマ : リソース
タイプ:
array
タイトル:
Resources
リソース・リソースは、営業テリトリに関連付けられた所有者や営業担当などのリソースを表示するために使用されます。 リソースの同等の機能用語はチーム・メンバーです。 リソース・オブジェクトには、テリトリの履歴、アクティブおよび下書きバージョンのすべてのチーム・メンバーが含まれます。 各営業テリトリには所有者がいる必要があるため、各営業テリトリ・バージョンには少なくとも1つのリソース・レコードがあります。
ソースを表示
ネストされたスキーマ : ルール
タイプ:
array
タイトル:
Rules
ルール・リソースは、営業テリトリに関連付けられたテリトリ・ルールを表示するために使用されます。 ルールの同等の機能用語はカバレッジです。 カバレッジは、市場空間の営業テリトリ・チームの職責範囲を識別するものです。 ルール・オブジェクトには、履歴、アクティブおよび下書きのテリトリ・バージョンのカバレッジごとに1つのレコードが含まれます。 テリトリ・バージョンには、カバレッジが関連付けられている場合と関連付けられていない場合があります。
ソースを表示
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。
ネストされたスキーマ : territories-TerritoryLineOfBusiness-item-response
タイプ:
ソースを表示
object
-
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
テリトリ取扱商品を作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
テリトリ取扱商品が作成された日付。 -
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
リソース・インスタンスに関連付けられたリンク関係。 -
LobCode: string
タイトル:
Line of Business Code
最大長:30
ライン・オブ・ビジネスのコード。 -
Meaning: string
タイトル:
Line of Business
読取り専用:true
最大長:80
事業部門の意味。 -
TerritoryVersionId: integer (int64)
タイトル:
Territory Version ID
テリトリ・バージョンの一意の識別子。 -
TerrLobId: integer (int64)
タイトル:
Line of Business ID
ライン・オブ・ビジネスの一意の識別子。 -
UniqueTerritoryNumber: string
タイトル:
Unique Territory Number
最大長:30
テリトリ取扱商品の一意のテリトリ番号。
ネストされたスキーマ : territories-TerritoryResource-item-response
タイプ:
ソースを表示
object
-
AdministratorFlag: boolean
タイトル:
Team Member Administrator
最大長:1
リソースがテリトリの管理者であるかどうかを示します。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
テリトリ・チーム・メンバーを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
テリトリ・チーム・メンバーが作成された日付。 -
Email: string
タイトル:
Email
読取り専用:true
最大長:320
テリトリ・チーム・メンバーのEメール・アドレス。 -
FunctionCode: string
タイトル:
Team Member Function
最大長:30
テリトリに関連付けられたリソースの機能のコード。 -
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
リソース・インスタンスに関連付けられたリンク関係。 -
ManageForecastFlag: boolean
タイトル:
Forecasting Delegate
最大長:1
テリトリ・リソースに、テリトリの所有者の代理でテリトリ予測を管理する職責が付与されているかどうかを示します。 -
Manager: string
読取り専用:
true
最大長:360
マネージャの名前。 -
OrganizationName: string
タイトル:
Organization
読取り専用:true
最大長:240
組織の名前。 -
OwnerFlag: boolean
タイトル:
Owner
読取り専用:true
テリトリ・チーム・メンバーが所有者かどうかを示します。 -
ResourceId: integer (int64)
タイトル:
Resource ID
リソース・マネージャからのリソースの一意の識別子。 -
ResourceName: string
タイトル:
Resource Name
読取り専用:true
最大長:360
テリトリに関連付けられたリソースの名前。 -
ResourceNumber: string
タイトル:
Resource Registry ID
読取り専用:true
最大長:30
テリトリ・チーム・メンバーのレジストリID。 -
RoleName: string
タイトル:
Team Member Role
読取り専用:true
最大長:60
リソースに関連付けられているチーム・メンバー・ロールの名前。 -
TerritoryVersionId: integer (int64)
タイトル:
Territory Version ID
テリトリ・バージョンの一意の識別子。 -
TerrResourceId: integer (int64)
タイトル:
Territory Resource ID
テリトリ・リソースの一意の識別子。 -
UniqueTerritoryNumber: string
タイトル:
Unique Territory Number
最大長:30
テリトリ・チーム・メンバーの一意のテリトリ番号。
ネストされたスキーマ : territories-TerritoryRule-item-response
タイプ:
ソースを表示
object
-
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:255
テリトリ・ルールを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
テリトリ・ルールが作成された日付。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
テリトリ・ルールが最後に更新された日付。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:255
テリトリ・ルールを最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login
読取り専用:true
最大長:255
テリトリ・ルールを最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
RuleNumber: integer (int64)
タイトル:
Coverage Number
テリトリのカバレッジ番号。 -
RuleOperatorCode: string
タイトル:
Customer Coverage Code
最大長:30
デフォルト値:INCLUSION
カバレッジがテリトリの管轄に対して追加または削除されるかどうかを識別するためのコード。 使用可能な値は次のとおりです: EXCLUSION (ルール・タイプEXCLUSIONおよびPARTNER_EXCLUSIONの場合)およびINCLUSION (REGULAR、INCLUSION、PARTNER_REGULAR、PARTNER_INCLUSION、INHERITANCE_OVERRIDEなど、他のすべてのルール・タイプの場合)。 -
RuleTypeCode: string
タイトル:
Coverage
最大長:30
デフォルト値:REGULAR
テリトリ・カバレッジ・タイプのコード。 テリトリ・カバレッジ・モデルが販売アカウント中心の場合、受け入れられる値は次のとおりです: -REGULAR (販売アカウント・ディメンションまたは指定アカウントに基づくカバレッジの場合) -INCLUSION (手動で包含されたアカウント・カバレッジの場合) -EXCLUSION (手動で除外されたアカウント・カバレッジの場合)テリトリ・カバレッジ・モデルがパートナ中心の場合、許容値は次のとおりです: -PARTNER_REGULAR (パートナ・ディメンションに基づくカバレッジの場合) -PARTNER_INCLUSION (手動で包含されたパートナ・カバレッジの場合) -PARTNER_EXCLUSION (手動で除外されたパートナ・カバレッジの場合)継承の場合、カバレッジが受信者テリトリの場合、許容値はINHERITANCE_OVERRIDEで、カバレッジが継承されたディメンションの一部を上書きすることを示します。 -
TerritoryRuleBoundary1: array Rule Boundaries
タイトル:
Rule Boundaries
ルール境界リソースは、営業テリトリに関連付けられたルール境界を表示するために使用されます。 ルール境界の同等の機能用語はカバレッジ・ディメンションです。 ルール境界オブジェクトには、特定のテリトリ・カバレッジに定義されている各ディメンションのレコードが含まれます。 -
TerritoryVersionId: integer (int64)
タイトル:
Territory Number
テリトリ・バージョンの一意の識別子。 -
TerrRuleId: integer (int64)
タイトル:
Coverage ID
テリトリ・ルールの一意の識別子。
ネストされたスキーマ : ルール境界
タイプ:
array
タイトル:
Rule Boundaries
ルール境界リソースは、営業テリトリに関連付けられたルール境界を表示するために使用されます。 ルール境界の同等の機能用語はカバレッジ・ディメンションです。 ルール境界オブジェクトには、特定のテリトリ・カバレッジに定義されている各ディメンションのレコードが含まれます。
ソースを表示
ネストされたスキーマ : territories-TerritoryRule-TerritoryRuleBoundary1-item-response
タイプ:
ソースを表示
object
-
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
テリトリ・ルール境界を作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
テリトリ・ルール境界が作成された日付。 -
Dimension: string
タイトル:
Dimension
読取り専用:true
最大長:60
ディメンションの名前。 -
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
リソース・インスタンスに関連付けられたリンク関係。 -
TerrDimensionCode: string
タイトル:
Dimension
最大長:5
地理ディメンションの地理、製品ディメンションの製品など、テリトリ・ディメンションを示すコード。 -
TerritoryRuleBndryValue1: array Rule Boundary Values
タイトル:
Rule Boundary Values
ルール境界値リソースは、営業テリトリに関連付けられたルール境界値を表示するために使用されます。 ルール境界値の同等の機能期間は、カバレッジ・ディメンション・メンバーです。 ルール境界値オブジェクトには、各カバレッジ・ディメンションのディメンション・メンバーのレコードが含まれます。 -
TerrRuleBoundaryId: integer (int64)
タイトル:
Territory Dimension ID
テリトリ・ルール境界の一意の識別子。 -
TerrRuleId: integer (int64)
タイトル:
Territory Number
テリトリ・ルールの識別子。
ネストされたスキーマ : ルール境界値
タイプ:
array
タイトル:
Rule Boundary Values
ルール境界値リソースは、営業テリトリに関連付けられたルール境界値を表示するために使用されます。 ルール境界値の同等の機能期間は、カバレッジ・ディメンション・メンバーです。 ルール境界値オブジェクトには、各カバレッジ・ディメンションのディメンション・メンバーのレコードが含まれます。
ソースを表示
ネストされたスキーマ : territories-TerritoryRule-TerritoryRuleBoundary1-TerritoryRuleBndryValue1-item-response
タイプ:
ソースを表示
object
-
AddrElementAttribute1: string
タイトル:
Additional Attribute 1
最大長:150
柔軟な住所書式をサポートするための追加住所要素。 -
AddrElementAttribute2: string
タイトル:
Additional Attribute 2
最大長:150
柔軟な住所書式をサポートするための追加住所要素。 -
AddrElementAttribute3: string
タイトル:
Additional Attribute 3
最大長:150
柔軟な住所書式をサポートするための追加住所要素。 -
AddrElementAttribute4: string
タイトル:
Additional Attribute 4
最大長:150
柔軟な住所書式をサポートするための追加住所要素。 -
AddrElementAttribute5: string
タイトル:
Additional Attribute 5
最大長:150
柔軟な住所書式をサポートするための追加住所要素。 -
AddressCity: string
タイトル:
City
最大長:60
市区町村 -
AddressCountry: string
タイトル:
Country
最大長:2
国 -
AddressCounty: string
タイトル:
County
最大長:60
County -
AddressPostalCode: string
タイトル:
Postal Code
最大長:60
郵便番号 -
AddressProvince: string
タイトル:
Province
最大長:60
Province -
AddressState: string
タイトル:
State
最大長:60
都道府県。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
テリトリ・ルール境界値を作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
テリトリ・ルール境界値が作成された日付。 -
DimensionMember: string
テリトリ・ディメンション・メンバーの名前。
-
DimensionMemberHigh: string
タイトル:
Territory Dimension Member High
読取り専用:true
最大長:360
連番が高いテリトリ・ディメンション・メンバーの名前。 -
IncludeHierarchyFlag: boolean
タイトル:
Include Hierarchy
最大長:1
ディメンション・メンバーが階層とともに含まれているかどうかを示します。 デフォルト値はtrueです。 -
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
リソース・インスタンスに関連付けられたリンク関係。 -
TerrDimensionCode: string
タイトル:
Dimension
最大長:5
テリトリ・ディメンションを示すコード。 たとえば、AcTyp、Acct、Aux1、Aux2、Aux3、BUnit、CSize、Geo、Indst、OrgTp、Prod、Prtnr、SChnlなどです。 -
TerrDimHighIntgId: string
タイトル:
Dimension Value Range
最大長:80
順序番号が大きいOracle Business Intelligence (OBI)、テリトリ管理およびキューブの共通メンバーの一意の識別子。 -
TerrDimIntgId: string
タイトル:
Dimension Value
最大長:80
Oracle Business Intelligence (OBI)、テリトリ管理およびキューブの共通メンバーの一意の識別子。 -
TerrRuleBndryValueId: integer (int64)
タイトル:
Territory Dimension Member ID
テリトリ・ルール境界値の一意の識別子。 -
TerrRuleBoundaryId: integer (int64)
タイトル:
Territory Number
テリトリ・ルール境界の識別子。
例:
次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、すべてのテリトリを取得する方法を示しています。
cURLコマンド
curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories
レスポンス本文の例
次に、JSON形式のレスポンス本文の例を示します。
{ items: [25] 0: { EffectiveEndDate: "4713-01-31" EffectiveStartDate: "2010-01-13" Name: "APAC Sales QA Organization Type" TerritoryVersionId: 100000015312131 OwnerResourceId: 100010032635399 ParentTerritoryId: 100000015312038 StatusCode: "FINALIZED" TerrProposalId: 100000015312024 TerritoryId: 100000015312130 TerritoryLevel: 3 TypeCode: "PRIME" LatestVersionFlag: true ... }