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

機械翻訳について

テリトリのルールの作成

post

/crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryRule

リクエスト

パス・パラメータ

TerritoryVersionId(required): integer(int64)

テリトリ・バージョンの一意の識別子。

ヘッダー・パラメータ

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

ソースを表示

RuleNumber(required): 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(required): integer (int64)

タイトル: Territory Number

テリトリ・バージョンの一意の識別子。
TerrRuleId: integer (int64)

タイトル: Coverage ID

テリトリ・ルールの一意の識別子。

{
    "required":[
        "RuleNumber",
        "TerritoryVersionId"
    ],
    "type":"object",
    "properties":{
        "RuleTypeCode":{
            "title":"Coverage",
            "maxLength":30,
            "type":"string",
            "description":"The code for the territory coverage type.\n\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)\n\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)\n\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":true,
            "default":"REGULAR"
        },
        "TerritoryVersionId":{
            "title":"Territory Number",
            "type":"integer",
            "description":"The unique identifier of the territory version.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RuleNumber":{
            "title":"Coverage Number",
            "type":"integer",
            "description":"The coverage number for the territory.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TerritoryRuleBoundary1":{
            "title":"Rule Boundaries",
            "type":"array",
            "description":"The rule boundaries resource is used to view the rule boundaries associated with a sales territory. The equivalent functional term for rule boundary is coverage dimension. The rule boundaries object contains records for each of the dimensions defined for a given territory coverage.",
            "items":{
                "$ref":"#/components/schemas/territories-TerritoryRule-TerritoryRuleBoundary1-item-post-request"
            }
        },
        "TerrRuleId":{
            "title":"Coverage ID",
            "type":"integer",
            "description":"The unique identifier of the territory rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RuleOperatorCode":{
            "title":"Customer Coverage Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for identifying whether the coverage adds to or removes from the territory's jurisdiction. The accepted values are: EXCLUSION (for rule type EXCLUSION and PARTNER_EXCLUSION) and INCLUSION (for all other rule types, such as REGULAR, INCLUSION, PARTNER_REGULAR, PARTNER_INCLUSION, and INHERITANCE_OVERRIDE).",
            "nullable":true,
            "default":"INCLUSION"
        }
    }
}

ネストされたスキーマ : ルール境界

タイプ: array

タイトル: Rule Boundaries

ルール境界リソースは、営業テリトリに関連付けられたルール境界を表示するために使用されます。ルール境界の同等の機能用語はカバレッジ・ディメンションです。ルール境界オブジェクトには、特定のテリトリ・カバレッジに定義されている各ディメンションのレコードが含まれます。

ソースを表示

Array of: object territories-TerritoryRule-TerritoryRuleBoundary1-item-post-request

{
    "title":"Rule Boundaries",
    "type":"array",
    "description":"The rule boundaries resource is used to view the rule boundaries associated with a sales territory. The equivalent functional term for rule boundary is coverage dimension. The rule boundaries object contains records for each of the dimensions defined for a given territory coverage.",
    "items":{
        "$ref":"#/components/schemas/territories-TerritoryRule-TerritoryRuleBoundary1-item-post-request"
    }
}

ネストされたスキーマ : territories-TerritoryRule-TerritoryRuleBoundary1-item-post-request

タイプ: object

ソースを表示

TerrDimensionCode(required): string

タイトル: Dimension

最大長: 5

地理ディメンションの地理、製品ディメンションの製品など、テリトリ・ディメンションを示すコード。
TerritoryRuleBndryValue1: array Rule Boundary Values

タイトル: Rule Boundary Values

ルール境界値リソースは、営業テリトリに関連付けられたルール境界値を表示するために使用されます。ルール境界値の同等の機能期間は、カバレッジ・ディメンション・メンバーです。ルール境界値オブジェクトには、各カバレッジ・ディメンションのディメンション・メンバーのレコードが含まれます。
TerrRuleBoundaryId: integer (int64)

タイトル: Territory Dimension ID

テリトリ・ルール境界の一意の識別子。
TerrRuleId(required): integer (int64)

タイトル: Territory Number

テリトリ・ルールの識別子。

{
    "required":[
        "TerrDimensionCode",
        "TerrRuleId"
    ],
    "type":"object",
    "properties":{
        "TerritoryRuleBndryValue1":{
            "title":"Rule Boundary Values",
            "type":"array",
            "description":"The rule boundary values resource is used to view the rule boundary values associated with a sales territory. The equivalent functional term for rule boundary value is coverage dimension member. The rule boundary values object contains records for the dimension members for each coverage dimension.",
            "items":{
                "$ref":"#/components/schemas/territories-TerritoryRule-TerritoryRuleBoundary1-TerritoryRuleBndryValue1-item-post-request"
            }
        },
        "TerrRuleBoundaryId":{
            "title":"Territory Dimension ID",
            "type":"integer",
            "description":"The unique identifier of the territory rule boundary.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TerrDimensionCode":{
            "title":"Dimension",
            "maxLength":5,
            "type":"string",
            "description":"The code indicating the territory dimension, such as Geo for Geography Dimension, Prod for Product Dimension, and so on.",
            "nullable":false
        },
        "TerrRuleId":{
            "title":"Territory Number",
            "type":"integer",
            "description":"The identifier of the territory rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

ネストされたスキーマ : ルール境界値

タイプ: array

タイトル: Rule Boundary Values

ルール境界値リソースは、営業テリトリに関連付けられたルール境界値を表示するために使用されます。ルール境界値の同等の機能期間は、カバレッジ・ディメンション・メンバーです。ルール境界値オブジェクトには、各カバレッジ・ディメンションのディメンション・メンバーのレコードが含まれます。

ソースを表示

Array of: object schema

{
    "title":"Rule Boundary Values",
    "type":"array",
    "description":"The rule boundary values resource is used to view the rule boundary values associated with a sales territory. The equivalent functional term for rule boundary value is coverage dimension member. The rule boundary values object contains records for the dimension members for each coverage dimension.",
    "items":{
        "$ref":"#/components/schemas/territories-TerritoryRule-TerritoryRuleBoundary1-TerritoryRuleBndryValue1-item-post-request"
    }
}

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

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

都道府県。
DimensionMember: string

テリトリ・ディメンション・メンバーの名前。
IncludeHierarchyFlag: boolean

タイトル: Include Hierarchy

最大長: 1

ディメンション・メンバーが階層とともに含まれているかどうかを示します。デフォルト値はtrueです。
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

テリトリ・ルール境界の識別子。

{
    "type":"object",
    "properties":{
        "AddrElementAttribute5":{
            "title":"Additional Attribute 5",
            "maxLength":150,
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true
        },
        "DimensionMember":{
            "type":"string",
            "description":"The name of the territory dimension member.",
            "nullable":true
        },
        "AddressCountry":{
            "title":"Country",
            "maxLength":2,
            "type":"string",
            "description":"Country.",
            "nullable":true
        },
        "TerrDimIntgId":{
            "title":"Dimension Value",
            "maxLength":80,
            "type":"string",
            "description":"The unique identifier of the common member of Oracle Business Intelligence (OBI), Territory Management, and Cube.",
            "nullable":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
        },
        "AddrElementAttribute1":{
            "title":"Additional Attribute 1",
            "maxLength":150,
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true
        },
        "AddrElementAttribute2":{
            "title":"Additional Attribute 2",
            "maxLength":150,
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true
        },
        "AddrElementAttribute3":{
            "title":"Additional Attribute 3",
            "maxLength":150,
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true
        },
        "AddressPostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"Postal Code.",
            "nullable":true
        },
        "AddrElementAttribute4":{
            "title":"Additional Attribute 4",
            "maxLength":150,
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true
        },
        "AddressCounty":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "description":"County.",
            "nullable":true
        },
        "TerrDimHighIntgId":{
            "title":"Dimension Value Range",
            "maxLength":80,
            "type":"string",
            "description":"The unique identifier of the common member of Oracle Business Intelligence (OBI), Territory Management, and Cube with a high sequence number.",
            "nullable":true
        },
        "AddressProvince":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "description":"Province.",
            "nullable":true
        },
        "AddressCity":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"City.",
            "nullable":true
        },
        "TerrRuleBndryValueId":{
            "title":"Territory Dimension Member ID",
            "type":"integer",
            "description":"The unique identifier of the territory rule boundary value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TerrRuleBoundaryId":{
            "title":"Territory Number",
            "type":"integer",
            "description":"The identifier of the territory rule boundary.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TerrDimensionCode":{
            "title":"Dimension",
            "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":false
        },
        "AddressState":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"State.",
            "nullable":true
        }
    }
}

トップに戻る

応答

サポートされるメディア・タイプ

application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

Metadata-Context(required):

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version(required):

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

ルート・スキーマ : 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

テリトリ・ルールの一意の識別子。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the territory rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the territory rule was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TerritoryVersionId":{
            "title":"Territory Number",
            "type":"integer",
            "description":"The unique identifier of the territory version.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the territory rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TerritoryRuleBoundary1":{
            "title":"Rule Boundaries",
            "type":"array",
            "description":"The rule boundaries resource is used to view the rule boundaries associated with a sales territory. The equivalent functional term for rule boundary is coverage dimension. The rule boundaries object contains records for each of the dimensions defined for a given territory coverage.",
            "items":{
                "$ref":"#/components/schemas/territories-TerritoryRule-TerritoryRuleBoundary1-item-response"
            }
        },
        "RuleOperatorCode":{
            "title":"Customer Coverage Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for identifying whether the coverage adds to or removes from the territory's jurisdiction. The accepted values are: EXCLUSION (for rule type EXCLUSION and PARTNER_EXCLUSION) and INCLUSION (for all other rule types, such as REGULAR, INCLUSION, PARTNER_REGULAR, PARTNER_INCLUSION, and INHERITANCE_OVERRIDE).",
            "nullable":true,
            "default":"INCLUSION",
            "x-queryable":true
        },
        "RuleTypeCode":{
            "title":"Coverage",
            "maxLength":30,
            "type":"string",
            "description":"The code for the territory coverage type.\n\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)\n\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)\n\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":true,
            "default":"REGULAR",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RuleNumber":{
            "title":"Coverage Number",
            "type":"integer",
            "description":"The coverage number for the territory.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TerrRuleId":{
            "title":"Coverage ID",
            "type":"integer",
            "description":"The unique identifier of the territory rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the territory rule was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":255,
            "type":"string",
            "description":"The login of the user who last updated the territory rule.",
            "nullable":true,
            "readOnly":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"
    }
}

ネストされたスキーマ : ルール境界

タイプ: array

タイトル: Rule Boundaries

ソースを表示

Array of: object territories-TerritoryRule-TerritoryRuleBoundary1-item-response

{
    "title":"Rule Boundaries",
    "type":"array",
    "description":"The rule boundaries resource is used to view the rule boundaries associated with a sales territory. The equivalent functional term for rule boundary is coverage dimension. The rule boundaries object contains records for each of the dimensions defined for a given territory coverage.",
    "items":{
        "$ref":"#/components/schemas/territories-TerritoryRule-TerritoryRuleBoundary1-item-response"
    }
}

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

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

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

テリトリ・ルールの識別子。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the territory rule boundary.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the territory rule boundary was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the territory rule boundary.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TerritoryRuleBndryValue1":{
            "title":"Rule Boundary Values",
            "type":"array",
            "description":"The rule boundary values resource is used to view the rule boundary values associated with a sales territory. The equivalent functional term for rule boundary value is coverage dimension member. The rule boundary values object contains records for the dimension members for each coverage dimension.",
            "items":{
                "$ref":"#/components/schemas/territories-TerritoryRule-TerritoryRuleBoundary1-TerritoryRuleBndryValue1-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Dimension":{
            "title":"Dimension",
            "maxLength":60,
            "type":"string",
            "description":"The name of the dimension.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TerrRuleBoundaryId":{
            "title":"Territory Dimension ID",
            "type":"integer",
            "description":"The unique identifier of the territory rule boundary.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TerrDimensionCode":{
            "title":"Dimension",
            "maxLength":5,
            "type":"string",
            "description":"The code indicating the territory dimension, such as Geo for Geography Dimension, Prod for Product Dimension, and so on.",
            "nullable":false,
            "x-queryable":true
        },
        "TerrRuleId":{
            "title":"Territory Number",
            "type":"integer",
            "description":"The identifier of the territory rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the territory rule boundary was last updated.",
            "format":"date-time",
            "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 rule boundary.",
            "nullable":true,
            "readOnly":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"
    }
}

ネストされたスキーマ : ルール境界値

タイプ: array

タイトル: Rule Boundary Values

ソースを表示

Array of: object territories-TerritoryRule-TerritoryRuleBoundary1-TerritoryRuleBndryValue1-item-response

{
    "title":"Rule Boundary Values",
    "type":"array",
    "description":"The rule boundary values resource is used to view the rule boundary values associated with a sales territory. The equivalent functional term for rule boundary value is coverage dimension member. The rule boundary values object contains records for the dimension members for each coverage dimension.",
    "items":{
        "$ref":"#/components/schemas/territories-TerritoryRule-TerritoryRuleBoundary1-TerritoryRuleBndryValue1-item-response"
    }
}

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

テリトリ・ルール境界の識別子。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the territory rule boundary value was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DimensionMemberHigh":{
            "title":"Territory Dimension Member High",
            "maxLength":360,
            "type":"string",
            "description":"The name of the territory dimension member with a high sequence number.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressCountry":{
            "title":"Country",
            "maxLength":2,
            "type":"string",
            "description":"Country.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressPostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"Postal Code.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressCounty":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "description":"County.",
            "nullable":true,
            "x-queryable":true
        },
        "TerrDimHighIntgId":{
            "title":"Dimension Value Range",
            "maxLength":80,
            "type":"string",
            "description":"The unique identifier of the common member of Oracle Business Intelligence (OBI), Territory Management, and Cube with a high sequence number.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressCity":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"City.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the territory rule boundary value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the territory rule boundary value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AddrElementAttribute5":{
            "title":"Additional Attribute 5",
            "maxLength":150,
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "DimensionMember":{
            "type":"string",
            "description":"The name of the territory dimension member.",
            "nullable":true,
            "x-queryable":true
        },
        "TerrDimIntgId":{
            "title":"Dimension Value",
            "maxLength":80,
            "type":"string",
            "description":"The unique identifier of the common member of Oracle Business Intelligence (OBI), Territory Management, and Cube.",
            "nullable":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
        },
        "AddrElementAttribute1":{
            "title":"Additional Attribute 1",
            "maxLength":150,
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "AddrElementAttribute2":{
            "title":"Additional Attribute 2",
            "maxLength":150,
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "AddrElementAttribute3":{
            "title":"Additional Attribute 3",
            "maxLength":150,
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "AddrElementAttribute4":{
            "title":"Additional Attribute 4",
            "maxLength":150,
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressProvince":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "description":"Province.",
            "nullable":true,
            "x-queryable":true
        },
        "TerrRuleBndryValueId":{
            "title":"Territory Dimension Member ID",
            "type":"integer",
            "description":"The unique identifier of the territory rule boundary value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TerrRuleBoundaryId":{
            "title":"Territory Number",
            "type":"integer",
            "description":"The identifier of the territory rule boundary.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TerrDimensionCode":{
            "title":"Dimension",
            "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":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the territory rule boundary value was last updated.",
            "format":"date-time",
            "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 rule boundary value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressState":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"State.",
            "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"
    }
}

リンク

TerritoryRuleBoundary1

操作: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryRule/{TerrRuleId}/child/TerritoryRuleBoundary1

パラメータ:

TerrRuleId: $request.path.TerrRuleId
TerritoryVersionId: $request.path.TerritoryVersionId

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対してPOSTリクエストを発行することによって、テリトリのルールを作成する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/11.13.18.05/territories/300100091635502/child/TerritoryRule

リクエスト本文の例

次の例は、JSON形式のリクエスト本文のコンテンツを示しています。

{
 "RuleNumber":"1",
 "RuleOperatorCode":"EXCLUSION",
 "RuleTypeCode":"EXCLUSION",
 "TerritoryRuleBoundary1":[
   {
     "TerrDimensionCode":"Acct",
     "TerritoryRuleBndryValue1":[
        {
          "TerrDimIntgId":"100000020228289",
          "TerrDimensionCode":"Acct"
         }]
   }]
}

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
"TerrRuleId": 300100091635540,
"RuleNumber": 1,
"TerritoryVersionId": 300100091635502,
"RuleOperatorCode": "EXCLUSION",
"RuleTypeCode": "EXCLUSION",
"TerritoryRuleBoundary1":[
{"TerrRuleBoundaryId": 300100091635541, "TerrRuleId": 300100091635540, "Dimension": "Customer", "TerrDimensionCode": "Acct",???}
],
"links":[
{"rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100091635502/child/TerritoryRule/300100091635540",???},
{"rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100091635502/child/TerritoryRule/300100091635540",???},
{"rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100091635502",???}
]
}

「トップに戻る」