機械翻訳について

ジャンプ先

• リクエスト
• レスポンス
• 例

レート・ディメンション入力の更新

patch

/fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureRateDimensionalInputs/{PerformanceMeasureInputExpressionId}

リクエスト

パス・パラメータ

• PerformanceMeasureId(required): integer(int64)
  パフォーマンス・メジャーの一意の識別子。
• PerformanceMeasureInputExpressionId(required): integer(int64)
  パフォーマンス・メジャーで使用されるスコア・カードのレート・ディメンションに対する入力式の一意の識別子。

ヘッダー・パラメータ

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

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

• application/json

リクエスト本文 - application/json ()

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

• AccumulateFlag: boolean
  タイトル: Accumulate

  最大長: 1

  デフォルト値: false

  複数のディメンションを持つスコア・カードの累計を使用する場合、合計を適用するレート・ディメンション入力式(レート・ディメンション)を示します。 取り得る値はFALSEとTRUEです。 デフォルト値はFALSEです。
• InputExpressionId: integer (int64)
  タイトル: Input Expression ID

  ビジネス・ユニットの入力式レコードの一意の識別子。 これは、パフォーマンス・メジャーで使用されるスコア・カードのレート・ディメンションに対する入力式を表します。
• InputExpressionName: string
  タイトル: Input Expression Name

  最大長: 160

  パフォーマンス・メジャーで使用されるスコア・カードのレート・ディメンションに対する入力式の名前。
• PerformanceMeasureId: integer (int64)
  タイトル: Performance Measure ID

  パフォーマンス・メジャー・レコードの一意の識別子。
• RateDimSequence: integer (int64)
  タイトル: Rate Dimension Sequence

  スコア・カード内のレート・ディメンションの順序。
• SplitFlag: boolean
  タイトル: Apply split

  最大長: 1

  デフォルト値: false

  レートを階層間で分割する際に、分割オプションを1つのレート・ディメンション入力式にのみ適用できるかどうかを示します。 これによって、使用するレート・ディメンション入力式(レート・ディメンション)が通知されます。 取り得る値はFALSEとTRUEです。 デフォルト値はFALSEです。

