テリトリのルール境界の作成
post
/crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryRule/{TerrRuleId}/child/TerritoryRuleBoundary1
リクエスト
パス・パラメータ
- TerrRuleId(required): integer(int64)
テリトリ・ルールの一意の識別子。
- 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-
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テリトリ・ルールの識別子。
ネストされたスキーマ : ルール境界値
タイプ:
arrayタイトル:
Rule Boundary Valuesルール境界値リソースは、営業テリトリに関連付けられたルール境界値を表示するために使用されます。 ルール境界値の同等の機能期間は、カバレッジ・ディメンション・メンバーです。 ルール境界値オブジェクトには、各カバレッジ・ディメンションのディメンション・メンバーのレコードが含まれます。
ソースを表示
ネストされたスキーマ : スキーマ
タイプ:
ソースを表示
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最大長:60County -
AddressPostalCode: string
タイトル:
Postal Code最大長:60郵便番号 -
AddressProvince: string
タイトル:
Province最大長:60Province -
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最大長:80Oracle Business Intelligence (OBI)、テリトリ管理およびキューブの共通メンバーの一意の識別子。 -
TerrRuleBndryValueId: integer (int64)
タイトル:
Territory Dimension Member IDテリトリ・ルール境界値の一意の識別子。 -
TerrRuleBoundaryId: integer (int64)
タイトル:
Territory Numberテリトリ・ルール境界の識別子。
応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : territories-TerritoryRule-TerritoryRuleBoundary1-item-response
タイプ:
ソースを表示
object-
CreatedBy: string
タイトル:
Created By読取り専用:true最大長:64テリトリ・ルール境界を作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date読取り専用:trueテリトリ・ルール境界が作成された日付。 -
Dimension: string
タイトル:
Dimension読取り専用:true最大長:60ディメンションの名前。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date読取り専用:trueテリトリ・ルール境界が最後に更新された日付。 -
LastUpdatedBy: string
タイトル:
Last Updated By読取り専用:true最大長:64テリトリ・ルール境界を最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login読取り専用:true最大長:32テリトリ・ルール境界を最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Linksリソース・インスタンスに関連付けられたリンク関係。 -
TerrDimensionCode: string
タイトル:
Dimension最大長:5地理ディメンションの地理、製品ディメンションの製品など、テリトリ・ディメンションを示すコード。 -
TerritoryRuleBndryValue1: array Rule Boundary Values
タイトル:
Rule Boundary Valuesルール境界値リソースは、営業テリトリに関連付けられたルール境界値を表示するために使用されます。 ルール境界値の同等の機能期間は、カバレッジ・ディメンション・メンバーです。 ルール境界値オブジェクトには、各カバレッジ・ディメンションのディメンション・メンバーのレコードが含まれます。 -
TerrRuleBoundaryId: integer (int64)
タイトル:
Territory Dimension IDテリトリ・ルール境界の一意の識別子。 -
TerrRuleId: integer (int64)
タイトル:
Territory Numberテリトリ・ルールの識別子。
ネストされたスキーマ : ルール境界値
タイプ:
arrayタイトル:
Rule Boundary Valuesルール境界値リソースは、営業テリトリに関連付けられたルール境界値を表示するために使用されます。 ルール境界値の同等の機能期間は、カバレッジ・ディメンション・メンバーです。 ルール境界値オブジェクトには、各カバレッジ・ディメンションのディメンション・メンバーのレコードが含まれます。
ソースを表示
ネストされたスキーマ : リンク
タイプ:
ソースを表示
object-
href: string
タイトル:
hyperlink reference関連リソースへのURI。 -
kind: string
タイトル:
kind許可された値:[ "collection", "item", "describe", "other" ]関連リソースの種類。 -
name: string
タイトル:
name関連リソースへのリンクの名前。 -
properties: object properties
-
rel: string
タイトル:
relation許可された値:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]リソース・インスタンスとの関係の名前。 例: self.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
ネストされたスキーマ : territories-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最大長:60County -
AddressPostalCode: string
タイトル:
Postal Code最大長:60郵便番号 -
AddressProvince: string
タイトル:
Province最大長:60Province -
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最大長:80Oracle Business Intelligence (OBI)、テリトリ管理およびキューブの共通メンバーの一意の識別子。 -
TerrRuleBndryValueId: integer (int64)
タイトル:
Territory Dimension Member IDテリトリ・ルール境界値の一意の識別子。 -
TerrRuleBoundaryId: integer (int64)
タイトル:
Territory Numberテリトリ・ルール境界の識別子。
リンク
- TerritoryRuleBndryValue1
-
パラメータ:
- TerrRuleBoundaryId:
$request.path.TerrRuleBoundaryId - TerrRuleId:
$request.path.TerrRuleId - TerritoryVersionId:
$request.path.TerritoryVersionId
ルール境界値リソースは、営業テリトリに関連付けられたルール境界値を表示するために使用されます。 ルール境界値の同等の機能期間は、カバレッジ・ディメンション・メンバーです。 ルール境界値オブジェクトには、各カバレッジ・ディメンションのディメンション・メンバーのレコードが含まれます。 - TerrRuleBoundaryId:
例:
次の例は、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/300100091635502/child/TerritoryRule/300100091635545/child/TerritoryRuleBoundary1
リクエスト本文の例
次の例は、JSON形式のリクエスト本文のコンテンツを示しています。
{
"TerrDimensionCode":"Indst",
"TerritoryRuleBndryValue1":[
{
"TerrDimIntgId":"ONE VOICE~1100",
"TerrDimensionCode":"Indst"
}]
}
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{
"TerrRuleBoundaryId": 300100091635549,
"TerrRuleId": 300100091635545,
"Dimension": "Industry",
"TerrDimensionCode": "Indst",
"TerritoryRuleBndryValue1":[
{"TerrRuleBndryValueId": 300100091635550, "TerrRuleBoundaryId": 300100091635549, "DimensionMember": "Automotive", "DimensionMemberHigh": null,???}
],
"links":[
{"rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100091635502/child/TerritoryRule/300100091635545/child/TerritoryRuleBoundary1/300100091635549",???},
{"rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100091635502/child/TerritoryRule/300100091635545/child/TerritoryRuleBoundary1/300100091635549",???},
{"rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100091635502/child/TerritoryRule/300100091635545",???}
]
}