すべての目標の取得
get
/fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureGoals
リクエスト
パス・パラメータ
- 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 - finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。
フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
使用可能なファインダ名および対応するファインダ変数を次に示します:- PrimaryKey : 指定された主キーを持つリソースを検索します。
ファインダ変数:- GoalId; integer;目標レコードの一意の識別子。
- PrimaryKey : 指定された主キーを持つリソースを検索します。
- limit: integer
このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
- links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- offset: integer
リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
- onlyData: boolean
リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
- orderBy: string
このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
- q: string
この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY
フォーマット : ?q=expression1;expression2
次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- AlternateGoalTarget1; number;メジャーの代替ターゲット番号。たとえば、ストレッチ目標。
- AlternateGoalTarget2; number;メジャーの代替ターゲット番号。たとえば、ストレッチ目標。
- AlternateGoalTarget3; number;メジャーの代替ターゲット番号。たとえば、ストレッチ目標。
- AlternateGoalTarget4; number;メジャーの代替ターゲット番号。たとえば、ストレッチ目標。
- AlternateGoalTarget5; number;メジャーの代替ターゲット番号。たとえば、ストレッチ目標。
- CreatedBy; string; レコードを作成したユーザー。
- CreationDate; string; レコードが作成された日時。
- GoalId; integer;目標レコードの一意の識別子。
- GoalInterval; string;目標情報を指定する期間。 この間隔は、対応するパフォーマンス(メジャー)間隔と同じです。 この値を取得するには、リソースを記述し、リストされているファインダを使用してすべての可能な値を取得します。
- GoalTarget; number;年の各メジャーの参加者に割り当てられる予定達成レベルであり、異なる間隔に分割できます。
- IntervalDistribution; string; 間隔全体に配分される目標番号の表示値。
- LastUpdateDate; string; レコードが最後に更新された日時。
- LastUpdateLogin; string; レコードを最後に更新したユーザーのセッション・ログイン。
- LastUpdatedBy; string; レコードを最後に更新したユーザー。
- UnitOfMeasure; string; 目標プロパティの出現数量を表すファクタとして使用される標準化された数量。 取り得る値は、収益ベースの目標のAMOUNTと数量ベースの目標のQUANTITYです。 デフォルト値はAMOUNTです。 許容可能な値のリストは、参照CN_GOAL_UOMで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
- totalResults: boolean
"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
- 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
タイプ:
ソースを表示
object
-
count(required): integer
現在の範囲で返されたリソース・インスタンスの数。
-
hasMore(required): boolean
サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。 値がtrueの場合、サーバーから取得するリソースがさらにあります。 デフォルト値はfalseです。
-
items: array Items
タイトル:
Items
コレクション内のアイテム。 -
limit(required): integer
サーバーで使用される実際のページング・サイズ。
-
links(required): array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
offset(required): integer
現在のページで使用されるオフセット値。
-
totalResults: integer
"?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : 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で定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
ネストされたスキーマ : 間隔目標
タイプ:
array
タイトル:
Interval Goals
間隔目標リソースは、各間隔でターゲットまたは目標値を表示および更新するために使用します。 間隔をまたいで目標のすべての詳細を表示するためにも使用できます。 これは、デフォルト値の0でパフォーマンス・メジャーを作成するときに作成されます。
ソースを表示
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object
-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
ネストされたスキーマ : 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でパフォーマンス・メジャーを作成するときに作成されます。 これは、必要に応じて後で更新する必要があります。
ネストされたスキーマ : 期間目標
タイプ:
array
タイトル:
Period Goals
期間目標リソースは、各期間のターゲットまたは目標値を表示および更新するために使用します。 また、複数の期間にわたる目標のすべての詳細を表示するために使用することもできます。 これは、デフォルト値の0でパフォーマンス・メジャーを作成するときに作成されます。 これは、必要に応じて後で更新する必要があります。
ソースを表示
ネストされたスキーマ : 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
メジャーの期間ターゲット率。
例:
次の例は、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
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{ "items": [ { "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": [ ... ] } ,... ] }