機械翻訳について

ジャンプ先

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

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

patch

/fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentIncentiveFormulas/{IncentiveFormulaId}/child/planComponentRateDimensionalInputs/{PlanComponentInputExpressionId}

リクエスト

パス・パラメータ

• IncentiveFormulaId(required): integer(int64)
  インセンティブ算式レコードの一意の識別子。 1つのプラン・コンポーネントに対して1つのインセンティブ算式のみを指定できます。
• PlanComponentInputExpressionId(required): integer(int64)
  プラン・コンポーネントの入力式レコードの一意の識別子。
• planComponentsUniqID(required): string
  これは、プラン・コンポーネント・リソースのコンポジット・キー(PlanComponentIdおよびOrgId)を構成する属性のハッシュ・キーで、プラン・コンポーネントのインスタンスを一意に識別するために使用されます。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、プラン・コンポーネントの特定のインスタンスに移動するために、主キー値に対するフィルタを使用してプラン・コンポーネント・コレクション・リソースを問い合せる必要があります。
  
  次に例を示します: planComponents?q=PlanComponentId=<value1>;OrgId=<value2>

ヘッダー・パラメータ

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

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

• application/json

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

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

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

タイプ: object

ソースを表示

• IncentiveFormulaId: integer (int64)
  タイトル: Incentive Formula ID

  インセンティブ算式レコードの一意の識別子。 1つのプラン・コンポーネントに対して1つのインセンティブ算式のみを指定できます。
• InputExpressionId: integer (int64)
  タイトル: Input Expression ID

  レート表のレート・ディメンションの入力式の一意の識別子。
• InputExpressionName: string
  タイトル: Input Expression Name

  最大長: 160

  プラン・コンポーネントで使用されるレート表のレート・ディメンションの入力式の名前。 入力式は、トランザクションから評価する値を制御し、結果と対応するレート表ディメンションを照合します。
• RateDimSequence: integer (int64)
  タイトル: Sequence

  レート表の入力式の順序。
• SplitFlag: boolean
  タイトル: Split

  最大長: 1

  デフォルト値: false

  レートを階層間で分割する場合、分割オプションは1つのレート・ディメンション入力式にのみ適用できます。 使用するレート・ディメンション入力式(レート・ディメンション)を指定します。 可能な値はFALSEおよびTRUEです。 デフォルト値はFALSEです。

{
    "type":"object",
    "properties":{
        "IncentiveFormulaId":{
            "title":"Incentive Formula ID",
            "type":"integer",
            "description":"The unique identifier of the incentive formula record. There can be only one incentive formula for one plan component.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "InputExpressionId":{
            "title":"Input Expression ID",
            "type":"integer",
            "description":"The unique identifier of the input expression for the rate dimension of a rate table.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RateDimSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The order of the input expressions for the rate table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SplitFlag":{
            "title":"Split",
            "maxLength":1,
            "type":"boolean",
            "description":"When splitting the rate across tiers, the split option can apply to only one rate dimension input expression. This specifies which rate dimension input expression (rate dimension) to use. Possible values are FALSE and TRUE. The default value is FALSE.",
            "nullable":true,
            "default":false
        },
        "InputExpressionName":{
            "title":"Input Expression Name",
            "maxLength":160,
            "type":"string",
            "description":"The name of the input expression for the rate dimension of a rate table used in the plan component. The input expression drives a value to evaluate from the transaction and matches the results with the corresponding rate table dimension.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : planComponents-planComponentIncentiveFormulas-planComponentRateDimensionalInputs-item-response

タイプ: object

ソースを表示

• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 255

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

  読取り専用: true

  レコードが作成された日時。
• IncentiveFormulaId: integer (int64)
  タイトル: Incentive Formula ID

  インセンティブ算式レコードの一意の識別子。 1つのプラン・コンポーネントに対して1つのインセンティブ算式のみを指定できます。
• InputExpressionDescription: string
  タイトル: Input Expression 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

  リソース・インスタンスに関連付けられたリンク関係。
• PlanComponentId: integer
  読取り専用: true

  ビジネス・ユニット内のプラン・コンポーネント・レコードの一意の識別子。
• PlanComponentInputExpressionId: integer (int64)
  タイトル: Plan Component Input Expression Id

  プラン・コンポーネントの入力式レコードの一意の識別子。
• PlanComponentRateDimensionalInputsDeleteFlag: boolean
  読取り専用: true

  デフォルト値: false

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

  読取り専用: true

  レート・ディメンションの名前。 レート表には、1つ以上のレート・ディメンションを含めることができます。
• RateDimSequence: integer (int64)
  タイトル: Sequence

  レート表の入力式の順序。
• SplitFlag: boolean
  タイトル: 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 the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InputExpressionDescription":{
            "title":"Input Expression Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the input expression 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":"Split",
            "maxLength":1,
            "type":"boolean",
            "description":"When splitting the rate across tiers, the split option can apply to only one rate dimension input expression. This specifies which rate dimension input expression (rate dimension) to use. Possible values are FALSE and TRUE. The default value is FALSE.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "PlanComponentRateDimensionalInputsDeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the rate dimension input can be deleted.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "IncentiveFormulaId":{
            "title":"Incentive Formula ID",
            "type":"integer",
            "description":"The unique identifier of the incentive formula record. There can be only one incentive formula for one plan component.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanComponentId":{
            "type":"integer",
            "description":"The unique identifier of the plan component record within a business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanComponentInputExpressionId":{
            "title":"Plan Component Input Expression Id",
            "type":"integer",
            "description":"The unique identifier of the input expression record for the plan component.",
            "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 rate table 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 of the input expression for the rate dimension of a rate table used in the plan component. The input expression drives a value to evaluate from the transaction and matches the results with the corresponding rate table dimension.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "InputExpressionId":{
            "title":"Input Expression ID",
            "type":"integer",
            "description":"The unique identifier of the input expression for the rate dimension of a rate table.",
            "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":"Sequence",
            "type":"integer",
            "description":"The order of the input expressions for the 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 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

式使用値リスト・リソースは、式を使用できる場所を示す式使用のリストを表示するために使用されます。

トップに戻る

例:

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

cURLコマンド

curl -u <username:password> \ -X PATCH https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/planComponents/00020000000EACED00057708000110F07F4ABECA0000000EACED0005770800000000000000CC/ child/planComponentIncentiveFormulas/300100090511052/child/planComponentRateDimensionalInputs/300100090511103

リクエスト本文の例

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

{
"InputExpressionId" : 300100090511058,
"SplitFlag" : false
}

レスポンス本文の例

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

{
  "PlanComponentInputExpressionId": 300100090511103,
  "IncentiveFormulaId": 300100090511052,
  "InputExpressionId": 300100090511058,
  "RateDimSequence": null,
  "SplitFlag": false,
  "InputExpressionName": "Measure Result",
  "InputExpressionDescription": "Measure result output achieved of sales attainment",
  "RateDimName": null,
  "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
  "CreationDate": "2017-06-09T10:02:10.019-07:00",
  "LastUpdateDate": "2017-06-09T10:14:40.218-07:00",
  "LastUpdateLogin": "5182A4E294CD57DBE0532DD6F00A0C82",
  "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
  "PlanComponentRateDimensionalInputsDeleteFlag": false,
  "PlanComponentId": 300100090511050,
  "links": [
    ...
  ]
}

「トップに戻る」