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

目標の取得

get

/fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureGoals/{GoalId}

リクエスト

パス・パラメータ

GoalId(required): integer(int64)

目標レコードの一意の識別子。
PerformanceMeasureId(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のデフォルト・バージョンを選択します。

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

タイプ: object

ソースを表示

AlternateGoalTarget1: number

タイトル: Alternate Target 1

読取り専用: true

ストレッチ目標など、メジャーの代替ターゲット番号。
AlternateGoalTarget2: number

タイトル: Alternate Target 2

読取り専用: true

ストレッチ目標など、メジャーの代替ターゲット番号。
AlternateGoalTarget3: number

タイトル: Alternate Target 3

読取り専用: true

ストレッチ目標など、メジャーの代替ターゲット番号。
AlternateGoalTarget4: number

タイトル: Alternate Target 4

読取り専用: true

ストレッチ目標など、メジャーの代替ターゲット番号。
AlternateGoalTarget5: number

タイトル: Alternate Target 5

読取り専用: true

ストレッチ目標など、メジャーの代替ターゲット番号。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 255

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

タイトル: Creation Date

読取り専用: true

レコードが作成された日時。
DistributeEvenlyFlag: boolean

ターゲット金額がインターバル・ターゲットおよび期間ターゲットに均等かどうかを示します。可能な値はTRUEおよびFALSEです。
GoalDistributionType: string

タイトル: Distribute By

目標ターゲットまたは代替目標ターゲットは、金額またはパーセントで配分されます。現在は金額別配分のみが許可されていますが、間隔および期間ごとに目標を数値で配分するためのAMOUNTと、間隔および期間ごとに年間数のパーセントとして目標を配分するためのPERCENTの2つの可能な値があります。許容可能な値のリストは、参照CN_GOAL_DISTRIBUTEで定義されます。設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
GoalId: integer (int64)

目標レコードの一意の識別子。
GoalInterval: string

タイトル: Goal Interval

読取り専用: true

目標情報を指定する期間。この間隔は、対応するパフォーマンス(メジャー)間隔と同じです。この値を取得するには、リソースを記述し、リストされているファインダを使用してすべての可能な値を取得します。
GoalTarget: number

タイトル: Target

その年の各メジャーの参加者に割り当てられる予定達成レベルであり、異なる間隔に分割できます。
IntervalDistribution: string

読取り専用: true

間隔全体に配分された目標番号の表示値。
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

リソース・インスタンスに関連付けられたリンク関係。
PerformanceMeasureGoalDeleteFlag: boolean

読取り専用: true

デフォルト値: false

目標を削除できるかどうかを示します。
performanceMeasureIntervalGoals: array Interval Goals

タイトル: Interval Goals

間隔目標リソースは、各間隔でターゲットまたは目標値を表示および更新するために使用します。間隔をまたいで目標のすべての詳細を表示するためにも使用できます。これは、デフォルト値の0でパフォーマンス・メジャーを作成するときに作成されます。
RecalculateFlag: boolean

それぞれの間隔および間隔累計(ITD)に対するすべての期間値が合計され、それぞれの合計ターゲット目標値に対するすべての間隔値が合計されるかどうかを示します。これにより、間隔、ITDおよび合計ターゲット目標値が置換されます。また、目標配分タイプの値がパーセントの場合は、TRUEにできません。これは、すべての代替目標にも適用されます。
UnitOfMeasure: string

タイトル: Unit of Measure

最大長: 30

デフォルト値: AMOUNT

目標プロパティの発生数量を表すファクタとして使用される標準化された数量。取り得る値は、収益ベースの目標のAMOUNTと数量ベースの目標のQUANTITYです。デフォルト値はAMOUNTです。許容可能な値のリストは、参照CN_GOAL_UOMで定義されます。設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。

{
    "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
        },
        "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
        },
        "GoalInterval":{
            "title":"Goal Interval",
            "type":"string",
            "description":"The span of time to specify the goal information. This interval is same as the corresponding performance (measure) interval. To get this value, describe the resource and use the finder listed to get all possible values.",
            "nullable":true,
            "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
        },
        "UnitOfMeasure":{
            "title":"Unit of Measure",
            "maxLength":30,
            "type":"string",
            "description":"The standardized quantity used as a factor to express occurring quantities of the goal property. Possible values include AMOUNT for Revenue-based goal and QUANTITY for Quantity-based goal. The default value is AMOUNT. A list of acceptable values is defined in the lookup CN_GOAL_UOM. 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
        },
        "GoalTarget":{
            "title":"Target",
            "type":"number",
            "description":"The expected level of attainment assigned to a participant for each measure for the year, which may be divided into different intervals.",
            "nullable":true,
            "x-queryable":true
        },
        "GoalDistributionType":{
            "title":"Distribute By",
            "type":"string",
            "description":"The goal target or alternate goal targets are distributed by amount or percent. Although only distribute by Amount is allowed for now, it has two possible values which are AMOUNT to distribute the goal in numbers for each interval and period, and PERCENT to distribute the goal as a percentage of the annual number for each interval and period. A list of acceptable values is defined in the lookup CN_GOAL_DISTRIBUTE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DistributeEvenlyFlag":{
            "type":"boolean",
            "description":"Indicates if the target amount evenly to the interval targets and period targets, the possible values are TRUE and FALSE.",
            "nullable":true,
            "x-queryable":false
        },
        "performanceMeasureIntervalGoals":{
            "title":"Interval Goals",
            "type":"array",
            "description":"The Interval Goals resource is used to view and update the target or the goal values at each interval. It can also be used to display all details of the goals across intervals. \nThis is created when creating a Performance Measure with a default value of 0.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationPerformanceMeasures-performanceMeasureGoals-performanceMeasureIntervalGoals-item-response"
            }
        },
        "RecalculateFlag":{
            "type":"boolean",
            "description":"Indicates if all period values to the respective interval and interval to date (ITD) are summed up and if all interval values to the respective total target goal values are summed up. This replaces any interval, ITD and total target goal values. Also this cannot be TRUE if the goal distribution type value is Percentage. This also applies to all alternate goals.",
            "nullable":true,
            "x-queryable":false
        },
        "AlternateGoalTarget3":{
            "title":"Alternate Target 3",
            "type":"number",
            "description":"The alternate target number for a measure, for example, stretch goal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternateGoalTarget2":{
            "title":"Alternate Target 2",
            "type":"number",
            "description":"The alternate target number for a measure, for example, stretch goal.",
            "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"
            }
        },
        "AlternateGoalTarget5":{
            "title":"Alternate Target 5",
            "type":"number",
            "description":"The alternate target number for a measure, for example, stretch goal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternateGoalTarget4":{
            "title":"Alternate Target 4",
            "type":"number",
            "description":"The alternate target number for a measure, for example, stretch goal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PerformanceMeasureGoalDeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether a goal can be deleted.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "AlternateGoalTarget1":{
            "title":"Alternate Target 1",
            "type":"number",
            "description":"The alternate target number for a measure, for example, stretch goal.",
            "nullable":true,
            "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 of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IntervalDistribution":{
            "type":"string",
            "description":"The display value for the goal number distributed across the intervals.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalId":{
            "type":"integer",
            "description":"The unique identifier for a goal record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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

タイトル: Interval Goals

間隔目標リソースは、各間隔でターゲットまたは目標値を表示および更新するために使用します。間隔をまたいで目標のすべての詳細を表示するためにも使用できます。これは、デフォルト値の0でパフォーマンス・メジャーを作成するときに作成されます。

ソースを表示

Array of: object incentiveCompensationPerformanceMeasures-performanceMeasureGoals-performanceMeasureIntervalGoals-item-response

{
    "title":"Interval Goals",
    "type":"array",
    "description":"The Interval Goals resource is used to view and update the target or the goal values at each interval. It can also be used to display all details of the goals across intervals. \nThis is created when creating a Performance Measure with a default value of 0.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationPerformanceMeasures-performanceMeasureGoals-performanceMeasureIntervalGoals-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."
        }
    }
}

ネストされたスキーマ : incentiveCompensationPerformanceMeasures-performanceMeasureGoals-performanceMeasureIntervalGoals-item-response

タイプ: object

ソースを表示

AlternateIntervalTarget1: number

タイトル: Alternate Interval Target 1

デフォルト値: 0

間隔のストレッチ目標など、メジャーの代替間隔ターゲット番号。デフォルト値は、0です。
AlternateIntervalTarget1Percent: number

タイトル: Alternate Interval Target 1

間隔のストレッチ目標など、メジャーの代替間隔ターゲット率。これは、それぞれの代替ターゲットで計算されます。
AlternateIntervalTarget2: number

タイトル: Alternate Interval Target 2

デフォルト値: 0

間隔のストレッチ目標など、メジャーの代替間隔ターゲット番号。デフォルト値は、0です。
AlternateIntervalTarget2Percent: number

タイトル: Alternate Interval Target 2

間隔のストレッチ目標など、メジャーの代替間隔ターゲット率。これは、それぞれの代替ターゲットで計算されます。
AlternateIntervalTarget3: number

タイトル: Alternate Interval Target 3

デフォルト値: 0

間隔のストレッチ目標など、メジャーの代替間隔ターゲット番号。デフォルト値は、0です。
AlternateIntervalTarget3Percent: number

タイトル: Alternate Interval Target 3

間隔のストレッチ目標など、メジャーの代替間隔ターゲット率。これは、それぞれの代替ターゲットで計算されます。
AlternateIntervalTarget4: number

タイトル: Alternate Interval Target 4

デフォルト値: 0

間隔のストレッチ目標など、メジャーの代替間隔ターゲット番号。デフォルト値は、0です。
AlternateIntervalTarget4Percent: number

タイトル: Alternate Interval Target 4

間隔のストレッチ目標など、メジャーの代替間隔ターゲット率。これは、それぞれの代替ターゲットで計算されます。
AlternateIntervalTarget5: number

タイトル: Alternate Interval Target 5

デフォルト値: 0

間隔のストレッチ目標など、メジャーの代替間隔ターゲット番号。デフォルト値は、0です。
AlternateIntervalTarget5Percent: number

タイトル: Alternate Interval Target 5

間隔のストレッチ目標など、メジャーの代替間隔ターゲット率。これは、それぞれの代替ターゲットで計算されます。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 255

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

タイトル: Creation Date

読取り専用: true

レコードが作成された日時。
GoalId: integer (int64)

目標レコードの一意の識別子。
IntervalGoalId: integer (int64)

間隔目標詳細の一意の識別子。
IntervalNumber: string

タイトル: Period

最大長: 80

間隔の表示値。
IntervalTarget: number

タイトル: Interval Target

読取り専用: true

デフォルト値: 0

目標間隔に指定されたターゲット番号。デフォルト値は、0です。
IntervalTargetPercent: number

タイトル: Interval Target

読取り専用: true

目標間隔に指定されたターゲット率。
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

リソース・インスタンスに関連付けられたリンク関係。
PerformanceMeasureIntervalGoalDeleteFlag: boolean

読取り専用: true

デフォルト値: false

パフォーマンス・メジャー間隔目標を削除できるかどうかを示します。
performanceMeasurePeriodGoals: array Period Goals

タイトル: Period Goals

期間目標リソースは、各期間のターゲットまたは目標値を表示および更新するために使用します。また、複数の期間にわたる目標のすべての詳細を表示するために使用することもできます。これは、デフォルト値の0でパフォーマンス・メジャーを作成するときに作成されます。これは、必要に応じて後で更新する必要があります。

{
    "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
        },
        "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
        },
        "PerformanceMeasureIntervalGoalDeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether a performance measure interval goal can be deleted.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "performanceMeasurePeriodGoals":{
            "title":"Period Goals",
            "type":"array",
            "description":"The Period Goals resource is used to view and update the target or the goal values at each period. It can also be used to display all details of the goals across periods. \nThis is created when creating a Performance Measure with a default value of 0. This needs to be updated later if needed.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationPerformanceMeasures-performanceMeasureGoals-performanceMeasureIntervalGoals-performanceMeasurePeriodGoals-item-response"
            }
        },
        "IntervalTarget":{
            "title":"Interval Target",
            "type":"number",
            "description":"The target number specified for the goal interval. The default value is 0.",
            "nullable":true,
            "readOnly":true,
            "default":0,
            "x-queryable":true
        },
        "AlternateIntervalTarget1":{
            "title":"Alternate Interval Target 1",
            "type":"number",
            "description":"The alternate interval target number for a measure, for example, stretch goal for an interval. The default value is 0.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "AlternateIntervalTarget2Percent":{
            "title":"Alternate Interval Target 2",
            "type":"number",
            "description":"The alternate interval target percentage for a measure, for example, stretch goal for an interval. This is calculated on the respective alternate target.",
            "nullable":true,
            "x-queryable":false
        },
        "AlternateIntervalTarget3Percent":{
            "title":"Alternate Interval Target 3",
            "type":"number",
            "description":"The alternate interval target percentage for a measure, for example, stretch goal for an interval. This is calculated on the respective alternate target.",
            "nullable":true,
            "x-queryable":false
        },
        "AlternateIntervalTarget2":{
            "title":"Alternate Interval Target 2",
            "type":"number",
            "description":"The alternate interval target number for a measure, for example, stretch goal for an interval. The default value is 0.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "AlternateIntervalTarget3":{
            "title":"Alternate Interval Target 3",
            "type":"number",
            "description":"The alternate interval target number for a measure, for example, stretch goal for an interval. The default value is 0.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "IntervalTargetPercent":{
            "title":"Interval Target",
            "type":"number",
            "description":"The target percentage specified for the goal interval.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AlternateIntervalTarget4":{
            "title":"Alternate Interval Target 4",
            "type":"number",
            "description":"The alternate interval target number for a measure, for example, stretch goal for an interval. The default value is 0.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "AlternateIntervalTarget5":{
            "title":"Alternate Interval Target 5",
            "type":"number",
            "description":"The alternate interval target number for a measure, for example, stretch goal for an interval. The default value is 0.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "AlternateIntervalTarget1Percent":{
            "title":"Alternate Interval Target 1",
            "type":"number",
            "description":"The alternate interval target percentage for a measure, for example, stretch goal for an interval. This is calculated on the respective alternate target.",
            "nullable":true,
            "x-queryable":false
        },
        "AlternateIntervalTarget4Percent":{
            "title":"Alternate Interval Target 4",
            "type":"number",
            "description":"The alternate interval target percentage for a measure, for example, stretch goal for an interval. This is calculated on the respective alternate target.",
            "nullable":true,
            "x-queryable":false
        },
        "AlternateIntervalTarget5Percent":{
            "title":"Alternate Interval Target 5",
            "type":"number",
            "description":"The alternate interval target percentage for a measure, for example, stretch goal for an interval. This is calculated on the respective alternate target.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "IntervalGoalId":{
            "type":"integer",
            "description":"The unique identifier for the interval goal details.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IntervalNumber":{
            "title":"Period",
            "maxLength":80,
            "type":"string",
            "description":"The display value of the interval.",
            "nullable":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 of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalId":{
            "type":"integer",
            "description":"The unique identifier for a goal record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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

タイトル: Period Goals

期間目標リソースは、各期間のターゲットまたは目標値を表示および更新するために使用します。また、複数の期間にわたる目標のすべての詳細を表示するために使用することもできます。これは、デフォルト値の0でパフォーマンス・メジャーを作成するときに作成されます。これは、必要に応じて後で更新する必要があります。

ソースを表示

Array of: object incentiveCompensationPerformanceMeasures-performanceMeasureGoals-performanceMeasureIntervalGoals-performanceMeasurePeriodGoals-item-response

{
    "title":"Period Goals",
    "type":"array",
    "description":"The Period Goals resource is used to view and update the target or the goal values at each period. It can also be used to display all details of the goals across periods. \nThis is created when creating a Performance Measure with a default value of 0. This needs to be updated later if needed.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationPerformanceMeasures-performanceMeasureGoals-performanceMeasureIntervalGoals-performanceMeasurePeriodGoals-item-response"
    }
}

ネストされたスキーマ : incentiveCompensationPerformanceMeasures-performanceMeasureGoals-performanceMeasureIntervalGoals-performanceMeasurePeriodGoals-item-response

タイプ: object

ソースを表示

AlternateITDTarget1: number

タイトル: Alternate ITD Target 1

読取り専用: true

メジャーの代替間隔累計ターゲット番号。
AlternateITDTarget2: number

タイトル: Alternate ITD Target 2

読取り専用: true

メジャーの代替間隔累計ターゲット番号。
AlternateITDTarget3: number

タイトル: Alternate ITD Target 3

読取り専用: true

メジャーの代替間隔累計ターゲット番号。
AlternateITDTarget4: number

タイトル: Alternate ITD Target 4

読取り専用: true

メジャーの代替間隔累計ターゲット番号。
AlternateITDTarget5: number

タイトル: Alternate ITD Target 5

読取り専用: true

メジャーの代替間隔累計ターゲット番号。
AlternatePeriodTarget1: number

タイトル: Alternate Period Target 1

デフォルト値: 0

期間のストレッチ目標など、メジャーの代替期間ターゲット番号。デフォルト値は、0です。
AlternatePeriodTarget1Percent: number

タイトル: Alternate Period Target 1

期間の目標のストレッチなど、メジャーの代替期間ターゲット・パーセント。
AlternatePeriodTarget2: number

タイトル: Alternate Period Target 2

デフォルト値: 0

期間のストレッチ目標など、メジャーの代替期間ターゲット番号。デフォルト値は、0です。
AlternatePeriodTarget2Percent: number

タイトル: Alternate Period Target 2

期間の目標のストレッチなど、メジャーの代替期間ターゲット・パーセント。
AlternatePeriodTarget3: number

タイトル: Alternate Period Target 3

デフォルト値: 0

期間のストレッチ目標など、メジャーの代替期間ターゲット番号。デフォルト値は、0です。
AlternatePeriodTarget3Percent: number

タイトル: Alternate Period Target 3

期間の目標のストレッチなど、メジャーの代替期間ターゲット・パーセント。
AlternatePeriodTarget4: number

タイトル: Alternate Period Target 4

デフォルト値: 0

期間のストレッチ目標など、メジャーの代替期間ターゲット番号。デフォルト値は、0です。
AlternatePeriodTarget4Percent: number

タイトル: Alternate Period Target 4

期間の目標のストレッチなど、メジャーの代替期間ターゲット・パーセント。
AlternatePeriodTarget5: number

タイトル: Alternate Period Target 5

デフォルト値: 0

期間のストレッチ目標など、メジャーの代替期間ターゲット番号。デフォルト値は、0です。
AlternatePeriodTarget5Percent: number

タイトル: Alternate Period Target 5

期間の目標のストレッチなど、メジャーの代替期間ターゲット・パーセント。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 255

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

タイトル: Creation Date

読取り専用: true

レコードが作成された日時。
GoalId: integer (int64)

目標の一意の識別子。
IntervalGoalId: integer (int64)

間隔目標詳細の一意の識別子。
ITDTarget: number

タイトル: ITD Target

読取り専用: true

メジャーの間隔累計ターゲット番号。
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

リソース・インスタンスに関連付けられたリンク関係。
PerformanceMeasurePeriodGoalDeleteFlag: boolean

読取り専用: true

デフォルト値: false

パフォーマンス・メジャー期間目標を削除できるかどうかを示します。
PeriodGoalId: integer (int64)

期間目標詳細の一意の識別子。
PeriodName: string

タイトル: Period

読取り専用: true

最大長: 30

カレンダで定義された時間間隔の名前。
PeriodTarget: number

タイトル: Period Target

デフォルト値: 0

メジャーの期間ターゲット番号。
PeriodTargetPercent: number

タイトル: Period Target

メジャーの期間ターゲット率。

{
    "type":"object",
    "properties":{
        "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
        },
        "PerformanceMeasurePeriodGoalDeleteFlag":{
            "type":"boolean",
            "description":"Inidcates whether a performance measure period goal can be deleted.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "PeriodGoalId":{
            "type":"integer",
            "description":"The unique identifier for the period goal details.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AlternateITDTarget2":{
            "title":"Alternate ITD Target 2",
            "type":"number",
            "description":"The alternate interval-to-date target number for a measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternatePeriodTarget4":{
            "title":"Alternate Period Target 4",
            "type":"number",
            "description":"The alternate period target number for a measure, for example, stretch goal for a period. The default value is 0.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "AlternateITDTarget3":{
            "title":"Alternate ITD Target 3",
            "type":"number",
            "description":"The alternate interval-to-date target number for a measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternatePeriodTarget5":{
            "title":"Alternate Period Target 5",
            "type":"number",
            "description":"The alternate period target number for a measure, for example, stretch goal for a period. The default value is 0.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "AlternateITDTarget1":{
            "title":"Alternate ITD Target 1",
            "type":"number",
            "description":"The alternate interval-to-date target number for a measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodTargetPercent":{
            "title":"Period Target",
            "type":"number",
            "description":"The period target percentage for a measure.",
            "nullable":true,
            "x-queryable":false
        },
        "AlternateITDTarget4":{
            "title":"Alternate ITD Target 4",
            "type":"number",
            "description":"The alternate interval-to-date target number for a measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternateITDTarget5":{
            "title":"Alternate ITD Target 5",
            "type":"number",
            "description":"The alternate interval-to-date target number for a measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternatePeriodTarget5Percent":{
            "title":"Alternate Period Target 5",
            "type":"number",
            "description":"The alternate period target percentage for a measure, for example, stretch goal for a period.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ITDTarget":{
            "title":"ITD Target",
            "type":"number",
            "description":"The Interval-to-date target number for a measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternatePeriodTarget3Percent":{
            "title":"Alternate Period Target 3",
            "type":"number",
            "description":"The alternate period target percentage for a measure, for example, stretch goal for a period.",
            "nullable":true,
            "x-queryable":false
        },
        "AlternatePeriodTarget1":{
            "title":"Alternate Period Target 1",
            "type":"number",
            "description":"The alternate period target number for a measure, for example, stretch goal for a period. The default value is 0.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "AlternatePeriodTarget2":{
            "title":"Alternate Period Target 2",
            "type":"number",
            "description":"The alternate period target number for a measure, for example, stretch goal for a period. The default value is 0.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "AlternatePeriodTarget2Percent":{
            "title":"Alternate Period Target 2",
            "type":"number",
            "description":"The alternate period target percentage for a measure, for example, stretch goal for a period.",
            "nullable":true,
            "x-queryable":false
        },
        "AlternatePeriodTarget4Percent":{
            "title":"Alternate Period Target 4",
            "type":"number",
            "description":"The alternate period target percentage for a measure, for example, stretch goal for a period.",
            "nullable":true,
            "x-queryable":false
        },
        "GoalId":{
            "type":"integer",
            "description":"The unique identifier for a goal.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AlternatePeriodTarget3":{
            "title":"Alternate Period Target 3",
            "type":"number",
            "description":"The alternate period target number for a measure, for example, stretch goal for a period. The default value is 0.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternatePeriodTarget1Percent":{
            "title":"Alternate Period Target 1",
            "type":"number",
            "description":"The alternate period target percentage for a measure, for example, stretch goal for a period.",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodTarget":{
            "title":"Period Target",
            "type":"number",
            "description":"The period target number for a measure.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "IntervalGoalId":{
            "type":"integer",
            "description":"The unique identifier for the interval goal details.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PeriodName":{
            "title":"Period",
            "maxLength":30,
            "type":"string",
            "description":"The name for an interval of time defined in the calendar.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date 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"
    }
}

リンク

CnLookupGoalDistributeVO

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

目標ターゲットまたは代替目標ターゲットの金額またはパーセント別の分布を示す値リスト。可能な値には、各間隔および期間の数で目標を分配するためのAMOUNTと、間隔および期間ごとに年間数のパーセンテージとして目標を分配するためのPERCENTがあります。

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

ソース属性: GoalDistributionType;ターゲット属性: LookupCode
表示属性: 意味

CnLookupUnitOfMeasure

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

目標プロパティの発生数量を表すファクタとして使用される標準化された数量を含む値リスト。取り得る値は、収益ベースの目標の場合はAMOUNT、数量ベースの目標の場合はQUANTITYです。デフォルト値はAMOUNTです。

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

ソース属性: UnitOfMeasure;ターゲット属性: LookupCode
表示属性: 意味

performanceMeasureIntervalGoals

操作: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureGoals/{GoalId}/child/performanceMeasureIntervalGoals

パラメータ:

GoalId: $request.path.GoalId
PerformanceMeasureId: $request.path.PerformanceMeasureId

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行して目標を取得する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/300100090511017/child/performanceMeasureGoals/300100090511019

レスポンス本文の例

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

{
  "GoalId": 300100090511019,
  "UnitOfMeasure": "AMOUNT",
  "GoalDistributionType": null,
  "AlternateGoalTarget1": null,
  "AlternateGoalTarget2": null,
  "AlternateGoalTarget3": null,
  "AlternateGoalTarget4": null,
  "AlternateGoalTarget5": null,
  "DistributeEvenlyFlag": null,
  "GoalTarget": 200000,
  "GoalInterval": "Period",
  "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
  "CreationDate": "2017-06-08T11:28:10.377-07:00",
  "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
  "LastUpdateDate": "2017-06-15T02:41:38-07:00",
  "LastUpdateLogin": "51D1768B21CC7C69E0532DD6F00A1A9F",
  "RecalculateFlag": null,
  "PerformanceMeasureGoalDeleteFlag": false,
  "IntervalDistribution": "Period",
  "links": [
   ...
  ]
}

「トップに戻る」