すべてのレート・ディメンションの取得
get
/fscmRestApi/resources/11.13.18.05/rateDimensions
リクエスト
問合せパラメータ
- 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>
使用可能なファインダ名および対応するファインダ変数を次に示します:- PrimaryKey : RateDimensionIdでレート・ディメンションを検索します。
ファインダ変数:- RateDimensionId; integer;レート・ディメンションの一意の識別子。
- PrimaryKey : RateDimensionIdでレート・ディメンションを検索します。
- 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問合せパラメータを使用してこの収集リソースをフィルタできます:
- CreatedBy; string; レコードを作成したユーザー。
- CreationDate; string; レコードが作成された日時。
- 摘要;文字列;レート・ディメンションに関連するユーザーが追加した追加詳細。
- LastUpdateDate; string; レコードが最後に更新された日時。
- LastUpdateLogin; string; レコードを最後に更新したユーザーに関連付けられたセッション・ログイン。
- LastUpdatedBy; string; レコードを最後に更新したユーザー。
- 名前;文字列;レート・ディメンションの名前。
- NumberTier; integer;レート・ディメンションの層の数。 デフォルト値は、0です。
- OrgId; integer;ビジネス・ユニットの一意の識別子。 値は、設定およびメンテナンスのビジネス・ユニットの管理タスクで許容可能な値のリストから更新できます。
- RateDimensionId; integer;レート・ディメンション・レコードの一意の識別子。
- RateDimensionType; string;レート・ディメンションの測定単位。 取り得る値は、AMOUNT、EXPRESSION、PERCENTおよびSTRINGです。 デフォルト値はAMOUNTです。 受理可能な値のリストは、参照CN_DIM_UNIT_CODEで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : rateDimensions
タイプ:
ソースを表示
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"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : rateDimensions-item-response
タイプ:
ソースを表示
object
-
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
レコードを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
レコードが作成された日時。 -
Description: string
タイトル:
Description
最大長:1000
レート・ディメンションに関連するユーザーが追加した追加詳細。 -
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
リソース・インスタンスに関連付けられたリンク関係。 -
Name: string
タイトル:
Name
最大長:80
レート・ディメンションの名前。 -
NumberTier: integer (int64)
タイトル:
Number of Tiers
読取り専用:true
デフォルト値:0
レート・ディメンションの階層の数。 デフォルト値は、0です。 -
OrgId: integer (int64)
タイトル:
Business Unit
ビジネス・ユニットの一意の識別子。 値は、設定およびメンテナンスのビジネス・ユニットの管理タスクで許容可能な値のリストから更新できます。 -
RateDimensionId: integer (int64)
読取り専用:
true
レート・ディメンション・レコードの一意の識別子。 -
RateDimensionTiers: array Rate Dimension - Tiers
タイトル:
Rate Dimension - Tiers
レート・ディメンション階層リソースは、レート・ディメンションへの階層の関連付けを作成、更新または削除するために使用されます。 また、ディメンションの階層のすべての詳細を表示するために使用することもできます。 -
RateDimensionType: string
タイトル:
Type
最大長:30
デフォルト値:AMOUNT
レート・ディメンションの単位。 取り得る値は、AMOUNT、EXPRESSION、PERCENTおよびSTRINGです。 デフォルト値はAMOUNTです。 受理可能な値のリストは、参照CN_DIM_UNIT_CODEで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
ネストされたスキーマ : レート・ディメンション - 階層
タイプ:
array
タイトル:
Rate Dimension - Tiers
レート・ディメンション階層リソースは、レート・ディメンションへの階層の関連付けを作成、更新または削除するために使用されます。 また、ディメンションの階層のすべての詳細を表示するために使用することもできます。
ソースを表示
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。
ネストされたスキーマ : rateDimensions-RateDimensionTiers-item-response
タイプ:
ソースを表示
object
-
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
レコードを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用: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
リソース・インスタンスに関連付けられたリンク関係。 -
MaximumAmount: number
タイトル:
To
レート・ディメンションの最大金額。 レート・ディメンションがパーセントの場合、最大金額は(100で除算して)数値に変換されます。 たとえば、レート・ディメンションがパーセンテージで、最小金額が20%の場合、20に変換されます。 -
MaximumExpressionId: integer (int64)
タイトル:
To
これは、最大式の一意の識別子です。 これは、層が式であるレート・ディメンション終了層を表します。 -
MaximumExpressionName: string
タイトル:
To
読取り専用:true
最大式の名前。 -
MinimumAmount: number
タイトル:
From
レート・ディメンションの最小金額。 レート・ディメンションがパーセントの場合、最小金額は(100で除算して)数値に変換されます。 たとえば、レート・ディメンションがパーセンテージで、最小金額が10%の場合、10に変換されます。 -
MinimumExpressionId: integer (int64)
タイトル:
From
これは最小式の一意の識別子です。 これは、階層が式であるレート・ディメンションの開始階層を表します。 -
MinimumExpressionName: string
タイトル:
From
読取り専用:true
最小式の名前。 -
RateDimensionId: integer (int64)
レート・ディメンション・レコードの一意の識別子。
-
RateDimTierId: integer (int64)
読取り専用:
true
レート・ディメンション階層の一意の識別子。 -
StringValue: string
タイトル:
String
最大長:30
タイプが文字列として設定されたレート・ディメンション階層の英数字値。 -
TierSequence: 整数(int32)
タイトル:
Sequence
読取り専用:true
レート・ディメンション内の階層の指定順序。
例:
次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、すべてのレート・ディメンション層を取得する方法を示しています。
cURLコマンド
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089570738/child/RateDimensionTiers
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{ "items": [ { "RateDimTierId": 300100089570739, "RateDimensionId": 300100089570738, "TierSequence": 1, "MinimumAmount": 0, "MaximumAmount": 1000, "StringValue": null, "MinimumExpressionId": null, "MaximumExpressionId": null, "MinimumExpressionName": null, "MaximumExpressionName": null, "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "CreationDate": "2016-09-21T21:31:16+05:30", "LastUpdateDate": "2016-09-21T21:31:16+05:30", "LastUpdateLogin": "3CEB7E6D973C0A67E053CB90B10AABA3", "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089570738/child/RateDimensionTiers/300100089570739", "name": "RateDimensionTiers", "kind": "item", "properties": {"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"} }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089570738/child/RateDimensionTiers/300100089570739", "name": "RateDimensionTiers", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089570738", "name": "rateDimensions", "kind": "item" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089570738/child/RateDimensionTiers/300100089570739/lov/MinimumExpressionVO", "name": "MinimumExpressionVO", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089570738/child/RateDimensionTiers/300100089570739/lov/MaximumExpressionVO", "name": "MaximumExpressionVO", "kind": "collection" } ] }, { "RateDimTierId": 300100089570740, "RateDimensionId": 300100089570738, "TierSequence": 2, "MinimumAmount": 1000, "MaximumAmount": 2000, "StringValue": null, "MinimumExpressionId": null, "MaximumExpressionId": null, "MinimumExpressionName": null, "MaximumExpressionName": null, "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "CreationDate": "2016-09-21T21:31:16+05:30", "LastUpdateDate": "2016-09-21T21:31:16+05:30", "LastUpdateLogin": "3CEB7E6D973C0A67E053CB90B10AABA3", "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089570738/child/RateDimensionTiers/300100089570740", "name": "RateDimensionTiers", "kind": "item", "properties": {"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"} }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089570738/child/RateDimensionTiers/300100089570740", "name": "RateDimensionTiers", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089570738", "name": "rateDimensions", "kind": "item" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089570738/child/RateDimensionTiers/300100089570740/lov/MinimumExpressionVO", "name": "MinimumExpressionVO", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089570738/child/RateDimensionTiers/300100089570740/lov/MaximumExpressionVO", "name": "MaximumExpressionVO", "kind": "collection" } ] }, . . . ], "count": 4, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089570738/child/RateDimensionTiers", "name": "RateDimensionTiers", "kind": "collection" }] }