機械翻訳について

ジャンプ先

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

スコア・カードの作成

post

/fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureScorecards

リクエスト

パス・パラメータ

• PerformanceMeasureId(required): integer(int64)
  パフォーマンス・メジャーの一意の識別子。

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
• Upsert-Mode:
  次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。

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

• application/json

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

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

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

タイプ: object

ソースを表示

• EndDate: 文字列(日付)
  タイトル: End Date

  パフォーマンス・メジャーに対してスコア・カードが非アクティブになる日付。 書式はyyyy-mm-ddです。
• PerformanceMeasureId: integer (int64)
  タイトル: Performance Measure ID

  パフォーマンス・メジャーの名前。
• PerformanceMeasureScorecardId: integer (int64)
  パフォーマンス・メジャー内のスコア・カードの一意の識別子。
• ScorecardId: integer (int64)
  タイトル: Scorecard ID

  スコア・カードの名前。
• ScorecardName: string
  タイトル: Scorecard Name

  最大長: 80

  スコア・カードの名前。 スコア・カードは、様々なパフォーマンス・レベルの達成レートまたは固定金額を設定するために使用されます。
• StartDate: 文字列(日付)
  タイトル: Start Date

  パフォーマンス・メジャーに対してスコア・カードがアクティブになる日付。 書式はyyyy-mm-ddです。

{
    "type":"object",
    "properties":{
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the scorecard becomes active for the performance measure. The format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false
        },
        "PerformanceMeasureScorecardId":{
            "type":"integer",
            "description":"The unique identifier of a scorecard within a performance measure.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ScorecardName":{
            "title":"Scorecard Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of the scorecard. A scorecard is used to establish attainment rates or fixed amounts for different performance levels.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "PerformanceMeasureId":{
            "title":"Performance Measure ID",
            "type":"integer",
            "description":"The name of the performance measure.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ScorecardId":{
            "title":"Scorecard ID",
            "type":"integer",
            "description":"The name of a scorecard.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the scorecard becomes inactive for the performance measure. The format is yyyy-mm-dd.",
            "format":"date",
            "nullable":true
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

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

タイプ: object

ソースを表示

• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 255

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

  読取り専用: true

  レコードが作成された日時。
• EndDate: 文字列(日付)
  タイトル: End Date

  パフォーマンス・メジャーに対してスコア・カードが非アクティブになる日付。 書式はyyyy-mm-ddです。
• 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

  パフォーマンス・メジャーの名前。
• PerformanceMeasureName: string
  タイトル: Performance Measure Name

  読取り専用: true

  最大長: 80

  パフォーマンス・メジャーの名前。
• PerformanceMeasureScorecardId: integer (int64)
  パフォーマンス・メジャー内のスコア・カードの一意の識別子。
• ScorecardDescription: string
  タイトル: Description

  読取り専用: true

  最大長: 1000

  スコア・カードの作成時にユーザーが入力したスコア・カードの摘要。
• ScorecardId: integer (int64)
  タイトル: Scorecard ID

  スコア・カードの名前。
• ScorecardName: string
  タイトル: Scorecard Name

  最大長: 80

  スコア・カードの名前。 スコア・カードは、様々なパフォーマンス・レベルの達成レートまたは固定金額を設定するために使用されます。
• StartDate: 文字列(日付)
  タイトル: Start Date

  パフォーマンス・メジャーに対してスコア・カードがアクティブになる日付。 書式はyyyy-mm-ddです。

{
    "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
        },
        "PerformanceMeasureName":{
            "title":"Performance Measure Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of a performance measure.",
            "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":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PerformanceMeasureScorecardId":{
            "type":"integer",
            "description":"The unique identifier of a scorecard within a performance measure.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ScorecardName":{
            "title":"Scorecard Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of the scorecard. A scorecard is used to establish attainment rates or fixed amounts for different performance levels.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PerformanceMeasureId":{
            "title":"Performance Measure ID",
            "type":"integer",
            "description":"The name of the performance measure.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ScorecardId":{
            "title":"Scorecard ID",
            "type":"integer",
            "description":"The name of a scorecard.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the scorecard becomes inactive for the performance measure. The format is yyyy-mm-dd.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the scorecard becomes active for the performance measure. The format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ScorecardDescription":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the scorecard entered by the user while creating the scorecard.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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."
        }
    }
}

リンク

ScorecardVO

操作: /fscmRestApi/resources/11.13.18.05/rateTables

スコア・カードの名前を含む値リスト。 スコア・カードは、様々なパフォーマンス・レベルの達成レートまたは固定金額を設定するために使用されます。

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

• ソース属性: ScorecardName;ターゲット属性: 名前
• 表示属性: 名前、説明、NumberDim

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対してPOSTリクエストを発行することによってスコア・カードを作成する方法を示しています。

cURLコマンド

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

リクエスト本文の例

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

{ 
"ScorecardId": 300100007837032,
"StartDate": "2016-01-01",
"EndDate": "2016-12-31"
}

レスポンス本文の例

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

{
  "PerformanceMeasureScorecardId": 300100090511044,
  "PerformanceMeasureId": 300100090511017,
  "ScorecardId": 300100007837032,
  "StartDate": "2016-01-01",
  "EndDate": "2016-12-31",
  "ScorecardName": "QA rate table for scenario 800",
  "ScorecardDescription": "0 -30\t1000\t1500\n30-50\t2000\t2500\n50-75\t3000\t3500\n75-100\t4000\t4500\n100 and above\t5000\t5500\n",
  "PerformanceMeasureName": "Sales Attainment 2016",
  "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
  "CreationDate": "2017-06-08T11:37:20-07:00",
  "LastUpdateDate": "2017-06-08T11:37:20.322-07:00",
  "LastUpdateLogin": "516E508C5BC4377FE0532DD6F00A0214",
  "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
  "links": [
    ...
  ]
}

「トップに戻る」