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

機械翻訳について

レート表の作成

post

/fscmRestApi/resources/11.13.18.05/rateTables

リクエスト

ヘッダー・パラメータ

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

レート表に関連するユーザーが追加した追加詳細。
DisplayName: string

タイトル: Display Name

最大長: 80

このレート表を表すために営業担当のユーザー・インタフェースに表示されるレート表の名前(オプション)。
Name(required): string

タイトル: Name

最大長: 80

レート表の名前。レート表は、さまざまなパフォーマンス・レベルに対して給与比率レートや固定額を設定するために使用します。
OrgId: integer (int64)

タイトル: Business Unit

ビジネス・ユニットの一意の識別子。値は、設定およびメンテナンスのビジネス・ユニットの管理タスクで許容可能な値のリストから更新できます。
RateTableDimensions: array Rate Table Dimensions

タイトル: Rate Table Dimensions

レート表 - ディメンション・リソースは、ディメンションとレート表の関連付けを作成、更新または削除するために使用されます。また、レート表のディメンションのすべての詳細を表示するために使用することもできます。 RESTサービスを使用してレート表に追加できるのは、最大10個のレート・ディメンションのみです。
RateTableRates: array Rate Table Rates

タイトル: Rate Table Rates

レート表レート・リソースは、レート表またはスコア・カードのレートを作成、表示または更新するために使用されます。また、レート表またはスコア・カードのすべてのレートを表示するために使用することもできます。ゼロ以外の値のレートのみを作成できます。
RateTableType: string

タイトル: Type

最大長: 30

デフォルト値: AMOUNT

パーセントや金額など、レート表のレートの性質を表す参照コード。指定可能な値は、AMOUNTおよびPERCENTです。デフォルト値はAMOUNTです。許容可能な値のリストは、参照CN_COMMISSION_UNIT_CODEで定義されます。設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。

{
    "required":[
        "Name"
    ],
    "type":"object",
    "properties":{
        "OrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit. The value can be updated from a list of acceptable values in the Manage Business Units task in Setup and Maintenance.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The additional details added by the user related to rate tables.",
            "nullable":true
        },
        "RateTableType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The lookup code that represents the nature of rates in the rate table, such as a percentage and amount. Possible values include AMOUNT and PERCENT. The default value is AMOUNT. A list of acceptable values is defined in the lookup CN_COMMISSION_UNIT_CODE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "default":"AMOUNT",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DisplayName":{
            "title":"Display Name",
            "maxLength":80,
            "type":"string",
            "description":"The optional name of the rate table that is shown to the sales representative's user interface to represent this rate table.",
            "nullable":true
        },
        "RateTableRates":{
            "title":"Rate Table Rates",
            "type":"array",
            "description":"The rate table rates resource is used to create, view, or update the rates for a rate table or a scorecard. It can also be used to display all the rates of a rate table or a scorecard. You can only create rates with non-zero values.",
            "items":{
                "$ref":"#/components/schemas/rateTables-RateTableRates-item-post-request"
            }
        },
        "RateTableDimensions":{
            "title":"Rate Table Dimensions",
            "type":"array",
            "description":"The rate table - dimensions resource is used to create, update, or delete the association of dimensions to a rate table. It can also be used to display all details of the dimensions in a rate table. You can only add up to ten rate dimensions to a rate table using REST Services.",
            "items":{
                "$ref":"#/components/schemas/rateTables-RateTableDimensions-item-post-request"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of a rate table. A rate table is used to establish compensation percentage rates or fixed amounts for different performance levels.",
            "nullable":false
        }
    }
}

ネストされたスキーマ : レート表のディメンション

タイプ: array

タイトル: Rate Table Dimensions

レート表 - ディメンション・リソースは、ディメンションとレート表の関連付けを作成、更新または削除するために使用されます。また、レート表のディメンションのすべての詳細を表示するために使用することもできます。 RESTサービスを使用してレート表に追加できるのは、最大10個のレート・ディメンションのみです。

ソースを表示

Array of: object schema

{
    "title":"Rate Table Dimensions",
    "type":"array",
    "description":"The rate table - dimensions resource is used to create, update, or delete the association of dimensions to a rate table. It can also be used to display all details of the dimensions in a rate table. You can only add up to ten rate dimensions to a rate table using REST Services.",
    "items":{
        "$ref":"#/components/schemas/rateTables-RateTableDimensions-item-post-request"
    }
}

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

タイプ: array

タイトル: Rate Table Rates

レート表レート・リソースは、レート表またはスコア・カードのレートを作成、表示または更新するために使用されます。また、レート表またはスコア・カードのすべてのレートを表示するために使用することもできます。ゼロ以外の値のレートのみを作成できます。

ソースを表示

Array of: object schema

{
    "title":"Rate Table Rates",
    "type":"array",
    "description":"The rate table rates resource is used to create, view, or update the rates for a rate table or a scorecard. It can also be used to display all the rates of a rate table or a scorecard. You can only create rates with non-zero values.",
    "items":{
        "$ref":"#/components/schemas/rateTables-RateTableRates-item-post-request"
    }
}

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

タイプ: object

ソースを表示

RateDimensionId(required): integer (int64)

タイトル: Name

レート・ディメンション・レコードの一意の識別子。
RateTableDimensionTiers: array Rate Dimensions Tiers

タイトル: Rate Dimensions Tiers

レート・ディメンション階層リソースは、レート表のレート・ディメンションの階層のすべての詳細を表示するためにのみ使用されます。
RateTableDimId: integer (int64)

