テリトリのルール境界値を取得
get
/crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryRule/{TerrRuleId}/child/TerritoryRuleBoundary1/{TerrRuleBoundaryId}/child/TerritoryRuleBndryValue1/{TerrRuleBndryValueId}
リクエスト
パス・パラメータ
- TerrRuleBndryValueId(required): integer(int64)
テリトリ・ルール境界値の一意の識別子。
- TerrRuleBoundaryId(required): integer(int64)
テリトリ・ルール境界の一意の識別子。
- TerrRuleId(required): integer(int64)
テリトリ・ルールの一意の識別子。
- TerritoryVersionId(required): integer(int64)
テリトリ・バージョンの一意の識別子。
問合せパラメータ
- dependency: string
このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
フォーマット: <attr1>=<val1>,<attr2>=<value2> - expand: string
このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
- fields: string
このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。
フォーマット : ?fields=Attribute1,Attribute2
子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2 - links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- onlyData: boolean
リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
この操作にはリクエスト本文がありません。
トップに戻る応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : 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
テリトリ・ルール境界の識別子。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。
例:
次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、テリトリのルール境界値を取得する方法を示しています。 cURLの詳細については、cURLを使用するを参照してください。
cURLコマンド
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100025000830/child/TerritoryRule/300100025000833/child/TerritoryRuleBoundary1/300100025000834/child/TerritoryRuleBndryValue1/300100025000835
レスポンス本文の例
次に、JSON形式のレスポンス本文の例を示します。
{ TerrRuleBndryValueId: 300100025000835 TerrRuleBoundaryId: 300100025000834 DimensionMember: "Europe Middle East & Africa" DimensionMemberHigh: null TerrDimHighIntgId: null TerrDimIntgId: "999984000000017" TerrDimensionCode: "Geo" IncludeHierarchyFlag: true }