テリトリ・カバレッジの作成
post
/crmRestApi/resources/11.13.18.05/salesTerritories/{UniqueTerritoryNumber}/child/TerritoryCoverage
リクエスト
パス・パラメータ
- UniqueTerritoryNumber(required): string
テリトリの一意の識別番号。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
- Upsert-Mode:
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。
サポートされるメディア・タイプ
- application/json
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ:
ソースを表示
object-
AccountId: integer (int64)
タイトル:
Account ID顧客包含または除外の識別子。 -
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コード。 -
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で、カバレッジが継承されたディメンションの一部を上書きすることを示します。 -
CustomerSizeCode: string
タイトル:
Customer Size Code最大長:30テリトリ・カバレッジの顧客サイズのコード。 -
Extension10Code: string
タイトル:
Extension 10 Code最大長:30テリトリ・カバレッジの拡張10コード。 -
Extension1Code: string
タイトル:
Extension 1 Code最大長:30テリトリ・カバレッジの拡張1コード。 -
Extension2Code: string
タイトル:
Extension 2 Code最大長:30テリトリ・カバレッジの拡張2コード。 -
Extension3Code: string
タイトル:
Extension 3 Code最大長:30テリトリ・カバレッジの拡張3コード。 -
Extension4Code: string
タイトル:
Extension 4 Code最大長:30テリトリ・カバレッジの拡張4コード。 -
Extension5Code: string
タイトル:
Extension 5 Code最大長:30テリトリ・カバレッジの拡張5コード。 -
Extension6Code: string
タイトル:
Extension 6 Code最大長:30テリトリ・カバレッジの拡張6コード。 -
Extension7Code: string
タイトル:
Extension 7 Code最大長:30テリトリ・カバレッジの拡張7コード。 -
Extension8Code: string
タイトル:
Extension 8 Code最大長:30テリトリ・カバレッジの拡張8コード。 -
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テリトリ・カバレッジの産業のコード。 -
InventoryItemId: integer (int64)
タイトル:
Inventory Item IDテリトリ・カバレッジの在庫品目の識別子。 -
InventoryOrgId: integer (int64)
タイトル:
Inventory Organization IDテリトリ・カバレッジの在庫組織の識別子。 -
OrganizationTypeCode: string
タイトル:
Organization Type Code最大長:30テリトリ・カバレッジの組織タイプのコード。 -
OriginalReference: string
タイトル:
Original Reference最大長:300アカウントまたは担当者のソース・システム参照。 -
PartnerId: integer (int64)
タイトル:
Partner IDパートナの包含または除外の識別子。 -
PartnerNumber: string
タイトル:
Partner Number最大長:30パートナの包含または除外の公開一意識別子。 -
ProductGroupId: integer (int64)
タイトル:
Product Group IDテリトリ・カバレッジの製品グループの識別子。 -
ProductGroupNumber: string
タイトル:
Product Group Number最大長:50テリトリ・カバレッジの製品グループの番号。 -
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テリトリの公開一意識別子。
応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : 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テリトリの公開一意識別子。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。