レート表のディメンション・レコードの一意の識別子。
RateTableId(required): integer (int64)

タイトル: Name

レート表の一意の識別子。

{
    "required":[
        "RateDimensionId",
        "RateTableId"
    ],
    "type":"object",
    "properties":{
        "RateTableDimId":{
            "type":"integer",
            "description":"The unique identifier for the rate table's dimension record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RateDimensionId":{
            "title":"Name",
            "type":"integer",
            "description":"The unique identifier for a rate dimension record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            }
        },
        "RateTableId":{
            "title":"Name",
            "type":"integer",
            "description":"The unique identifier for a rate table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RateTableDimensionTiers":{
            "title":"Rate Dimensions Tiers",
            "type":"array",
            "description":"The rate dimensions tiers resource is only used to view all the details of the tiers in a rate dimension of the rate table.",
            "items":{
                "$ref":"#/components/schemas/rateTables-RateTableDimensions-RateTableDimensionTiers-item-post-request"
            }
        }
    }
}

ネストされたスキーマ : レート・ディメンション階層

タイプ: array

タイトル: Rate Dimensions Tiers

レート・ディメンション階層リソースは、レート表のレート・ディメンションの階層のすべての詳細を表示するためにのみ使用されます。

ソースを表示

Array of: object rateTables-RateTableDimensions-RateTableDimensionTiers-item-post-request

{
    "title":"Rate Dimensions Tiers",
    "type":"array",
    "description":"The rate dimensions tiers resource is only used to view all the details of the tiers in a rate dimension of the rate table.",
    "items":{
        "$ref":"#/components/schemas/rateTables-RateTableDimensions-RateTableDimensionTiers-item-post-request"
    }
}

ネストされたスキーマ : rateTables-RateTableDimensions-RateTableDimensionTiers-item-post-request

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

レート階層の英数字値。この属性は、レート・ディメンション・タイプが文字列として設定されている場合にのみ使用されます。

{
    "type":"object",
    "properties":{
        "RateDimensionId":{
            "type":"integer",
            "description":"The unique identifier of a rate dimension.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "MaximumAmount":{
            "title":"To",
            "type":"number",
            "description":"The maximum amount of the rate tier. This attribute is only used when the rate dimension type is set as amount or percent. If the rate dimension type is percent, then the maximum amount stored here needs to be divided by 100 to get the actual value. For example, if the rate dimension is percent and the maximum amount is 20%, then 20 is maximum amount value.",
            "nullable":true
        },
        "MinimumExpressionId":{
            "title":"From",
            "type":"integer",
            "description":"The unique identifier of the minimum expression. This represents the rate dimension starting tier only when rate dimension type is set as Expression.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            }
        },
        "MaximumExpressionId":{
            "title":"To",
            "type":"integer",
            "description":"The unique identifier of the maximum expression. This represents the rate dimension ending tier only when rate dimension type is set as Expression.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            }
        },
        "MinimumAmount":{
            "title":"From",
            "type":"number",
            "description":"The minimum amount of the rate tier. This attribute is only used when the rate dimension type is set as amount or percent. If the rate dimension type is percent, then the minimum amount stored here needs to be divided by 100 to get the actual value. For example, if the rate dimension is percent and the minimum amount is 10%, then 10 is the minimum amount value.",
            "nullable":true
        },
        "StringValue":{
            "title":"String",
            "maxLength":30,
            "type":"string",
            "description":"The alphanumeric value of a rate tier. This attribute is only used when the rate dimension type is set as string.",
            "nullable":true
        }
    }
}

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

タイプ: object

ソースを表示

OrgId: integer (int64)

ビジネス・ユニットの一意の識別子。この値は、「設定およびメンテナンス」作業領域のビジネス・ユニットの管理タスクで許容可能な値のリストから更新できます。
レート: number

タイトル: Rate

支給レートまたは達成レートの計算に使用できる、レート表の出力値です。この値は、レート表に対して設定されたレート表タイプに応じて、パーセントまたは金額になります。レート表タイプがパーセントの場合、実際の値を取得するには、ここに保存されている値を100で割る必要があります。たとえば、レート表タイプがパーセントで、レート値が10%の場合、出力値は10です。
RateDimension10Id: string

レート値に関連付けられた10番目のレート・ディメンション・レコードの一意の識別子。この値は、レート表に10個のレート・ディメンションがある場合にのみ入力されます。
RateDimension10TierId: string

レート値に関連付けられた10番目のレート・ディメンション階層の一意の識別子です。この値は、このレート表に10個のレート・ディメンションがある場合にのみ入力されます。
RateDimension1Id: string

レート値に関連付けられた最初のレート・ディメンション・レコードの一意の識別子。
RateDimension1TierId: string

レート値に関連付けられた最初のレート・ディメンション階層の一意の識別子。
RateDimension2Id: string

レート値に関連付けられた2番目のレート・ディメンション・レコードの一意の識別子。この値は、レート表に2つ以上のレート・ディメンションがある場合にのみ入力されます。
RateDimension2TierId: string

レート値に関連付けられた2番目のレート・ディメンション階層の一意の識別子。この値は、このレート表に2つ以上のレート・ディメンションがある場合にのみ入力されます。
RateDimension3Id: string

レート値に関連付けられた3番目のレート・ディメンション・レコードの一意の識別子。この値は、レート表に3つ以上のレート・ディメンションがある場合にのみ入力されます。
RateDimension3TierId: string

レート値に関連付けられた3番目のレート・ディメンション階層の一意の識別子。この値は、このレート表に3つ以上のレート・ディメンションがある場合にのみ入力されます。
RateDimension4Id: string

レート値に関連付けられた4番目のレート・ディメンション・レコードの一意の識別子。この値は、レート表に4つ以上のレート・ディメンションがある場合にのみ入力されます。
RateDimension4TierId: string

レート値に関連付けられた4番目のレート・ディメンション階層の一意の識別子。この値は、このレート表に4つ以上のレート・ディメンションがある場合にのみ入力されます。
RateDimension5Id: string

レート値に関連付けられた5番目のレート・ディメンション・レコードの一意の識別子。この値は、レート表に5つ以上のレート・ディメンションがある場合にのみ入力されます。
RateDimension5TierId: string

レート値に関連付けられた5番目のレート・ディメンション階層の一意の識別子。この値は、このレート表に5つ以上のレート・ディメンションがある場合にのみ入力されます。
RateDimension6Id: string

レート値に関連付けられた6番目のレート・ディメンション・レコードの一意の識別子。この値は、レート表に6つ以上のレート・ディメンションがある場合にのみ入力されます。
RateDimension6TierId: string

レート値に関連付けられた6番目のレート・ディメンション階層の一意の識別子。この値は、このレート表に6つ以上のレート・ディメンションがある場合にのみ入力されます。
RateDimension7Id: string

レート値に関連付けられた7番目のレート・ディメンション・レコードの一意の識別子。この値は、レート表に7つ以上のレート・ディメンションがある場合にのみ入力されます。
RateDimension7TierId: string

レート値に関連付けられた7番目のレート・ディメンション階層の一意の識別子です。この値は、このレート表に7つ以上のレート・ディメンションがある場合にのみ入力されます。
RateDimension8Id: string

レート値に関連付けられた8番目のレート・ディメンション・レコードの一意の識別子。この値は、レート表に8つ以上のレート・ディメンションがある場合にのみ入力されます。
RateDimension8TierId: string

レート値に関連付けられた8番目のレート・ディメンション階層の一意の識別子。この値は、このレート表に8つ以上のレート・ディメンションがある場合にのみ入力されます。
RateDimension9Id: string

レート値に関連付けられた9番目のレート・ディメンション・レコードの一意の識別子。この値は、レート表に9つ以上のレート・ディメンションがある場合にのみ入力されます。
RateDimension9TierId: string

レート値に関連付けられた9番目のレート・ディメンション階層の一意の識別子。この値は、このレート表に9つ以上のレート・ディメンションがある場合にのみ入力されます。
RateTableId: integer (int64)

レート表の一意の識別子。
RateTableNumberDim: integer

タイトル: Number of Dimensions

レート表のディメンションの数。レート表RESTサービスでサポートされるディメンションは最大10個のみです。

{
    "type":"object",
    "properties":{
        "RateDimension8TierId":{
            "type":"string",
            "description":"The unique identifier of the eighth rate dimension tier associated with the rate value. This value will only be filled if this rate table has 8 or more rate dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension3TierId":{
            "type":"string",
            "description":"The unique identifier of the third rate dimension tier associated with the rate value. This value will only be filled if this rate table has 3 or more rate dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension1TierId":{
            "type":"string",
            "description":"The unique identifier of the first rate dimension tier associated with the rate value.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RateDimension1Id",
                    "RateTableId"
                ]
            }
        },
        "RateDimension10Id":{
            "type":"string",
            "description":"The unique identifier of the tenth rate dimension record associated with the rate value. This value will only be filled if the rate table has 10 rate dimensions.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension10TierId":{
            "type":"string",
            "description":"The unique identifier of the tenth rate dimension tier associated with the rate value. This value will only be filled if this rate table has 10 rate dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension4Id":{
            "type":"string",
            "description":"The unique identifier of the fourth rate dimension record associated with the rate value. This value will only be filled if the rate table has 4 or more rate dimensions.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension3Id":{
            "type":"string",
            "description":"The unique identifier of the third rate dimension record associated with the rate value. This value will only be filled if the rate table has 3 or more rate dimensions.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension6Id":{
            "type":"string",
            "description":"The unique identifier of the sixth rate dimension record associated with the rate value. This value will only be filled if the rate table has 6 or more rate dimensions.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension5Id":{
            "type":"string",
            "description":"The unique identifier of the fifth rate dimension record associated with the rate value. This value will only be filled if the rate table has 5 or more rate dimensions.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension8Id":{
            "type":"string",
            "description":"The unique identifier of the eighth rate dimension record associated with the rate value. This value will only be filled if the rate table has 8 or more rate dimensions.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension5TierId":{
            "type":"string",
            "description":"The unique identifier of the fifth rate dimension tier associated with the rate value. This value will only be filled if this rate table has 5 or more rate dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension7Id":{
            "type":"string",
            "description":"The unique identifier of the seventh rate dimension record associated with the rate value. This value will only be filled if the rate table has 7 or more rate dimensions.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension9Id":{
            "type":"string",
            "description":"The unique identifier of the ninth rate dimension record associated with the rate value. This value will only be filled if the rate table has 9 or more rate dimensions.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateTableNumberDim":{
            "title":"Number of Dimensions",
            "type":"integer",
            "description":"The number of dimensions in the rate table. The rate table REST service only supports up to 10 dimensions.",
            "nullable":true,
            "x-queryable":false
        },
        "RateDimension2Id":{
            "type":"string",
            "description":"The unique identifier of the second rate dimension record associated with the rate value. This value will only be filled if the rate table has 2 or more rate dimensions.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension1Id":{
            "type":"string",
            "description":"The unique identifier of the first rate dimension record associated with the rate value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RateTableId"
                ]
            }
        },
        "RateDimension9TierId":{
            "type":"string",
            "description":"The unique identifier of the ninth rate dimension tier associated with the rate value. This value will only be filled if this rate table has 9 or more rate dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Rate":{
            "title":"Rate",
            "type":"number",
            "description":"The output value of the rate table, which can be used to calculate the earning rate or the attainment rate. This value could be a percent or an amount depending on the rate table type set for the rate table. If the rate table type is percent, then the value stored here needs to be divided by 100 to get the actual value. For example, if the rate table type is percent and the rate value is 10%, then 10 is the output value.",
            "nullable":true
        },
        "RateDimension7TierId":{
            "type":"string",
            "description":"The unique identifier of the seventh rate dimension tier associated with the rate value. This value will only be filled if this rate table has 7 or more rate dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension2TierId":{
            "type":"string",
            "description":"The unique identifier of the second rate dimension tier associated with the rate value. This value will only be filled if this rate table has 2 or more rate dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OrgId":{
            "type":"integer",
            "description":"The unique identifier of the business unit. You can update this value from a list of acceptable values in the Manage Business Units task in Setup and Maintenance work area.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RateDimension6TierId":{
            "type":"string",
            "description":"The unique identifier of the sixth rate dimension tier associated with the rate value. This value will only be filled if this rate table has 6 or more rate dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension4TierId":{
            "type":"string",
            "description":"The unique identifier of the fourth rate dimension tier associated with the rate value. This value will only be filled if this rate table has 4 or more rate dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateTableId":{
            "type":"integer",
            "description":"The unique identifier of the rate table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

ルート・スキーマ : rateTables-item-response

タイプ: object

ソースを表示

CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

レート表レコードを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

レート表レコードが作成された日時。
Description: string

タイトル: Description

最大長: 1000

レート表に関連するユーザーが追加した追加詳細。
DisplayName: string

タイトル: Display Name

最大長: 80

このレート表を表すために営業担当のユーザー・インタフェースに表示されるレート表の名前(オプション)。
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

レート表の名前。レート表は、さまざまなパフォーマンス・レベルに対して給与比率レートや固定額を設定するために使用します。
NumberDim: integer (int64)

タイトル: Number of Dimensions

読取り専用: true

デフォルト値: 0

レート表のディメンションの数。デフォルト値は0です。
OrgId: integer (int64)

タイトル: Business Unit

ビジネス・ユニットの一意の識別子。値は、設定およびメンテナンスのビジネス・ユニットの管理タスクで許容可能な値のリストから更新できます。
RateTableDimensions: array Rate Table Dimensions

タイトル: Rate Table Dimensions

レート表 - ディメンション・リソースは、ディメンションとレート表の関連付けを作成、更新または削除するために使用されます。また、レート表のディメンションのすべての詳細を表示するために使用することもできます。 RESTサービスを使用してレート表に追加できるのは、最大10個のレート・ディメンションのみです。
RateTableId: integer (int64)

読取り専用: true

レート表の一意の識別子。
RateTableRates: array Rate Table Rates

タイトル: Rate Table Rates

レート表レート・リソースは、レート表またはスコア・カードのレートを作成、表示または更新するために使用されます。また、レート表またはスコア・カードのすべてのレートを表示するために使用することもできます。ゼロ以外の値のレートのみを作成できます。
RateTableType: string

タイトル: Type

最大長: 30

デフォルト値: AMOUNT

パーセントや金額など、レート表のレートの性質を表す参照コード。指定可能な値は、AMOUNTおよびPERCENTです。デフォルト値はAMOUNTです。許容可能な値のリストは、参照CN_COMMISSION_UNIT_CODEで定義されます。設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the rate table record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the rate table record 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 rate table record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The additional details added by the user related to rate tables.",
            "nullable":true,
            "x-queryable":true
        },
        "RateTableType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The lookup code that represents the nature of rates in the rate table, such as a percentage and amount. Possible values include AMOUNT and PERCENT. The default value is AMOUNT. A list of acceptable values is defined in the lookup CN_COMMISSION_UNIT_CODE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "default":"AMOUNT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RateTableRates":{
            "title":"Rate Table Rates",
            "type":"array",
            "description":"The rate table rates resource is used to create, view, or update the rates for a rate table or a scorecard. It can also be used to display all the rates of a rate table or a scorecard. You can only create rates with non-zero values.",
            "items":{
                "$ref":"#/components/schemas/rateTables-RateTableRates-item-response"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of a rate table. A rate table is used to establish compensation percentage rates or fixed amounts for different performance levels.",
            "nullable":false,
            "x-queryable":true
        },
        "OrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit. The value can be updated from a list of acceptable values in the Manage Business Units task in Setup and Maintenance.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "NumberDim":{
            "title":"Number of Dimensions",
            "type":"integer",
            "description":"The number of dimensions in the rate table. Default value is 0.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Display Name",
            "maxLength":80,
            "type":"string",
            "description":"The optional name of the rate table that is shown to the sales representative's user interface to represent this rate table.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RateTableDimensions":{
            "title":"Rate Table Dimensions",
            "type":"array",
            "description":"The rate table - dimensions resource is used to create, update, or delete the association of dimensions to a rate table. It can also be used to display all details of the dimensions in a rate table. You can only add up to ten rate dimensions to a rate table using REST Services.",
            "items":{
                "$ref":"#/components/schemas/rateTables-RateTableDimensions-item-response"
            }
        },
        "RateTableId":{
            "type":"integer",
            "description":"The unique identifier for the rate table.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the rate table record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login associated with the user who last updated the record.",
            "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

タイトル: Rate Table Dimensions

ソースを表示

Array of: object rateTables-RateTableDimensions-item-response

{
    "title":"Rate Table Dimensions",
    "type":"array",
    "description":"The rate table - dimensions resource is used to create, update, or delete the association of dimensions to a rate table. It can also be used to display all details of the dimensions in a rate table. You can only add up to ten rate dimensions to a rate table using REST Services.",
    "items":{
        "$ref":"#/components/schemas/rateTables-RateTableDimensions-item-response"
    }
}

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

タイプ: array

タイトル: Rate Table Rates

ソースを表示

Array of: object rateTables-RateTableRates-item-response

{
    "title":"Rate Table Rates",
    "type":"array",
    "description":"The rate table rates resource is used to create, view, or update the rates for a rate table or a scorecard. It can also be used to display all the rates of a rate table or a scorecard. You can only create rates with non-zero values.",
    "items":{
        "$ref":"#/components/schemas/rateTables-RateTableRates-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."
        }
    }
}

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

リソース・インスタンスに関連付けられたリンク関係。
NumberTier: integer (int64)

タイトル: Number of Tiers

読取り専用: true

デフォルト値: 0

レート表内のレート表ディメンションの階層の数。
RateDimensionId: integer (int64)

タイトル: Name

レート・ディメンション・レコードの一意の識別子。
RateDimensionName: string

タイトル: Name

読取り専用: true

最大長: 80

レート・ディメンションの名前。レート表には、1つ以上のレート・ディメンションを含めることができます。
RateDimensionType: string

タイトル: Type

読取り専用: true

最大長: 30

デフォルト値: AMOUNT

レート表ディメンションの単位。取り得る値は、AMOUNT、EXPRESSION、PERCENTおよびSTRINGです。デフォルト値はAMOUNTです。受理可能な値のリストは、参照CN_DIM_UNIT_CODEで定義されます。設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
RateDimSequence: 整数(int32)

タイトル: Sequence

読取り専用: true

レート表内のレート・ディメンションの指定順序。
RateTableDimensionsUpdateFlag: boolean

読取り専用: true

レート表ディメンションを更新できるかどうかを示します。
RateTableDimensionTiers: array Rate Dimensions Tiers

タイトル: Rate Dimensions Tiers

レート・ディメンション階層リソースは、レート表のレート・ディメンションの階層のすべての詳細を表示するためにのみ使用されます。
RateTableDimId: integer (int64)

レート表のディメンション・レコードの一意の識別子。
RateTableId: integer (int64)

タイトル: Name

レート表の一意の識別子。
RateTableName: string

タイトル: Name

読取り専用: true

最大長: 80

レート表の名前。レート表は、さまざまなパフォーマンス・レベルに対して給与比率レートや固定額を設定するために使用します。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated this record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record 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 this record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RateTableDimensionsUpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the rate table dimension can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimensionId":{
            "title":"Name",
            "type":"integer",
            "description":"The unique identifier for a rate dimension record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            },
            "x-queryable":true
        },
        "RateDimensionName":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of the rate dimension. A rate table can have one or more rate dimensions.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RateTableName":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of the rate table. A rate table is used to establish compensation percentage rates or fixed amounts for different performance levels.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RateTableDimensionTiers":{
            "title":"Rate Dimensions Tiers",
            "type":"array",
            "description":"The rate dimensions tiers resource is only used to view all the details of the tiers in a rate dimension of the rate table.",
            "items":{
                "$ref":"#/components/schemas/rateTables-RateTableDimensions-RateTableDimensionTiers-item-response"
            }
        },
        "RateTableDimId":{
            "type":"integer",
            "description":"The unique identifier for the rate table's dimension record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RateDimSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The specified order of a rate dimension within a rate table.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "NumberTier":{
            "title":"Number of Tiers",
            "type":"integer",
            "description":"The number of tiers in the rate table dimension within the rate table.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RateDimensionType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The unit of measurement for a rate table dimension. Possible values include AMOUNT, EXPRESSION, PERCENT, and STRING. The default value is AMOUNT. A list of acceptable values is defined in the lookup CN_DIM_UNIT_CODE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "readOnly":true,
            "default":"AMOUNT",
            "x-queryable":true
        },
        "RateTableId":{
            "title":"Name",
            "type":"integer",
            "description":"The unique identifier for a rate table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when this record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login associated to the user who last updated the record.",
            "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

タイトル: Rate Dimensions Tiers

レート・ディメンション階層リソースは、レート表のレート・ディメンションの階層のすべての詳細を表示するためにのみ使用されます。

ソースを表示

Array of: object rateTables-RateTableDimensions-RateTableDimensionTiers-item-response

{
    "title":"Rate Dimensions Tiers",
    "type":"array",
    "description":"The rate dimensions tiers resource is only used to view all the details of the tiers in a rate dimension of the rate table.",
    "items":{
        "$ref":"#/components/schemas/rateTables-RateTableDimensions-RateTableDimensionTiers-item-response"
    }
}

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

レート・ディメンション階層の一意の識別子。
RateTableDimensionTiersDeleteFlag: boolean

読取り専用: true

最大長: 255

レート表ディメンション階層レコードがこのサービスを使用して削除できるかどうかを示します。
RateTableDimensionTiersUpdateFlag: boolean

読取り専用: true

最大長: 255

レート表ディメンション階層レコードがこのサービスを使用して更新できるかどうかを示します。
StringValue: string

タイトル: String

最大長: 30

レート階層の英数字値。この属性は、レート・ディメンション・タイプが文字列として設定されている場合にのみ使用されます。
TierSequence: 整数(int32)

タイトル: Sequence

読取り専用: true

レート・ディメンション内の階層の指定順序。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RateTableDimensionTiersDeleteFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether the rate table dimension tiers record can be deleted using this service.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "ATTR_INTERNAL_USE":"N"
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record 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 record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimensionId":{
            "type":"integer",
            "description":"The unique identifier of a rate dimension.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RateDimTierId":{
            "type":"integer",
            "description":"The unique identifier of a rate dimension tier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MaximumAmount":{
            "title":"To",
            "type":"number",
            "description":"The maximum amount of the rate tier. This attribute is only used when the rate dimension type is set as amount or percent. If the rate dimension type is percent, then the maximum amount stored here needs to be divided by 100 to get the actual value. For example, if the rate dimension is percent and the maximum amount is 20%, then 20 is maximum amount value.",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumExpressionId":{
            "title":"From",
            "type":"integer",
            "description":"The unique identifier of the minimum expression. This represents the rate dimension starting tier only when rate dimension type is set as Expression.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            },
            "x-queryable":true
        },
        "MaximumExpressionId":{
            "title":"To",
            "type":"integer",
            "description":"The unique identifier of the maximum expression. This represents the rate dimension ending tier only when rate dimension type is set as Expression.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            },
            "x-queryable":true
        },
        "RateTableDimensionTiersUpdateFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether the rate table dimension tiers record can be updated using this service.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "ATTR_INTERNAL_USE":"N"
            }
        },
        "MinimumExpressionName":{
            "title":"From",
            "type":"string",
            "description":"The name of the minimum expression.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The specified order of a tier within a rate dimension.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MinimumAmount":{
            "title":"From",
            "type":"number",
            "description":"The minimum amount of the rate tier. This attribute is only used when the rate dimension type is set as amount or percent. If the rate dimension type is percent, then the minimum amount stored here needs to be divided by 100 to get the actual value. For example, if the rate dimension is percent and the minimum amount is 10%, then 10 is the minimum amount value.",
            "nullable":true,
            "x-queryable":true
        },
        "StringValue":{
            "title":"String",
            "maxLength":30,
            "type":"string",
            "description":"The alphanumeric value of a rate tier. This attribute is only used when the rate dimension type is set as string.",
            "nullable":true,
            "x-queryable":true
        },
        "MaximumExpressionName":{
            "title":"To",
            "type":"string",
            "description":"The name of the maximum expression.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login associated with the user who last updated the record.",
            "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"
    }
}

ネストされたスキーマ : rateTables-RateTableRates-item-response

タイプ: object

ソースを表示

CreatedBy: string

読取り専用: true

最大長: 64

レコードを作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

レコードが作成された日時。
LastUpdateDate: string (date-time)

読取り専用: true

レコードが最後に更新された日時。
LastUpdatedBy: string

読取り専用: true

最大長: 64

レコードを最後に更新したユーザー。
LastUpdateLogin: string

読取り専用: true

最大長: 32

レコードを最後に更新したユーザーに関連付けられたセッション・ログイン。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
OrgId: integer (int64)

ビジネス・ユニットの一意の識別子。この値は、「設定およびメンテナンス」作業領域のビジネス・ユニットの管理タスクで許容可能な値のリストから更新できます。
レート: number

タイトル: Rate

支給レートまたは達成レートの計算に使用できる、レート表の出力値です。この値は、レート表に対して設定されたレート表タイプに応じて、パーセントまたは金額になります。レート表タイプがパーセントの場合、実際の値を取得するには、ここに保存されている値を100で割る必要があります。たとえば、レート表タイプがパーセントで、レート値が10%の場合、出力値は10です。
RateDimension10Id: string

レート値に関連付けられた10番目のレート・ディメンション・レコードの一意の識別子。この値は、レート表に10個のレート・ディメンションがある場合にのみ入力されます。
RateDimension10TierId: string

レート値に関連付けられた10番目のレート・ディメンション階層の一意の識別子です。この値は、このレート表に10個のレート・ディメンションがある場合にのみ入力されます。
RateDimension1Id: string

レート値に関連付けられた最初のレート・ディメンション・レコードの一意の識別子。
RateDimension1TierId: string

レート値に関連付けられた最初のレート・ディメンション階層の一意の識別子。
RateDimension2Id: string

レート値に関連付けられた2番目のレート・ディメンション・レコードの一意の識別子。この値は、レート表に2つ以上のレート・ディメンションがある場合にのみ入力されます。
RateDimension2TierId: string

レート値に関連付けられた2番目のレート・ディメンション階層の一意の識別子。この値は、このレート表に2つ以上のレート・ディメンションがある場合にのみ入力されます。
RateDimension3Id: string

レート値に関連付けられた3番目のレート・ディメンション・レコードの一意の識別子。この値は、レート表に3つ以上のレート・ディメンションがある場合にのみ入力されます。
RateDimension3TierId: string

レート値に関連付けられた3番目のレート・ディメンション階層の一意の識別子。この値は、このレート表に3つ以上のレート・ディメンションがある場合にのみ入力されます。
RateDimension4Id: string

レート値に関連付けられた4番目のレート・ディメンション・レコードの一意の識別子。この値は、レート表に4つ以上のレート・ディメンションがある場合にのみ入力されます。
RateDimension4TierId: string

レート値に関連付けられた4番目のレート・ディメンション階層の一意の識別子。この値は、このレート表に4つ以上のレート・ディメンションがある場合にのみ入力されます。
RateDimension5Id: string

レート値に関連付けられた5番目のレート・ディメンション・レコードの一意の識別子。この値は、レート表に5つ以上のレート・ディメンションがある場合にのみ入力されます。
RateDimension5TierId: string

レート値に関連付けられた5番目のレート・ディメンション階層の一意の識別子。この値は、このレート表に5つ以上のレート・ディメンションがある場合にのみ入力されます。
RateDimension6Id: string

レート値に関連付けられた6番目のレート・ディメンション・レコードの一意の識別子。この値は、レート表に6つ以上のレート・ディメンションがある場合にのみ入力されます。
RateDimension6TierId: string

レート値に関連付けられた6番目のレート・ディメンション階層の一意の識別子。この値は、このレート表に6つ以上のレート・ディメンションがある場合にのみ入力されます。
RateDimension7Id: string

レート値に関連付けられた7番目のレート・ディメンション・レコードの一意の識別子。この値は、レート表に7つ以上のレート・ディメンションがある場合にのみ入力されます。
RateDimension7TierId: string

レート値に関連付けられた7番目のレート・ディメンション階層の一意の識別子です。この値は、このレート表に7つ以上のレート・ディメンションがある場合にのみ入力されます。
RateDimension8Id: string

レート値に関連付けられた8番目のレート・ディメンション・レコードの一意の識別子。この値は、レート表に8つ以上のレート・ディメンションがある場合にのみ入力されます。
RateDimension8TierId: string

レート値に関連付けられた8番目のレート・ディメンション階層の一意の識別子。この値は、このレート表に8つ以上のレート・ディメンションがある場合にのみ入力されます。
RateDimension9Id: string

レート値に関連付けられた9番目のレート・ディメンション・レコードの一意の識別子。この値は、レート表に9つ以上のレート・ディメンションがある場合にのみ入力されます。
RateDimension9TierId: string

レート値に関連付けられた9番目のレート・ディメンション階層の一意の識別子。この値は、このレート表に9つ以上のレート・ディメンションがある場合にのみ入力されます。
RateTableId: integer (int64)

レート表の一意の識別子。
RateTableNumberDim: integer

タイトル: Number of Dimensions

レート表のディメンションの数。レート表RESTサービスでサポートされるディメンションは最大10個のみです。
RateTableRateId: integer (int64)

読取り専用: true

レート表値の一意の識別子。
RateTableRatesDeleteFlag: boolean

読取り専用: true

最大長: 255

このサービスを使用してレート表レート・レコードを削除できないことを示します。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension8TierId":{
            "type":"string",
            "description":"The unique identifier of the eighth rate dimension tier associated with the rate value. This value will only be filled if this rate table has 8 or more rate dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RateDimension3TierId":{
            "type":"string",
            "description":"The unique identifier of the third rate dimension tier associated with the rate value. This value will only be filled if this rate table has 3 or more rate dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RateDimension1TierId":{
            "type":"string",
            "description":"The unique identifier of the first rate dimension tier associated with the rate value.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RateDimension1Id",
                    "RateTableId"
                ]
            },
            "x-queryable":true
        },
        "RateDimension10Id":{
            "type":"string",
            "description":"The unique identifier of the tenth rate dimension record associated with the rate value. This value will only be filled if the rate table has 10 rate dimensions.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateTableRateId":{
            "type":"integer",
            "description":"The unique identifier of the rate table value.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RateDimension10TierId":{
            "type":"string",
            "description":"The unique identifier of the tenth rate dimension tier associated with the rate value. This value will only be filled if this rate table has 10 rate dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RateDimension4Id":{
            "type":"string",
            "description":"The unique identifier of the fourth rate dimension record associated with the rate value. This value will only be filled if the rate table has 4 or more rate dimensions.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension3Id":{
            "type":"string",
            "description":"The unique identifier of the third rate dimension record associated with the rate value. This value will only be filled if the rate table has 3 or more rate dimensions.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension6Id":{
            "type":"string",
            "description":"The unique identifier of the sixth rate dimension record associated with the rate value. This value will only be filled if the rate table has 6 or more rate dimensions.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension5Id":{
            "type":"string",
            "description":"The unique identifier of the fifth rate dimension record associated with the rate value. This value will only be filled if the rate table has 5 or more rate dimensions.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension8Id":{
            "type":"string",
            "description":"The unique identifier of the eighth rate dimension record associated with the rate value. This value will only be filled if the rate table has 8 or more rate dimensions.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension5TierId":{
            "type":"string",
            "description":"The unique identifier of the fifth rate dimension tier associated with the rate value. This value will only be filled if this rate table has 5 or more rate dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RateDimension7Id":{
            "type":"string",
            "description":"The unique identifier of the seventh rate dimension record associated with the rate value. This value will only be filled if the rate table has 7 or more rate dimensions.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension9Id":{
            "type":"string",
            "description":"The unique identifier of the ninth rate dimension record associated with the rate value. This value will only be filled if the rate table has 9 or more rate dimensions.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RateTableNumberDim":{
            "title":"Number of Dimensions",
            "type":"integer",
            "description":"The number of dimensions in the rate table. The rate table REST service only supports up to 10 dimensions.",
            "nullable":true,
            "x-queryable":false
        },
        "RateDimension2Id":{
            "type":"string",
            "description":"The unique identifier of the second rate dimension record associated with the rate value. This value will only be filled if the rate table has 2 or more rate dimensions.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension1Id":{
            "type":"string",
            "description":"The unique identifier of the first rate dimension record associated with the rate value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RateTableId"
                ]
            }
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension9TierId":{
            "type":"string",
            "description":"The unique identifier of the ninth rate dimension tier associated with the rate value. This value will only be filled if this rate table has 9 or more rate dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Rate":{
            "title":"Rate",
            "type":"number",
            "description":"The output value of the rate table, which can be used to calculate the earning rate or the attainment rate. This value could be a percent or an amount depending on the rate table type set for the rate table. If the rate table type is percent, then the value stored here needs to be divided by 100 to get the actual value. For example, if the rate table type is percent and the rate value is 10%, then 10 is the output value.",
            "nullable":true,
            "x-queryable":true
        },
        "RateDimension7TierId":{
            "type":"string",
            "description":"The unique identifier of the seventh rate dimension tier associated with the rate value. This value will only be filled if this rate table has 7 or more rate dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RateTableRatesDeleteFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates that the rate table rates record cannot be deleted using this service.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "ATTR_INTERNAL_USE":"N"
            }
        },
        "RateDimension2TierId":{
            "type":"string",
            "description":"The unique identifier of the second rate dimension tier associated with the rate value. This value will only be filled if this rate table has 2 or more rate dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OrgId":{
            "type":"integer",
            "description":"The unique identifier of the business unit. You can update this value from a list of acceptable values in the Manage Business Units task in Setup and Maintenance work area.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RateDimension6TierId":{
            "type":"string",
            "description":"The unique identifier of the sixth rate dimension tier associated with the rate value. This value will only be filled if this rate table has 6 or more rate dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RateDimension4TierId":{
            "type":"string",
            "description":"The unique identifier of the fourth rate dimension tier associated with the rate value. This value will only be filled if this rate table has 4 or more rate dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RateTableId":{
            "type":"integer",
            "description":"The unique identifier of the rate table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The session login associated with the user who last updated the record.",
            "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"
    }
}

リンク

BusinessUnitPVO

操作: /fscmRestApi/resources/11.13.18.05/incentiveCompensationBusinessUnitsLOV

ビジネス・ユニット値リスト・リソースは、定義済ビジネス・ユニットのリストを表示するために使用されます。

CnLookupRateTableTypeVO

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DCN_COMMISSION_UNIT_CODE

標準参照値リスト・リソースは、標準参照の値リストを問い合せるために使用されます。このリストには、使用可能なコードと翻訳された内容がリストされます。標準参照は、参照データ共有をサポートする標準参照ビューおよび格納参照コードで定義されます。

RateTableDimensions

操作: /fscmRestApi/resources/11.13.18.05/rateTables/{RateTableId}/child/RateTableDimensions

パラメータ:

RateTableId: $request.path.RateTableId

RateTableRates

操作: /fscmRestApi/resources/11.13.18.05/rateTables/{RateTableId}/child/RateTableRates

パラメータ:

RateTableId: $request.path.RateTableId

トップに戻る

例:

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

cURLコマンド

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateTables/

リクエスト本文の例

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

{

  "Name": "QA rate table for scenario 800 copy",
  "Description": "QA Testing Rate Table",
  "OrgId": 204,
  "DisplayName": "QA rate table for scenario 800",
  "RateTableType": "AMOUNT"
  
}

レスポンス本文の例

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

{
  "RateTableId": 300100089812733,
  "Name": "QA rate table for scenario 800 copy",
  "Description": "QA Testing Rate Table",
  "OrgId": 204,
  "NumberDim": 0,
  "DisplayName": "QA rate table for scenario 800",
  "RateTableType": "AMOUNT",
  "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
  "CreationDate": "2017-05-03T06:04:21-07:00",
  "LastUpdateDate": "2017-05-03T06:04:21.983-07:00",
  "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
  "LastUpdateLogin": "4E9ED6AF16CC64C9E0532DD6F00AFFA5",
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateTables/300100089812733",
      "name": "rateTables",
      "kind": "item",
      "properties": {
        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
      }
    },
    {
      "rel": "canonical",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateTables/300100089812733",
      "name": "rateTables",
      "kind": "item"
    },
    {
      "rel": "lov",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateTables/300100089812733/lov/CnLookupRateTableTypeVO",
      "name": "CnLookupRateTableTypeVO",
      "kind": "collection"
    },
    {
      "rel": "lov",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateTables/300100089812733/lov/BusinessUnitPVO",
      "name": "BusinessUnitPVO",
      "kind": "collection"
    },
    {
      "rel": "child",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateTables/300100089812733/child/RateTableDimensions",
      "name": "RateTableDimensions",
      "kind": "collection"
    }
  ]
}

「トップに戻る」