レート・ディメンションの作成
post
/fscmRestApi/resources/11.13.18.05/rateDimensions
リクエスト
ヘッダー・パラメータ
- 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
-
Description: string
タイトル:
Description
最大長:1000
レート・ディメンションに関連するユーザーが追加した追加詳細。 -
Name(required): string
タイトル:
Name
最大長:80
レート・ディメンションの名前。 -
OrgId: integer (int64)
タイトル:
Business Unit
ビジネス・ユニットの一意の識別子。 値は、設定およびメンテナンスのビジネス・ユニットの管理タスクで許容可能な値のリストから更新できます。 -
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
-
MaximumAmount: number
タイトル:
To
レート・ディメンションの最大金額。 レート・ディメンションがパーセントの場合、最大金額は(100で除算して)数値に変換されます。 たとえば、レート・ディメンションがパーセンテージで、最小金額が20%の場合、20に変換されます。 -
MaximumExpressionId: integer (int64)
タイトル:
To
これは、最大式の一意の識別子です。 これは、層が式であるレート・ディメンション終了層を表します。 -
MinimumAmount: number
タイトル:
From
レート・ディメンションの最小金額。 レート・ディメンションがパーセントの場合、最小金額は(100で除算して)数値に変換されます。 たとえば、レート・ディメンションがパーセンテージで、最小金額が10%の場合、10に変換されます。 -
MinimumExpressionId: integer (int64)
タイトル:
From
これは最小式の一意の識別子です。 これは、階層が式であるレート・ディメンションの開始階層を表します。 -
RateDimensionId: integer (int64)
レート・ディメンション・レコードの一意の識別子。
-
StringValue: string
タイトル:
String
最大長:30
タイプが文字列として設定されたレート・ディメンション階層の英数字値。
応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : 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
レート・ディメンション内の階層の指定順序。
リンク
- BusinessUnitPVO
-
ビジネス・ユニット値リスト・リソースは、定義済ビジネス・ユニットのリストを表示するために使用されます。
- CnLookupRateDimensionTypeVO
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DCN_DIM_UNIT_CODE
標準参照値リスト・リソースは、標準参照の値リストを問い合せるために使用されます。このリストには、使用可能なコードと翻訳された内容がリストされます。 標準参照は、参照データ共有をサポートする標準参照ビューおよび格納参照コードで定義されます。 - ファインダ:
- RateDimensionTiers
-
パラメータ:
- RateDimensionId:
$request.path.RateDimensionId
レート・ディメンション階層リソースは、レート・ディメンションへの階層の関連付けを作成、更新または削除するために使用されます。 また、ディメンションの階層のすべての詳細を表示するために使用することもできます。 - RateDimensionId:
例:
次の例は、cURLを使用してRESTリソースに対するPOSTリクエストを発行することによって、レート・ディメンション階層を持つレート・ディメンションを作成する方法を示しています。
cURLコマンド
curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions
リクエスト本文の例
次の例は、JSON形式のリクエスト本文のコンテンツを示しています。
{ "Name": "Sales Amount", "RateDimensionType": "AMOUNT", "OrgId": 204, "RateDimensionTiers" : [ { "MinimumAmount": 0, "MaximumAmount": 1000 } ], "RateDimensionTiers" : [ { "MinimumAmount": 1000, "MaximumAmount": 2000 } ], "RateDimensionTiers" : [ { "MinimumAmount": 2000, "MaximumAmount": 3000 } ], "RateDimensionTiers" : [ { "MinimumAmount": 3000, "MaximumAmount": 4000 } ] }
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{ "RateDimensionId": 300100089584737, "Name": "Sales Amount", "Description": null, "RateDimensionType": "AMOUNT", "OrgId": 204, "NumberTier": 4, "LastUpdateDate": "2017-04-12T18:22:48+05:30", "LastUpdateLogin": "4CF735A3F3680DD9E053CB90B10A476E", "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "CreationDate": "2017-04-12T18:22:48+05:30", "RateDimensionTiers": [ { "RateDimTierId": 300100089584738, "RateDimensionId": 300100089584737, "TierSequence": 1, "MinimumAmount": 0, "MaximumAmount": 1000, "StringValue": null, "MinimumExpressionId": null, "MaximumExpressionId": null, "MinimumExpressionName": null, "MaximumExpressionName": null, "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "CreationDate": "2017-04-12T18:22:48+05:30", "LastUpdateDate": "2017-04-12T18:22:48+05:30", "LastUpdateLogin": "4CF735A3F3680DD9E053CB90B10A476E", "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737/child/RateDimensionTiers/300100089584738", "name": "RateDimensionTiers", "kind": "item", "properties": {"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"} }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737/child/RateDimensionTiers/300100089584738", "name": "RateDimensionTiers", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737", "name": "rateDimensions", "kind": "item" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737/child/RateDimensionTiers/300100089584738/lov/MinimumExpressionVO", "name": "MinimumExpressionVO", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737/child/RateDimensionTiers/300100089584738/lov/MaximumExpressionVO", "name": "MaximumExpressionVO", "kind": "collection" } ] }, { "RateDimTierId": 300100089584739, "RateDimensionId": 300100089584737, "TierSequence": 2, "MinimumAmount": 1000, "MaximumAmount": 2000, "StringValue": null, "MinimumExpressionId": null, "MaximumExpressionId": null, "MinimumExpressionName": null, "MaximumExpressionName": null, "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "CreationDate": "2017-04-12T18:22:48+05:30", "LastUpdateDate": "2017-04-12T18:22:48+05:30", "LastUpdateLogin": "4CF735A3F3680DD9E053CB90B10A476E", "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737/child/RateDimensionTiers/300100089584739", "name": "RateDimensionTiers", "kind": "item", "properties": {"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"} }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737/child/RateDimensionTiers/300100089584739", "name": "RateDimensionTiers", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737", "name": "rateDimensions", "kind": "item" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737/child/RateDimensionTiers/300100089584739/lov/MinimumExpressionVO", "name": "MinimumExpressionVO", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737/child/RateDimensionTiers/300100089584739/lov/MaximumExpressionVO", "name": "MaximumExpressionVO", "kind": "collection" } ] }, { "RateDimTierId": 300100089584740, "RateDimensionId": 300100089584737, "TierSequence": 3, "MinimumAmount": 2000, "MaximumAmount": 3000, "StringValue": null, "MinimumExpressionId": null, "MaximumExpressionId": null, "MinimumExpressionName": null, "MaximumExpressionName": null, "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "CreationDate": "2017-04-12T18:22:48+05:30", "LastUpdateDate": "2017-04-12T18:22:48+05:30", "LastUpdateLogin": "4CF735A3F3680DD9E053CB90B10A476E", "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737/child/RateDimensionTiers/300100089584740", "name": "RateDimensionTiers", "kind": "item", "properties": {"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"} }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737/child/RateDimensionTiers/300100089584740", "name": "RateDimensionTiers", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737", "name": "rateDimensions", "kind": "item" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737/child/RateDimensionTiers/300100089584740/lov/MinimumExpressionVO", "name": "MinimumExpressionVO", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737/child/RateDimensionTiers/300100089584740/lov/MaximumExpressionVO", "name": "MaximumExpressionVO", "kind": "collection" } ] }, { "RateDimTierId": 300100089584741, "RateDimensionId": 300100089584737, "TierSequence": 4, "MinimumAmount": 3000, "MaximumAmount": 4000, "StringValue": null, "MinimumExpressionId": null, "MaximumExpressionId": null, "MinimumExpressionName": null, "MaximumExpressionName": null, "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "CreationDate": "2017-04-12T18:22:48+05:30", "LastUpdateDate": "2017-04-12T18:22:48+05:30", "LastUpdateLogin": "4CF735A3F3680DD9E053CB90B10A476E", "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737/child/RateDimensionTiers/300100089584741", "name": "RateDimensionTiers", "kind": "item", "properties": {"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"} }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737/child/RateDimensionTiers/300100089584741", "name": "RateDimensionTiers", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737", "name": "rateDimensions", "kind": "item" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737/child/RateDimensionTiers/300100089584741/lov/MinimumExpressionVO", "name": "MinimumExpressionVO", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737/child/RateDimensionTiers/300100089584741/lov/MaximumExpressionVO", "name": "MaximumExpressionVO", "kind": "collection" } ] } ], "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737", "name": "rateDimensions", "kind": "item", "properties": {"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"} }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737", "name": "rateDimensions", "kind": "item" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737/lov/BusinessUnitPVO", "name": "BusinessUnitPVO", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737/lov/CnLookupRateDimensionTypeVO", "name": "CnLookupRateDimensionTypeVO", "kind": "collection" } ] }