Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

機械翻訳について

すべてのテリトリ・カバレッジの取得

get

/crmRestApi/resources/11.13.18.05/salesTerritories/{UniqueTerritoryNumber}/child/TerritoryCoverage

リクエスト

パス・パラメータ

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
finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。

フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

使用可能なファインダ名および対応するファインダ変数を次に示します:
- CoverageNumberFinder : 指定した公開一意識別子でテリトリ・カバレッジ・ルールを検索します。
  ファインダ変数:
  - CoverageNumber; string;テリトリ・カバレッジ・ルールの公開一意識別子。
- PrimaryKey : 指定した主キーでテリトリ・カバレッジ・ルールを検索します。
  ファインダ変数:
  - CoverageId; integer;テリトリ・カバレッジ・ルールの一意の識別子。
- TerritoryCoverageAltKeyFinder : 指定した代替キーを持つテリトリ・カバレッジ・ルールを検索します。
  ファインダ変数:
  - CoverageNumber; string;テリトリ・カバレッジ・ルールの公開一意識別子。
  - UniqueTerritoryNumber; string;テリトリの公開一意識別子。
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問合せパラメータを使用してこの収集リソースをフィルタできます:
- AccountId; integer;顧客包含または除外の識別子。
- AccountName; string;顧客包含の名前。
- AccountTypeCode; string;テリトリ・カバレッジのアカウント・タイプのコード。
- AddressCity; string;テリトリ・カバレッジの住所ディメンションの市区町村。
- AddressCountry; string;テリトリ・カバレッジの住所ディメンションの国。
- AddressCounty; string;テリトリ・カバレッジの住所ディメンションの郡。
- AddressElementAttribute1; string;テリトリ・カバレッジの住所ディメンションの追加属性1。
- AddressElementAttribute2; string;テリトリ・カバレッジの住所ディメンションの追加属性2。
- AddressElementAttribute3; string;テリトリ・カバレッジの住所ディメンションの追加属性3。
- AddressElementAttribute4; string;テリトリ・カバレッジの住所ディメンションの追加属性4。
- AddressElementAttribute5; string;テリトリ・カバレッジの住所ディメンションの追加属性5。
- AddressPostalCode; string;テリトリ・カバレッジの住所ディメンションの郵便番号。
- AddressProvince; string;テリトリ・カバレッジの住所ディメンションの州。
- AddressState; string;テリトリ・カバレッジの住所ディメンションの状態。
- Auxiliary1Code; string;テリトリ・カバレッジの補助1コード。
- Auxiliary2Code; string;テリトリ・カバレッジの補助2コード。
- Auxiliary3Code; string;テリトリ・カバレッジの補助3コード。
- AuxiliaryDimension1; string;テリトリ・カバレッジの補助1の名前。
- AuxiliaryDimension2; string;テリトリ・カバレッジの補助2の名前。
- AuxiliaryDimension3; string;テリトリ・カバレッジの補助3の名前。
- BusinessUnitId; integer;テリトリ・カバレッジのビジネス・ユニットの識別子。
- BusinessUnitName; string;テリトリ・カバレッジのビジネス・ユニットの名前。
- CoverageId; integer;テリトリ・カバレッジ・ルールの一意の識別子。
- CoverageNumber; string;テリトリ・カバレッジ・ルールの公開一意識別子。
- CoverageTypeCode; string;テリトリ・カバレッジ・タイプのコード。テリトリ・カバレッジ・モデルが販売アカウント中心の場合、受け入れられる値は次のとおりです: -REGULAR (販売アカウント・ディメンションまたは指定アカウントに基づくカバレッジの場合) -INCLUSION (手動で包含されたアカウント・カバレッジの場合) -EXCLUSION (手動で除外されたアカウント・カバレッジの場合)テリトリ・カバレッジ・モデルがパートナ中心の場合、許容値は次のとおりです: -PARTNER_REGULAR (パートナ・ディメンションに基づくカバレッジの場合) -PARTNER_INCLUSION (手動で包含されたパートナ・カバレッジの場合) -PARTNER_EXCLUSION (手動で除外されたパートナ・カバレッジの場合)継承の場合、カバレッジが受信者テリトリの場合、許容値はINHERITANCE_OVERRIDEで、カバレッジが継承されたディメンションの一部を上書きすることを示します。
- CreatedBy; string;テリトリ・カバレッジを作成したユーザー。
- CreationDate; string;テリトリ・カバレッジが作成された日付。
- CustomerSizeCode; string;テリトリ・カバレッジにおける顧客サイズのコード。
- DimensionName; string; 営業担当の職責範囲を定義するために営業テリトリで使用されるディメンションの名前。例として、ProductディメンションとIndustryディメンションがあります。
- Extension1; string; テリトリ・カバレッジの内線番号1の名前。
- Extension10; string; テリトリ・カバレッジの内線番号10の名前。
- Extension10Code; string;テリトリ・カバレッジの拡張10コード。
- Extension1Code; string; テリトリ・カバレッジの内線番号1コード。
- Extension2; string;テリトリ・カバレッジの拡張子2の名前。
- Extension2Code; string;テリトリ・カバレッジの拡張2コード。
- Extension3; string;テリトリ・カバレッジの拡張子3の名前。
- Extension3Code; string;テリトリ・カバレッジの拡張3コード。
- Extension4; string;テリトリ・カバレッジの拡張子4の名前。
- Extension4Code; string;テリトリ・カバレッジの拡張4コード。
- Extension5; string; テリトリ・カバレッジの内線番号5の名前。
- Extension5Code; string;テリトリ・カバレッジの拡張5コード。
- Extension6; string; テリトリ・カバレッジの内線番号6の名前。
- Extension6Code; string;テリトリ・カバレッジの拡張6コード。
- Extension7; string; テリトリ・カバレッジの内線番号7の名前。
- Extension7Code; string;テリトリ・カバレッジの拡張7コード。
- Extension8; string;テリトリ・カバレッジ内の拡張子8の名前。
- Extension8Code; string;テリトリ・カバレッジの拡張8コード。
- Extension9; string;テリトリ・カバレッジの拡張子9の名前。
- Extension9Code; string;テリトリ・カバレッジの拡張9コード。
- GeographyHighId; integer;テリトリ・カバレッジの範囲内の上位地理の識別子。
- GeographyHighName; string;テリトリ・カバレッジの範囲内の上位地理の名前。
- GeographyId; integer;テリトリ・カバレッジの地理の識別子。
- GeographyName; string;テリトリ・カバレッジの地理の名前。これには、事業所を一意に識別するために、地理のフルパスが含まれる場合があります。たとえば、United States>New Hampshire>Manchesterなどです。
- IncludeHierarchyFlag; boolean。ディメンション・メンバーが階層とともに含まれるかどうかを示します。デフォルト値はtrueです。
- IndustryCode; string;テリトリ・カバレッジの産業のコード。
- IndustryName; string;テリトリ・カバレッジの業種の名前。
- InventoryItemId; integer;テリトリ・カバレッジの在庫品目の識別子。
- InventoryOrgId; integer;テリトリ・カバレッジの在庫組織の識別子。
- ItemName; string;テリトリ・カバレッジの項目の名前。
- ItemNumber; string;テリトリ・カバレッジの項目の番号。
- LastUpdateDate; string;テリトリ・カバレッジが最後に更新された日付。
- LastUpdateLogin; string;テリトリ・カバレッジを最後に更新したユーザーのログイン。
- LastUpdatedBy; string;テリトリ・カバレッジを最後に更新したユーザー。
- OrganizationType; string;テリトリ・カバレッジの組織タイプの名前。
- OrganizationTypeCode; string;テリトリ・カバレッジの組織タイプのコード。
- OriginalReference; string;アカウントまたは担当者の起点ソース・システム参照。
- PartnerId; integer;パートナの包含または除外の識別子。
- PartnerName; string;パートナ包含の名前。
- PartnerNumber; string;パートナの包含または除外の公開一意識別子。
- ProductGroupId; integer;テリトリ・カバレッジの製品グループの識別子。
- ProductGroupName; string;テリトリ・カバレッジの製品グループの名前。
- ProductGroupNumber; string;テリトリ・カバレッジの製品グループの番号。
- RegistryId; string;顧客包含の公開一意識別子。
- SalesChannelCode; string;テリトリ・カバレッジの販売チャネルのコード。
- SubSalesChannelCode; string;テリトリ・カバレッジのサブ販売チャネルのコード。
- TerrDimensionCode; string; テリトリ・ディメンションを示すコード。たとえば、AcTyp、Acct、Aux1、Aux2、Aux3、BUnit、CSize、Geo、Indst、OrgTp、Prod、Prtnr、SChnlなどです。
- TerritoryVersionId; integer;テリトリ・バージョンの一意の識別子。
- UniqueTerritoryNumber; 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のデフォルト・バージョンを選択します。

