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

機械翻訳について

レート・ディメンションの取得

get

/fscmRestApi/resources/11.13.18.05/rateDimensions/{RateDimensionId}

リクエスト

パス・パラメータ

RateDimensionId(required): integer(int64)

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

問合せパラメータ

dependency: string

このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。通常、これらは属性変更の影響をプレビューするために使用されます。このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。この問合せパラメータの値は、依存性フィールドのセットです。例: dependency=ProductId=2

フォーマット: <attr1>=<val1>,<attr2>=<value2>
expand: string

このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。この問合せパラメータの値は"all"または""です。カンマをセパレータとして使用して、複数の子を指定できます。例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
fields: string

このパラメータは、リソース・フィールドをフィルタします。指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。両方を指定した場合、フィールドのみが考慮されます。

フォーマット : ?fields=Attribute1,Attribute2

子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
links: string

このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

例:
self,canonical
onlyData: boolean

リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。

ヘッダー・パラメータ

Metadata-Context:

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

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

この操作にはリクエスト本文がありません。

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

ルート・スキーマ : 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で定義されます。設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。

{
    "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
        },
        "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
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The additional details added by the user related to rate dimensions.",
            "nullable":true,
            "x-queryable":true
        },
        "RateDimensionId":{
            "type":"integer",
            "description":"The unique identifier for the rate dimension record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RateDimensionTiers":{
            "title":"Rate Dimension - Tiers",
            "type":"array",
            "description":"The rate dimensions tiers resource is used to create, update, or delete the association of tiers to a rate dimension. It can also be used to display all the details of the tiers in a dimension.",
            "items":{
                "$ref":"#/components/schemas/rateDimensions-RateDimensionTiers-item-response"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of the rate dimension.",
            "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "NumberTier":{
            "title":"Number of Tiers",
            "type":"integer",
            "description":"The number of tiers for rate dimensions. The default value is 0.",
            "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 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,
            "default":"AMOUNT",
            "x-hints":{
                "controlType":"choice"
            },
            "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"
    }
}

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

タイプ: array

タイトル: Rate Dimension - Tiers

レート・ディメンション階層リソースは、レート・ディメンションへの階層の関連付けを作成、更新または削除するために使用されます。また、ディメンションの階層のすべての詳細を表示するために使用することもできます。

ソースを表示

Array of: object rateDimensions-RateDimensionTiers-item-response

{
    "title":"Rate Dimension - Tiers",
    "type":"array",
    "description":"The rate dimensions tiers resource is used to create, update, or delete the association of tiers to a rate dimension. It can also be used to display all the details of the tiers in a dimension.",
    "items":{
        "$ref":"#/components/schemas/rateDimensions-RateDimensionTiers-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."
        }
    }
}

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

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

{
    "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
        },
        "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 record.",
            "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 dimension. If the rate dimension is percentage, then the maximum amount is converted to a number (by dividing it by 100). For example, if the rate dimension is percentage, and the minimum amount is 20% then is it converted to 20.",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumExpressionId":{
            "title":"From",
            "type":"integer",
            "description":"This is a unique identifier for minimum expression. This represents the rate dimension starting tier where tiers are expressions.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            },
            "x-queryable":true
        },
        "MaximumExpressionId":{
            "title":"To",
            "type":"integer",
            "description":"This is a unique identifier for maximum expression. This represents the rate dimension ending tier where tiers are expressions.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            },
            "x-queryable":true
        },
        "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 dimension. If the rate dimension is percentage, then the minimum amount is converted to a number (by dividing it by 100). For example, if the rate dimension is percentage, and the minimum amount is 10% then is it converted to 10.",
            "nullable":true,
            "x-queryable":true
        },
        "StringValue":{
            "title":"String",
            "maxLength":30,
            "type":"string",
            "description":"The alphanumeric value of a rate dimension tier with type 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 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"
    }
}

リンク

BusinessUnitPVO

操作: /fscmRestApi/resources/11.13.18.05/incentiveCompensationBusinessUnitsLOV

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

CnLookupRateDimensionTypeVO

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

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

RateDimensionTiers

操作: /fscmRestApi/resources/11.13.18.05/rateDimensions/{RateDimensionId}/child/RateDimensionTiers

パラメータ:

RateDimensionId: $request.path.RateDimensionId

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、レート・ディメンションを取得する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089570738

レスポンス本文の例

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

{
   "RateDimensionId": 300100089570738,
   "Name": "Sales Amount",
   "Description": "The amount of sales achieved in USD",
   "RateDimensionType": "AMOUNT",
   "OrgId": 204,
   "NumberTier": 4,
   "LastUpdateDate": "2016-09-21T21:31:16+05:30",
   "LastUpdateLogin": "3CEB7E6D973C0A67E053CB90B10AABA3",
   "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
   "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
   "CreationDate": "2016-09-21T21:31:16+05:30",
   "links":    [
            {
         "rel": "self",
         "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089570738",
         "name": "rateDimensions",
         "kind": "item",
         "properties": {"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"}
      },
            {
         "rel": "canonical",
         "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/lov/BusinessUnitPVO",
         "name": "BusinessUnitPVO",
         "kind": "collection"
      },
            {
         "rel": "lov",
         "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089570738/lov/CnLookupRateDimensionTypeVO",
         "name": "CnLookupRateDimensionTypeVO",
         "kind": "collection"
      },
            {
         "rel": "child",
         "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089570738/child/RateDimensionTiers",
         "name": "RateDimensionTiers",
         "kind": "collection"
      }
   ]
}

「トップに戻る」