テリトリの取得
get
/crmRestApi/resources/11.13.18.05/salesTerritories/{UniqueTerritoryNumber}
リクエスト
パス・パラメータ
- UniqueTerritoryNumber(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のデフォルト・バージョンを選択します。
ルート・スキーマ : salesTerritories-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
レコードを削除するためのアクセス権がユーザーに付与されているかどうかを示します。 値がTrueの場合、ユーザーはアクセス権を持ちます。 デフォルト値は「False」です。 -
Description: string
タイトル:
Description
最大長:240
テリトリの摘要。 -
EffectiveEndDate: 文字列(日付)
タイトル:
Effective End Date
行が有効になる日付範囲の終了日を示します。 -
EffectiveStartDate: 文字列(日付)
タイトル:
Effective Start Date
行が有効になる日付範囲の開始時点の日付を示します。 -
EligibleForQuotaFlag: boolean
タイトル:
Eligible for Quota
最大長:1
デフォルト値:false
テリトリが変更される可能性が低いため、提案された定義に対して目標を入力できるかどうかを示します。 -
ForecastedByParentTerritoryFlag: boolean
タイトル:
Forecast Invisible to Owner
最大長:1
デフォルト値:false
テリトリの親にそのテリトリの予測が含まれているかどうかを示します。 -
ForecastParticipationCode: string
タイトル:
Enable Forecasting
最大長:30
デフォルト値:REVENUE
テリトリの予測参加を示すコード(REVENUEなど)。 -
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
テリトリの最新アクティブ・バージョンを示します。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
Name: string
タイトル:
Territory Name
最大長:60
テリトリの名前。 -
OrganizationName: string
タイトル:
Organization
読取り専用:true
所有者の組織の名前。 -
Owner: string
タイトル:
Owner
最大長:360
テリトリの所有者。 -
OwnerEmail: string
タイトル:
Owner Email
読取り専用:true
最大長:320
テリトリ所有者リソースのEメール・アドレス。 -
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
テリトリが属するステータス(FINALIZEDなど)。 -
TerritoryCoverage: array Territory Coverages
タイトル:
Territory Coverages
テリトリ・カバレッジ・リソースは、テリトリに関連付けられたテリトリ・ディメンションを表示、作成、更新および削除するために使用されます。 カバレッジは、市場スペースにおけるテリトリ・チームの職責範囲を識別します。 カバレッジ・オブジェクトには、テリトリの履歴、アクティブおよび下書きバージョンのカバレッジごとに1つのレコードが含まれます。 テリトリ・バージョンには、カバレッジが関連付けられている場合と関連付けられていない場合があります。 -
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 Territory Business
タイトル:
Territory Business
テリトリ・ライン・オブ・ビジネス・リソースは、テリトリに関連付けられたライン・オブ・ビジネスを表示、作成、更新および削除するために使用されます。 -
TerritoryNumber: string
タイトル:
Territory Number
最大長:30
アクティブなテリトリの識別番号。 -
TerritoryResource: array Territory Resources
タイトル:
Territory Resources
テリトリ・リソースまたはチーム・オブジェクトは、テリトリに割り当てられたリソースを表示、作成、更新および削除するために使用されます。 たとえば、テリトリを所有する営業担当です。 -
TerritoryVersionId: integer (int64)
タイトル:
Territory Version ID
テリトリ・バージョンの識別子。 -
TerrProposalId: integer (int64)
タイトル:
Territory Proposal ID
テリトリ提案の識別子。 -
TypeCode: string
タイトル:
Type
最大長:30
デフォルト値:PRIME
テリトリのタイプを識別します。 -
UniqueTerritoryNumber: string
タイトル:
Unique Territory Number
最大長:30
テリトリの一意の識別番号。 -
UpdateFlag: boolean
読取り専用:
true
レコードを更新するためのアクセス権がユーザーに付与されているかどうかを示します。 値がTrueの場合、ユーザーはアクセス権を持ちます。 デフォルト値は「False」です。
ネストされたスキーマ : テリトリ・カバレッジ
タイプ:
array
タイトル:
Territory Coverages
テリトリ・カバレッジ・リソースは、テリトリに関連付けられたテリトリ・ディメンションを表示、作成、更新および削除するために使用されます。 カバレッジは、市場スペースにおけるテリトリ・チームの職責範囲を識別します。 カバレッジ・オブジェクトには、テリトリの履歴、アクティブおよび下書きバージョンのカバレッジごとに1つのレコードが含まれます。 テリトリ・バージョンには、カバレッジが関連付けられている場合と関連付けられていない場合があります。
ソースを表示
ネストされたスキーマ : テリトリ・ビジネス
タイプ:
array
タイトル:
Territory Business
テリトリ・ライン・オブ・ビジネス・リソースは、テリトリに関連付けられたライン・オブ・ビジネスを表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : テリトリ・リソース
タイプ:
array
タイトル:
Territory Resources
テリトリ・リソースまたはチーム・オブジェクトは、テリトリに割り当てられたリソースを表示、作成、更新および削除するために使用されます。 たとえば、テリトリを所有する営業担当です。
ソースを表示
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。
ネストされたスキーマ : salesTerritories-TerritoryCoverage-item-response
タイプ:
ソースを表示
object
-
AccountId: integer (int64)
タイトル:
Account ID
顧客包含または除外の識別子。 -
AccountName: string
タイトル:
Customer Account
読取り専用:true
最大長:360
顧客包含の名前。 -
AccountTypeCode: string
タイトル:
Account Type Code
最大長:30
テリトリ・カバレッジのアカウント・タイプのコード。 -
AddressCity: string
タイトル:
City
最大長:60
テリトリ・カバレッジの住所ディメンションの市区町村。 -
AddressCountry: string
タイトル:
Country
最大長:2
テリトリ・カバレッジの住所ディメンションの国。 -
AddressCounty: string
タイトル:
County
最大長:60
テリトリ・カバレッジの住所ディメンションの郡。 -
AddressElementAttribute1: string
タイトル:
Additional Attribute 1
最大長:150
テリトリ・カバレッジの住所ディメンションの追加属性1です。 -
AddressElementAttribute2: string
タイトル:
Additional Attribute 2
最大長:150
テリトリ・カバレッジの住所ディメンションの追加属性2です。 -
AddressElementAttribute3: string
タイトル:
Additional Attribute 3
最大長:150
テリトリ・カバレッジの住所ディメンションの追加属性3です。 -
AddressElementAttribute4: string
タイトル:
Additional Attribute 4
最大長:150
テリトリ・カバレッジの住所ディメンションの追加属性4です。 -
AddressElementAttribute5: string
タイトル:
Additional Attribute 5
最大長:150
テリトリ・カバレッジの住所ディメンションの追加属性5です。 -
AddressPostalCode: string
タイトル:
Postal Code
最大長:60
テリトリ・カバレッジの住所ディメンションの郵便番号。 -
AddressProvince: string
タイトル:
Province
最大長:60
テリトリ・カバレッジの住所ディメンションの州。 -
AddressState: string
タイトル:
State
最大長:60
テリトリ・カバレッジの住所ディメンションの状態。 -
Auxiliary1Code: string
タイトル:
Auxiliary 1 Code
最大長:30
テリトリ・カバレッジの補助1コード。 -
Auxiliary2Code: string
タイトル:
Auxiliary 2 Code
最大長:30
テリトリ・カバレッジの補助2コード。 -
Auxiliary3Code: string
タイトル:
Auxiliary 3 Code
最大長:30
テリトリ・カバレッジの補助3コード。 -
AuxiliaryDimension1: string
タイトル:
Auxiliary 1
読取り専用:true
テリトリ・カバレッジの補助1の名前。 -
AuxiliaryDimension2: string
タイトル:
Auxiliary 2
読取り専用:true
テリトリ・カバレッジの補助2の名前。 -
AuxiliaryDimension3: string
タイトル:
Auxiliary 3
読取り専用:true
テリトリ・カバレッジの補助3の名前。 -
BusinessUnitId: integer (int64)
タイトル:
Business Unit ID
テリトリ・カバレッジのビジネス・ユニットの識別子。 -
BusinessUnitName: string
タイトル:
Business Unit
最大長:255
テリトリ・カバレッジのビジネス・ユニットの名前。 -
CoverageId: integer (int64)
タイトル:
Coverage ID
テリトリ・カバレッジ・ルールの一意の識別子。 -
CoverageNumber: string
タイトル:
Coverage Number
最大長:30
テリトリ・カバレッジ・ルールの公開一意識別子。 -
CoverageTypeCode: string
タイトル:
Coverage Type Code
最大長:30
テリトリ・カバレッジ・タイプのコード。 テリトリ・カバレッジ・モデルが販売アカウント中心の場合、受け入れられる値は次のとおりです: -REGULAR (販売アカウント・ディメンションまたは指定アカウントに基づくカバレッジの場合) -INCLUSION (手動で包含されたアカウント・カバレッジの場合) -EXCLUSION (手動で除外されたアカウント・カバレッジの場合)テリトリ・カバレッジ・モデルがパートナ中心の場合、許容値は次のとおりです: -PARTNER_REGULAR (パートナ・ディメンションに基づくカバレッジの場合) -PARTNER_INCLUSION (手動で包含されたパートナ・カバレッジの場合) -PARTNER_EXCLUSION (手動で除外されたパートナ・カバレッジの場合)継承の場合、カバレッジが受信者テリトリの場合、許容値はINHERITANCE_OVERRIDEで、カバレッジが継承されたディメンションの一部を上書きすることを示します。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
テリトリ・カバレッジを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
テリトリ・カバレッジが作成された日付。 -
CustomerSizeCode: string
タイトル:
Customer Size Code
最大長:30
テリトリ・カバレッジの顧客サイズのコード。 -
DimensionName: string
タイトル:
Dimension Name
読取り専用:true
最大長:60
営業担当の職責範囲を定義するために営業テリトリで使用されるディメンションの名前。 例として、ProductディメンションとIndustryディメンションがあります。 -
Extension1: string
タイトル:
Extension 1
読取り専用:true
最大長:255
テリトリ・カバレッジの内線番号1の名前。 -
Extension10: string
タイトル:
Extension 10
読取り専用:true
最大長:255
テリトリ・カバレッジの内線番号10の名前。 -
Extension10Code: string
タイトル:
Extension 10 Code
最大長:30
テリトリ・カバレッジの拡張10コード。 -
Extension1Code: string
タイトル:
Extension 1 Code
最大長:30
テリトリ・カバレッジの拡張1コード。 -
Extension2: string
タイトル:
Extension 2
読取り専用:true
最大長:255
テリトリ・カバレッジの拡張2の名前。 -
Extension2Code: string
タイトル:
Extension 2 Code
最大長:30
テリトリ・カバレッジの拡張2コード。 -
Extension3: string
タイトル:
Extension 3
読取り専用:true
最大長:255
テリトリ・カバレッジの拡張3の名前。 -
Extension3Code: string
タイトル:
Extension 3 Code
最大長:30
テリトリ・カバレッジの拡張3コード。 -
Extension4: string
タイトル:
Extension 4
読取り専用:true
最大長:255
テリトリ・カバレッジの拡張4の名前。 -
Extension4Code: string
タイトル:
Extension 4 Code
最大長:30
テリトリ・カバレッジの拡張4コード。 -
Extension5: string
タイトル:
Extension 5
読取り専用:true
最大長:255
テリトリ・カバレッジの拡張5の名前。 -
Extension5Code: string
タイトル:
Extension 5 Code
最大長:30
テリトリ・カバレッジの拡張5コード。 -
Extension6: string
タイトル:
Extension 6
読取り専用:true
最大長:255
テリトリ・カバレッジの拡張6の名前。 -
Extension6Code: string
タイトル:
Extension 6 Code
最大長:30
テリトリ・カバレッジの拡張6コード。 -
Extension7: string
タイトル:
Extension 7
読取り専用:true
最大長:255
テリトリ・カバレッジの拡張7の名前。 -
Extension7Code: string
タイトル:
Extension 7 Code
最大長:30
テリトリ・カバレッジの拡張7コード。 -
Extension8: string
タイトル:
Extension 8
読取り専用:true
最大長:255
テリトリ・カバレッジの拡張8の名前。 -
Extension8Code: string
タイトル:
Extension 8 Code
最大長:30
テリトリ・カバレッジの拡張8コード。 -
Extension9: string
タイトル:
Extension 9
読取り専用:true
最大長:255
テリトリ・カバレッジの拡張9の名前。 -
Extension9Code: string
タイトル:
Extension 9 Code
最大長:30
テリトリ・カバレッジの拡張9コード。 -
GeographyHighId: integer (int64)
タイトル:
Geography High ID
テリトリ・カバレッジの範囲内の上位地理の識別子。 -
GeographyHighName: string
タイトル:
Geography High Name
テリトリ・カバレッジの範囲内の上位地理の名前。 -
GeographyId: integer (int64)
タイトル:
Geography ID
テリトリ・カバレッジの地理の識別子。 -
GeographyName: string
タイトル:
Geography
テリトリ・カバレッジの地理の名前。 これには、事業所を一意に識別するために、地理のフルパスが含まれる場合があります。たとえば、United States>New Hampshire>Manchesterなどです。 -
IncludeHierarchyFlag: boolean
タイトル:
Include Hierarchy
最大長:1
ディメンション・メンバーが階層とともに含まれているかどうかを示します。 デフォルト値はtrueです。 -
IndustryCode: string
タイトル:
Industry Code
最大長:30
テリトリ・カバレッジの産業のコード。 -
IndustryName: string
タイトル:
Industry
読取り専用:true
テリトリ・カバレッジの産業の名前。 -
InventoryItemId: integer (int64)
タイトル:
Inventory Item ID
テリトリ・カバレッジの在庫品目の識別子。 -
InventoryOrgId: integer (int64)
タイトル:
Inventory Organization ID
テリトリ・カバレッジの在庫組織の識別子。 -
ItemName: string
タイトル:
Item Name
読取り専用:true
最大長:240
テリトリ・カバレッジの品目の名前。 -
ItemNumber: string
タイトル:
Item Number
読取り専用:true
最大長:300
テリトリ・カバレッジの品目の番号。 -
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
リソース・インスタンスに関連付けられたリンク関係。 -
OrganizationType: string
タイトル:
Organization Type
読取り専用:true
テリトリ・カバレッジの組織タイプの名前。 -
OrganizationTypeCode: string
タイトル:
Organization Type Code
最大長:30
テリトリ・カバレッジの組織タイプのコード。 -
OriginalReference: string
タイトル:
Original Reference
最大長:300
アカウントまたは担当者のソース・システム参照。 -
PartnerId: integer (int64)
タイトル:
Partner ID
パートナの包含または除外の識別子。 -
PartnerName: string
タイトル:
Partner
読取り専用:true
最大長:360
パートナ包含の名前。 -
PartnerNumber: string
タイトル:
Partner Number
最大長:30
パートナの包含または除外の公開一意識別子。 -
ProductGroupId: integer (int64)
タイトル:
Product Group ID
テリトリ・カバレッジの製品グループの識別子。 -
ProductGroupName: string
タイトル:
Product Group Name
読取り専用:true
最大長:250
テリトリ・カバレッジの製品グループの名前。 -
ProductGroupNumber: string
タイトル:
Product Group Number
最大長:50
テリトリ・カバレッジの製品グループの番号。 -
RegistryId: string
タイトル:
Registry ID
読取り専用:true
最大長:30
顧客包含の公開一意識別子。 -
SalesChannelCode: string
タイトル:
Sales Channel Code
最大長:30
テリトリ・カバレッジの販売チャネルのコード。 -
SubSalesChannelCode: string
タイトル:
Subsales Channel Code
最大長:30
テリトリ・カバレッジのサブ販売チャネルのコード。 -
TerrDimensionCode: string
タイトル:
Territory Dimension Code
最大長:5
テリトリ・ディメンションを示すコード。 たとえば、AcTyp、Acct、Aux1、Aux2、Aux3、BUnit、CSize、Geo、Indst、OrgTp、Prod、Prtnr、SChnlなどです。 -
TerritoryVersionId: integer (int64)
タイトル:
Territory Version ID
テリトリ・バージョンの一意の識別子。 -
UniqueTerritoryNumber: string
タイトル:
Unique Territory Number
最大長:30
テリトリの公開一意識別子。
ネストされたスキーマ : salesTerritories-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
テリトリの公開一意識別子。
ネストされたスキーマ : salesTerritories-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
リソースの電子メール・アドレス。 -
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
リソース・マネージャからのテリトリ・リソースの公開一意識別子。 -
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
テリトリの公開一意識別子。
リンク
- EnabledTypeCodesViewAccessor
-
パラメータ:
- ファインダ:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMOT_TERRITORY_TYPE%2CBindLookupCode%3D{TypeCode}
PRIMEやOVERLAYなど、テリトリ・タイプの値リスト。
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: TypeCode;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
- ExtendedResourcePickerViewAccessor
-
テリトリ所有者リソースの値リスト。 テリトリ所有者は、テリトリの営業を担当する個人です。
LOVリンク関連では、次のプロパティが定義されます:
- ソース属性: 所有者、ターゲット属性: ResourceName
- 表示属性: ResourceName, PrimaryPhoneNumber, EmailAddress, OrganizationName, RoleName, ReportsTo
- LookupYesNoViewAccessor
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BBindLookupType%3DYES_NO
テリトリの予測が親テリトリ・レベルで行われるかどうかを示す値リスト。 有効な値ははいおよびいいえです。
LOVリンク関連では、次のプロパティが定義されます:
- ソース属性: ForecastedByParentTerritoryFlag;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
- PartnerPickerPVOViewAccessor
-
テリトリ・パートナの名前の値リスト。 テリトリ・タイプがパートナの場合、テリトリ・パートナはテリトリに関連付けられたパートナ組織を識別します。
LOVリンク関連では、次のプロパティが定義されます:
- ソース属性: PartnerName;ターゲット属性: PartyName
- 表示属性: PartyName
- TerritoryCoverage
-
操作: /crmRestApi/resources/11.13.18.05/salesTerritories/{UniqueTerritoryNumber}/child/TerritoryCoverageパラメータ:
- UniqueTerritoryNumber:
$request.path.UniqueTerritoryNumber
テリトリ・カバレッジ・リソースは、テリトリに関連付けられたテリトリ・ディメンションを表示、作成、更新および削除するために使用されます。 カバレッジは、市場スペースにおけるテリトリ・チームの職責範囲を識別します。 カバレッジ・オブジェクトには、テリトリの履歴、アクティブおよび下書きバージョンのカバレッジごとに1つのレコードが含まれます。 テリトリ・バージョンには、カバレッジが関連付けられている場合と関連付けられていない場合があります。 - UniqueTerritoryNumber:
- TerritoryFunctionViewAccessor
-
パラメータ:
- ファインダ:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MOT_TERRITORY_FUNCTION%2CBindLookupCode%3D{TerritoryFunctionCode}
プライマリ・サポートや営業サポートなど、テリトリの機能の値リスト。
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: TerritoryFunctionCode;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
- TerritoryLineOfBusiness
-
パラメータ:
- UniqueTerritoryNumber:
$request.path.UniqueTerritoryNumber
テリトリ・ライン・オブ・ビジネス・リソースは、テリトリに関連付けられたライン・オブ・ビジネスを表示、作成、更新および削除するために使用されます。 - UniqueTerritoryNumber:
- TerritoryResource
-
操作: /crmRestApi/resources/11.13.18.05/salesTerritories/{UniqueTerritoryNumber}/child/TerritoryResourceパラメータ:
- UniqueTerritoryNumber:
$request.path.UniqueTerritoryNumber
テリトリ・リソースまたはチーム・オブジェクトは、テリトリに割り当てられたリソースを表示、作成、更新および削除するために使用されます。 たとえば、テリトリを所有する営業担当です。 - UniqueTerritoryNumber:
- ValidForecastParticipationCodeViewAccessor
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BBindLookupType%3DORA_MOT_TERR_ENABLE_FCASTING
売上や非売上など、売上予想参加の値リスト。 テリトリ予測参加は、テリトリが予測されているかどうか、およびはいの場合は、テリトリが収益予測に参加しているかどうか、非収益予測に参加しているかどうか、またはその両方であることを示します。
LOVリンク関連では、次のプロパティが定義されます:
- ソース属性: ForecastParticipationCode;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
- ValidRevisionReasonViewAccessor
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BBindLookupType%3DMOT_QUOTA_REASON
追加されたリソース、ディメンション変更など、目標を改訂するためのユーザー定義事由の値リスト。 テリトリ改訂事由は、テリトリの目標を改訂する事由を目標管理者に説明します。
LOVリンク関連では、次のプロパティが定義されます:
- ソース属性: RevisionReason;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
- ValidStatusCodeViewAccessor
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BBindLookupType%3DMOT_TERRITORY_VERSION_STATUS
テリトリ・バージョン・ステータスの値リスト(DRAFTやFINALIZEDなど)。
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: StatusCode;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
- ValidateCoverageModel
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BBindLookupType%3DMOT_TERR_COVERAGE_MODEL
テリトリのディメンションがアカウント属性またはパートナ属性(顧客中心やパートナ中心など)に基づいているかどうかを示す値リスト。
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: CoverageModel;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
例:
次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、販売のテリトリを取得する方法を示しています。
cURLコマンド
curl --user sales_cloud_user https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesTerritories/CDRM_461
レスポンス本文の例
次に、JSON形式のレスポンス本文の例を示します。
{ "items": [ { "CreatedBy": "SALES_ADMINISTRATOR", "CreationDate": "2009-09-18T12:17:28.981+00:00", "Description": null, "EffectiveEndDate": "2010-01-18", "EffectiveStartDate": "2009-09-18", "LastUpdateDate": "2010-10-26T10:33:42.135+00:00", "LastUpdateLogin": "9388825E902FEE67E04044987CF065D5", "LastUpdatedBy": "SALES_ADMIN", "Name": "AMQA Germany Account 2", "TerritoryVersionId": 100000054003703, "OwnerResourceId": 100010025531586, "ParentTerritoryId": 100000013121095, "StatusCode": "FINALIZED", "TerrProposalId": 100000014936001, "TerritoryId": 100000013121165, "TerritoryLevel": 6, "TypeCode": "PRIME", "Owner": "Bob Bennett", "LatestVersionFlag": true, "PartnerId": null, "PartnerProgramId": null, "ForecastParticipationCode": "REVENUE", "SourceTerrId": null, "RevisionReason": null, "RevisionDescription": null, "ReviseQuotaFlag": null, "EligibleForQuotaFlag": true, "SourceTerrVersionId": null, "PartnerName": null, "ProgramName": null, "OrganizationName": null, "SourceTerrName": "None", "SourceTerrLastUpdateDate": null, "CoverageModel": "SALES_ACCOUNT_CENTRIC", "ForecastedByParentTerritoryFlag": false, "OwnerEmail": "sendmail-test-discard@oracle.com", "TerritoryNumber": "CDRM_461", "ParentTerritoryLovSwitcher": "LOV_ParentTerritoryId", "UpdateFlag": true, "DeleteFlag": true, "ParentTerritoryNumber": "CDRM_462", "OwnerTrans": "Bob Bennett", "TerritoryFunctionCode": null, "ParentTerritoryTrans": "AMQA Germany License and Consulting", "UniqueTerritoryNumber": "CDRM_461", "OwnerResourceNumber": "100010025531586", "ProposalNumber": "CDRM_190", "PartnerNumber": null, "ParentUniqueTerritoryNumber": "CDRM_X_100000054003656", "SourceUniqueTerritoryNumber": null, "TerritoryHierarchyUniqueTerritoryNumber": null, "R10_SalesTerritory_Text_c": null, "R10_SalesTerritory_Number_c": null, "R10_SalesTerritory_Date_c": null, "R10_SalesTerritory_CheckBox_c": null, "R10_SalesTerritory_Perc_c": null, "R10_SalesTerritory_DateTime_c": null, "R10_SalesTerritory_Currency_c": null, "R10_SalesTerritory_FixChList_c": null, "R10_SalesTerritory_DynChList_Id_c": null, "R10_SalesTerritory_DynChList_c": null, "R10_SalesTerritory_RecType_c": null, "Email_c": null, "TMTXT_c": null, "TM_Num_c": null, "Cust_Owner_c": null, "Cust_Assignee_c": null, "TestTextForService_c": null, "R11_Sales_Territory_Text_Field_c": null, "R11_Sales_Terriotry_Number_Fld_c": null, "R11_Sales_Territory_Date_c": null, "R11_Sales_Territory_Checkbox_c": null, "R11_TM_PGCOM_NUM_c": null, "R11_TM_Cust_Text_c": null, "R11_Cust_Owner1_c": null, "R11_Cust__c": null, "R11_Cust_email_to_c": null, "R10_SalesTerritory_RecType_cMeaning": null, "R12R13Upg_Text_c": null, "R12R13Upg_Num_c": null, "R12R13Upg_Date_c": null, "Text_CloneLayout_c": null, "ST_Text1_c": null, "ST_Text2_c": null, "ST_Text3_c": null, "links": [ ... }
ノート:
テリトリには任意の数のカバレッジを使用できます。 ただし、問合せ当たりのレコード数は数万に制限することをお勧めします。 たとえば、50000レコードを取得する問合せは、curl -u <username:password> \\ -Xhttps://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories?limit=50000
です。 さらに、数万のテリトリ・カバレッジ・レコードを問い合せるときに、クライアント・アプリケーションで適切なゲートウェイ・タイムアウトを構成できます。