ルート・スキーマ : salesTerritories-TerritoryCoverage

タイプ: 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"の場合の推定行数。それ以外の場合、カウントは含まれません。

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/salesTerritories-TerritoryCoverage-item-response"
            }
        }
    }
}

ネストされたスキーマ : アイテム

タイプ: array

タイトル: Items

コレクション内のアイテム。

ソースを表示

Array of: object salesTerritories-TerritoryCoverage-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/salesTerritories-TerritoryCoverage-item-response"
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : 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

テリトリの公開一意識別子。

{
    "type":"object",
    "properties":{
        "Extension7":{
            "title":"Extension 7",
            "maxLength":255,
            "type":"string",
            "description":"The extension 7 name in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the territory coverage was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Extension8":{
            "title":"Extension 8",
            "maxLength":255,
            "type":"string",
            "description":"The extension 8 name in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UniqueTerritoryNumber":{
            "title":"Unique Territory Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the territory.",
            "nullable":true,
            "x-queryable":true
        },
        "Extension9":{
            "title":"Extension 9",
            "maxLength":255,
            "type":"string",
            "description":"The extension 9 name in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountId":{
            "title":"Account ID",
            "type":"integer",
            "description":"The identifier for the customer inclusion or exclusion.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "GeographyId":{
            "title":"Geography ID",
            "type":"integer",
            "description":"The identifier for the geography in the territory coverage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartnerId":{
            "title":"Partner ID",
            "type":"integer",
            "description":"The identifier of the partner inclusion or exclusion.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Extension1":{
            "title":"Extension 1",
            "maxLength":255,
            "type":"string",
            "description":"The extension 1 name in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Extension3Code":{
            "title":"Extension 3 Code",
            "maxLength":30,
            "type":"string",
            "description":"The extension 3 code in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "Extension2":{
            "title":"Extension 2",
            "maxLength":255,
            "type":"string",
            "description":"The extension 2 name in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductGroupName":{
            "title":"Product Group Name",
            "maxLength":250,
            "type":"string",
            "description":"The name for the product group in the territory coverage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Extension3":{
            "title":"Extension 3",
            "maxLength":255,
            "type":"string",
            "description":"The extension 3 name in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubSalesChannelCode":{
            "title":"Subsales Channel Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the sub sales channel in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "Extension4":{
            "title":"Extension 4",
            "maxLength":255,
            "type":"string",
            "description":"The extension 4 name in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Extension5":{
            "title":"Extension 5",
            "maxLength":255,
            "type":"string",
            "description":"The extension 5 name in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Extension6":{
            "title":"Extension 6",
            "maxLength":255,
            "type":"string",
            "description":"The extension 6 name in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Extension1Code":{
            "title":"Extension 1 Code",
            "maxLength":30,
            "type":"string",
            "description":"The extension 1 code in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressCity":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"The city of the address dimension in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "AuxiliaryDimension1":{
            "title":"Auxiliary 1",
            "type":"string",
            "description":"The auxiliary 1 name in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "Auxiliary1Code"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AuxiliaryDimension3":{
            "title":"Auxiliary 3",
            "type":"string",
            "description":"The auxiliary 3 name in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AuxiliaryDimension2":{
            "title":"Auxiliary 2",
            "type":"string",
            "description":"The auxiliary 2 name in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GeographyHighName":{
            "title":"Geography High Name",
            "type":"string",
            "description":"The name for the higher geography in the range in the territory coverage.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "GeographyHighId"
                ]
            },
            "x-queryable":true
        },
        "Extension4Code":{
            "title":"Extension 4 Code",
            "maxLength":30,
            "type":"string",
            "description":"The extension 4 code in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "IndustryName":{
            "title":"Industry",
            "type":"string",
            "description":"The name of the industry in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the territory coverage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the territory coverage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IndustryCode":{
            "title":"Industry Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the industry in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "Extension5Code":{
            "title":"Extension 5 Code",
            "maxLength":30,
            "type":"string",
            "description":"The extension 5 code in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "title":"Inventory Item ID",
            "type":"integer",
            "description":"The identifier for the inventory item in the territory coverage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BusinessUnitId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"The identifier for the business unit in the territory coverage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InventoryOrgId":{
            "title":"Inventory Organization ID",
            "type":"integer",
            "description":"The identifier for the inventory organization in the territory coverage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartnerName":{
            "title":"Partner",
            "maxLength":360,
            "type":"string",
            "description":"The name of the partner inclusion.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Auxiliary1Code":{
            "title":"Auxiliary 1 Code",
            "maxLength":30,
            "type":"string",
            "description":"The auxiliary 1 code in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerSizeCode":{
            "title":"Customer Size Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the customer size in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "Extension6Code":{
            "title":"Extension 6 Code",
            "maxLength":30,
            "type":"string",
            "description":"The extension 6 code in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "TerritoryVersionId":{
            "title":"Territory Version ID",
            "type":"integer",
            "description":"The unique identifier of territory version.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AccountTypeCode":{
            "title":"Account Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the account type in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "SalesChannelCode":{
            "title":"Sales Channel Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the sales channel in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressProvince":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "description":"The province of the address dimension in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "CoverageNumber":{
            "title":"Coverage Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the territory coverage rule.",
            "nullable":false,
            "x-queryable":true
        },
        "GeographyHighId":{
            "title":"Geography High ID",
            "type":"integer",
            "description":"The identifier for the higher geography in the range in the territory coverage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AddressElementAttribute1":{
            "title":"Additional Attribute 1",
            "maxLength":150,
            "type":"string",
            "description":"The additional attribute 1 of the address dimension in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "RegistryId":{
            "title":"Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the customer inclusion.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressElementAttribute2":{
            "title":"Additional Attribute 2",
            "maxLength":150,
            "type":"string",
            "description":"The additional attribute 2 of the address dimension in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressElementAttribute3":{
            "title":"Additional Attribute 3",
            "maxLength":150,
            "type":"string",
            "description":"The additional attribute 3 of the address dimension in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "TerrDimensionCode":{
            "title":"Territory Dimension Code",
            "maxLength":5,
            "type":"string",
            "description":"The code indicating the territory dimension. For example, AcTyp, Acct, Aux1, Aux2, Aux3, BUnit, CSize, Geo, Indst, OrgTp, Prod, Prtnr, or SChnl.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductGroupNumber":{
            "title":"Product Group Number",
            "maxLength":50,
            "type":"string",
            "description":"The number for the product group in the territory coverage.",
            "nullable":false,
            "x-queryable":true
        },
        "AccountName":{
            "title":"Customer Account",
            "maxLength":360,
            "type":"string",
            "description":"The name of the customer inclusion.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressElementAttribute4":{
            "title":"Additional Attribute 4",
            "maxLength":150,
            "type":"string",
            "description":"The additional attribute 4 of the address dimension in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginalReference":{
            "title":"Original Reference",
            "maxLength":300,
            "type":"string",
            "description":"The origin source system reference of the account or contact.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressElementAttribute5":{
            "title":"Additional Attribute 5",
            "maxLength":150,
            "type":"string",
            "description":"The additional attribute 5 of the address dimension in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "Extension7Code":{
            "title":"Extension 7 Code",
            "maxLength":30,
            "type":"string",
            "description":"The extension 7 code in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationTypeCode":{
            "title":"Organization Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the organization type in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "Auxiliary3Code":{
            "title":"Auxiliary 3 Code",
            "maxLength":30,
            "type":"string",
            "description":"The auxiliary 3 code in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressCountry":{
            "title":"Country",
            "maxLength":2,
            "type":"string",
            "description":"The country of the address dimension in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressPostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the address dimension in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressCounty":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "description":"The county of the address dimension in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Item Number",
            "maxLength":300,
            "type":"string",
            "description":"The number for the item in the territory coverage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CoverageId":{
            "title":"Coverage ID",
            "type":"integer",
            "description":"The unique identifier of the territory coverage rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Extension8Code":{
            "title":"Extension 8 Code",
            "maxLength":30,
            "type":"string",
            "description":"The extension 8 code in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "Extension9Code":{
            "title":"Extension 9 Code",
            "maxLength":30,
            "type":"string",
            "description":"The extension 9 code in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemName":{
            "title":"Item Name",
            "maxLength":240,
            "type":"string",
            "description":"The name for the item in the territory coverage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessUnitName":{
            "title":"Business Unit",
            "maxLength":255,
            "type":"string",
            "description":"The name for the business unit in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "Auxiliary2Code":{
            "title":"Auxiliary 2 Code",
            "maxLength":30,
            "type":"string",
            "description":"The auxiliary 2 code in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "Extension10Code":{
            "title":"Extension 10 Code",
            "maxLength":30,
            "type":"string",
            "description":"The extension 10 code in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "CoverageTypeCode":{
            "title":"Coverage Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the territory coverage type.\nIf the territory coverage model is sales account centric, the accepted values are:\n-REGULAR (for coverage based on sales account dimensionality or named accounts)\n-INCLUSION (for manually included account coverage)\n-EXCLUSION (for manually excluded account coverage)\nIf the territory coverage model is partner centric, the accepted values are:\n-PARTNER_REGULAR (for coverage based on partner dimensionality)\n-PARTNER_INCLUSION (for manually included partner coverage)\n-PARTNER_EXCLUSION (for manually excluded partner coverage)\nIn case of inheritance, if the coverage is for a recipient territory, then the accepted value is INHERITANCE_OVERRIDE which indicates that the coverage overrides some of the inherited dimensionality.",
            "nullable":false,
            "x-queryable":true
        },
        "ProductGroupId":{
            "title":"Product Group ID",
            "type":"integer",
            "description":"The identifier for the product group in the territory coverage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "GeographyName":{
            "title":"Geography",
            "type":"string",
            "description":"The name of the geography in the territory coverage. This may include the full path of the geography in order to uniquely identify the location, for example; >United States>New Hampshire>Manchester.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "GeographyId"
                ]
            },
            "x-queryable":true
        },
        "OrganizationType":{
            "title":"Organization Type",
            "type":"string",
            "description":"The name of the organization type in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IncludeHierarchyFlag":{
            "title":"Include Hierarchy",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the dimension member is included along with its hierarchy or not. The default value is true.",
            "nullable":true,
            "x-queryable":true
        },
        "Extension10":{
            "title":"Extension 10",
            "maxLength":255,
            "type":"string",
            "description":"The extension 10 name in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DimensionName":{
            "title":"Dimension Name",
            "maxLength":60,
            "type":"string",
            "description":"The name of a dimension used in sales territories to define the area of responsibility for the salesperson. Examples are the Product and Industry dimensions.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartnerNumber":{
            "title":"Partner Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the partner inclusion or exclusion.",
            "nullable":false,
            "x-queryable":true
        },
        "Extension2Code":{
            "title":"Extension 2 Code",
            "maxLength":30,
            "type":"string",
            "description":"The extension 2 code in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the territory coverage was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressState":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"The state of the address dimension in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : リンク

タイプ: 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

changeIndicator: string

リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

「トップに戻る」