{
    "type":"object",
    "properties":{
        "AccumulateFlag":{
            "title":"Accumulate",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates which rate dimension input expression (rate dimension) does running total apply to, when using running total for a scorecard with multiple dimensions. Possible values include FALSE and TRUE. The default value is FALSE.",
            "nullable":true,
            "default":false
        },
        "SplitFlag":{
            "title":"Apply split",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the split option can apply to only one rate dimension input expression when splitting the rate across tiers. This informs which rate dimension input expression (rate dimension) to use. Possible values include FALSE and TRUE. The default value is FALSE.",
            "nullable":true,
            "default":false
        },
        "InputExpressionName":{
            "title":"Input Expression Name",
            "maxLength":160,
            "type":"string",
            "description":"The name for the input expression to the rate dimension of the scorecard used in the performance measure.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "InputExpressionId":{
            "title":"Input Expression ID",
            "type":"integer",
            "description":"The unique identifier for the input expression record for a business unit. This represents the input expression to the rate dimension of the scorecard used in the performance measure.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RateDimSequence":{
            "title":"Rate Dimension Sequence",
            "type":"integer",
            "description":"The order of a rate dimension within a scorecard.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PerformanceMeasureId":{
            "title":"Performance Measure ID",
            "type":"integer",
            "description":"The unique identifier for a performance measure record.",
            "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のデフォルト・バージョンを選択します。

本文( )

ルート・スキーマ : incentiveCompensationPerformanceMeasures-performanceMeasureRateDimensionalInputs-item-response

タイプ: object

ソースを表示

• AccumulateFlag: boolean
  タイトル: Accumulate

  最大長: 1

  デフォルト値: false

  複数のディメンションを持つスコア・カードの累計を使用する場合、合計を適用するレート・ディメンション入力式(レート・ディメンション)を示します。 取り得る値はFALSEとTRUEです。 デフォルト値はFALSEです。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 255

  レコードを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  レコードが作成された日時。
• InputExpressionDescription: string
  タイトル: Description

  読取り専用: true

  最大長: 1000

  式の作成時に入力したレート・ディメンション入力式の摘要。
• InputExpressionId: integer (int64)
  タイトル: Input Expression ID

  ビジネス・ユニットの入力式レコードの一意の識別子。 これは、パフォーマンス・メジャーで使用されるスコア・カードのレート・ディメンションに対する入力式を表します。
• InputExpressionName: string
  タイトル: Input Expression Name

  最大長: 160

  パフォーマンス・メジャーで使用されるスコア・カードのレート・ディメンションに対する入力式の名前。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  レコードが最後に更新された日時。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 255

  このレコードを最後に更新したユーザー。
• LastUpdateLogin: string
  タイトル: Last Update Login

  読取り専用: true

  最大長: 32

  レコードを最後に更新したユーザーのセッション・ログイン。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• PerformanceMeasureId: integer (int64)
  タイトル: Performance Measure ID

  パフォーマンス・メジャー・レコードの一意の識別子。
• PerformanceMeasureInputExpressionId: integer (int64)
  タイトル: Performance Measure Input Expression Id

  パフォーマンス・メジャーで使用されるスコア・カードのレート・ディメンションに対する入力式の一意の識別子。
• PerformanceMeasureRateDimensionalInputsDeleteFlag: boolean
  読取り専用: true

  デフォルト値: false

  レート・ディメンション入力を削除できるかどうかを示します。
• RateDimName: integer
  タイトル: Dimension Name

  読取り専用: true

  レート・ディメンションの名前。 スコア・カードには、1つ以上のレート・ディメンションを設定できます。
• RateDimSequence: integer (int64)
  タイトル: Rate Dimension Sequence

  スコア・カード内のレート・ディメンションの順序。
• SplitFlag: boolean
  タイトル: Apply split

  最大長: 1

  デフォルト値: false

  レートを階層間で分割する際に、分割オプションを1つのレート・ディメンション入力式にのみ適用できるかどうかを示します。 これによって、使用するレート・ディメンション入力式(レート・ディメンション)が通知されます。 取り得る値はFALSEとTRUEです。 デフォルト値はFALSEです。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated this record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InputExpressionDescription":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The rate dimensional input expression description entered  while creating the expression.",
            "nullable":true,
            "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":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SplitFlag":{
            "title":"Apply split",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the split option can apply to only one rate dimension input expression when splitting the rate across tiers. This informs which rate dimension input expression (rate dimension) to use. Possible values include FALSE and TRUE. The default value is FALSE.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "PerformanceMeasureRateDimensionalInputsDeleteFlag":{
            "type":"boolean",
            "description":"Inidcates whether a rate dimensional input can be deleted.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "PerformanceMeasureId":{
            "title":"Performance Measure ID",
            "type":"integer",
            "description":"The unique identifier for a performance measure record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AccumulateFlag":{
            "title":"Accumulate",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates which rate dimension input expression (rate dimension) does running total apply to, when using running total for a scorecard with multiple dimensions. Possible values include FALSE and TRUE. The default value is FALSE.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "PerformanceMeasureInputExpressionId":{
            "title":"Performance Measure Input Expression Id",
            "type":"integer",
            "description":"The unique identifier for the input expression to the rate dimension of the scorecard used in the performance measure.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RateDimName":{
            "title":"Dimension Name",
            "type":"integer",
            "description":"The name of the rate dimension. A scorecard can have one or more rate dimensions.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InputExpressionName":{
            "title":"Input Expression Name",
            "maxLength":160,
            "type":"string",
            "description":"The name for the input expression to the rate dimension of the scorecard used in the performance measure.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "InputExpressionId":{
            "title":"Input Expression ID",
            "type":"integer",
            "description":"The unique identifier for the input expression record for a business unit. This represents the input expression to the rate dimension of the scorecard used in the performance measure.",
            "format":"int64",
            "nullable":true,
            "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":"Rate Dimension Sequence",
            "type":"integer",
            "description":"The order of a rate dimension within a scorecard.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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 of 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"
    }
}

ネストされたスキーマ : リンク

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

リンク

ExpressionUsagesVO

操作: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionUsagesLOV

パフォーマンス・メジャーで使用されるスコア・カードのレート・ディメンションの入力式の名前を含む値リスト。

LOVリンク関連では、次のプロパティが定義されます:

• ソース属性: InputExpressionName;ターゲット属性: ExpressionName
• 表示属性: ExpressionName、説明

RateDimensionsVO

操作: /fscmRestApi/resources/11.13.18.05/rateDimensions

レート・ディメンションの名前を含む値リスト。 スコア・カードには、1つ以上のレート・ディメンションを設定できます。

LOVリンク関連では、次のプロパティが定義されます:

• ソース属性: RateDimName;ターゲット属性: RateDimSequence
• 表示属性: RateDimensionName

トップに戻る

例:

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

cURLコマンド

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

リクエスト本文の例

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

{
"InputExpressionId" : 100000015115055,
"SplitFlag" : false,  
"AccumulateFlag" : false
}

レスポンス本文の例

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

{
  "PerformanceMeasureInputExpressionId": 300100090511045,
  "PerformanceMeasureId": 300100090511017,
  "InputExpressionId": 100000015115055,
  "RateDimSequence": null,
  "AccumulateFlag": false,
  "SplitFlag": false,
  "InputExpressionName": "Credit Amount",
  "InputExpressionDescription": "Credit Amount in Calc Currency",
  "RateDimName": null,
  "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
  "CreationDate": "2017-06-08T11:37:20.012-07:00",
  "LastUpdateDate": "2017-06-08T12:20:34.207-07:00",
  "LastUpdateLogin": "516E508C5BC4377FE0532DD6F00A0214",
  "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
  "PerformanceMeasureRateDimensionalInputsDeleteFlag": false,
  "links": [
    ...
  ]
}

「トップに戻る」