すべてのパフォーマンス・メジャーの取得
get
/fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentPerformanceMeasures
リクエスト
パス・パラメータ
- planComponentsUniqID(required): string
これは、プラン・コンポーネント・リソースのコンポジット・キー(PlanComponentIdおよびOrgId)を構成する属性のハッシュ・キーで、プラン・コンポーネントのインスタンスを一意に識別するために使用されます。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、プラン・コンポーネントの特定のインスタンスに移動するために、主キー値に対するフィルタを使用してプラン・コンポーネント・コレクション・リソースを問い合せる必要があります。
次に例を示します: planComponents?q=PlanComponentId=<value1>;OrgId=<value2>
問合せパラメータ
- 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 : 指定された主キーを持つリソースを検索します。
ファインダ変数:- PlanComponentPerformanceMeasureId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
- CalculationSequence; integer;計算エンジンでプラン・コンポーネント内のパフォーマンス・メジャーが考慮される順序。 これは、依存メジャーが他の基準メジャーの計算結果を参照する場合に設定されます。 依存メジャーは、基準メジャーよりも高い計算順序にする必要があります。
- CreatedBy; string; レコードを作成したユーザー。
- CreationDate; string; レコードが作成された日時。
- EarningBasis;文字列;達成計算と支給計算で同じクレジット・カテゴリが使用されるかどうか、およびインセンティブ算式で計算でメジャー達成が使用されるかどうかを指定します。 使用可能な値はY、Nです。 Yのままにして、プラン・コンポーネントのインセンティブ算式でパフォーマンス・メジャー達成を参照します。 トランザクションを個別に処理するパフォーマンス・メジャーが、イベントごとにインセンティブを計算するプラン・コンポーネントに関連付けられている場合、支給基準はYである必要があります。 許容可能な値のリストは、参照CN_YES_NOで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
- EndDate; string; パフォーマンス・メジャーに関連付けられたパフォーマンス・メジャーが非アクティブになる日付。 これは読取り専用フィールドです。 パフォーマンス・メジャーは、プラン・コンポーネントの日付を取得します。 書式はyyyy-mm-ddです。
- LastUpdateDate; string; レコードが最後に更新された日時。
- LastUpdateLogin; string; レコードを最後に更新したユーザーのセッション・ログイン。
- LastUpdatedBy; string; レコードを最後に更新したユーザー。
- PerformanceInterval; string; これはパフォーマンス測定の間隔値です。 累計が考慮される場合は、この間隔値に基づいて累計値がリセットされます。 間隔は、月、四半期、年などの時間の単位を表します。 デフォルト値は'-1000'です。
- PerformanceMeasureId; integer; パフォーマンス・メジャー・レコードの一意の識別子。
- PerformanceMeasureName; string;パフォーマンス・メジャーの名前。指定した結果または目標に対する進捗を測定するために使用されるインジケータです。
- PerformanceMeasureWeight; integer; パフォーマンス・メジャーがプラン・コンポーネントに与える影響の割合。
- PlanComponentId; integer; ビジネス・ユニット内のプラン・コンポーネント・レコードの一意の識別子。
- PlanComponentName; string; パフォーマンスに基づいて参加者の支給項目を定義するプラン・コンポーネントの名前。
- PlanComponentPerformanceMeasureId; integer; プラン・コンポーネントに関連付けられたパフォーマンス・メジャー・レコードの一意の識別子。
- ProcessTransactions; string; メジャー内のトランザクションの処理方法を示します。 指定可能な値には、達成計算のためのグループ・トランザクションのGROUP、達成計算のためのINDIVIDUAL、達成計算のための各トランザクションの個別評価のためのINDIVIDUALが含まれます。 許容可能な値のリストは、参照CN_PROCESS_TXNで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
- StartDate; string; パフォーマンス・メジャーに関連付けられたパフォーマンス・メジャーがアクティブになる日付。 これは読取り専用フィールドです。 パフォーマンス・メジャーは、プラン・コンポーネントの日付を取得します。 書式はyyyy-mm-ddです。
- UnitOfMeasure; string; パフォーマンス・メジャー・プロパティの出現数量を表すファクタとして使用される標準化された数量。 可能な値には、メジャー達成のAMOUNTは金額に基づき、メジャー達成のPERCENTはパーセントに基づき、メジャー達成のQUANTITYは数量に基づき、メジャー達成のSCOREはスコアに基づきます。 デフォルト値はAMOUNTです。 許容可能な値のリストは、参照CN_MEASURE_UOMで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
- ValidForCalculation; string; パフォーマンス・メジャーが計算の準備ができているかどうかを示します。 可能な値には、有効で計算の準備ができている場合はCOMPLETE、無効で計算の準備ができていない場合はINCOMPLETEが含まれます。 デフォルト値はINCOMPLETEです。 許容可能な値のリストは、参照CN_COMP_PLAN_STATUSで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : planComponents-planComponentPerformanceMeasures
タイプ:
ソースを表示
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"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : planComponents-planComponentPerformanceMeasures-item-response
タイプ:
ソースを表示
object
-
CalculationSequence: 整数(int32)
タイトル:
Calculation Sequence
デフォルト値:1
プラン・コンポーネント内のパフォーマンス・メジャーが計算エンジンで考慮される順序。 これは、依存メジャーが他の基準メジャーの計算結果を参照する場合に設定されます。 依存メジャーは、基準メジャーよりも高い計算順序にする必要があります。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
レコードを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
レコードが作成された日時。 -
EarningBasis: string
タイトル:
Earning Basis
最大長:1
デフォルト値:Y
達成計算と支給計算で同じクレジット・カテゴリを使用するかどうか、およびインセンティブ算式で計算にメジャー達成を使用するかどうかを指定します。 使用可能な値はY、Nです。 Yのままにして、プラン・コンポーネントのインセンティブ算式でパフォーマンス・メジャー達成を参照します。 トランザクションを個別に処理するパフォーマンス・メジャーが、イベントごとにインセンティブを計算するプラン・コンポーネントに関連付けられている場合、支給基準はYである必要があります。 許容可能な値のリストは、参照CN_YES_NOで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
EndDate: 文字列(日付)
タイトル:
End Date
読取り専用:true
パフォーマンス・メジャーに関連付けられたパフォーマンス・メジャーが非アクティブになる日付。 これは読取り専用フィールドです。 パフォーマンス・メジャーは、プラン・コンポーネントの日付を取得します。 書式はyyyy-mm-ddです。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
レコードが最後に更新された日時。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login
読取り専用:true
最大長:32
レコードを最後に更新したユーザーのセッション・ログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
PerformanceInterval: string
タイトル:
Performance Interval
読取り専用:true
デフォルト値:-1000
これはパフォーマンス測定の間隔値です。 累計が考慮される場合は、この間隔値に基づいて累計値がリセットされます。 間隔は、月、四半期、年などの時間の単位を表します。 デフォルト値は'-1000'です。 -
PerformanceMeasureId: integer (int64)
タイトル:
Performance Measure ID
パフォーマンス・メジャー・レコードの一意の識別子。 -
PerformanceMeasureName: string
タイトル:
Performance Measure Name
読取り専用:true
最大長:80
パフォーマンス・メジャーの名前。指定した結果または目標に対する進捗を測定するために使用されるインジケータです。 -
PerformanceMeasureWeight: integer (int64)
タイトル:
Weight
デフォルト値:100
パフォーマンス・メジャーがプラン・コンポーネントに与える影響の割合。 -
PlanComponentId: integer (int64)
タイトル:
Plan Component ID
ビジネス・ユニット内のプラン・コンポーネント・レコードの一意の識別子。 -
PlanComponentName: string
タイトル:
Plan Component Name
読取り専用:true
最大長:80
プラン・コンポーネントの名前。パフォーマンスに基づいて参加者の支給を定義します。 -
PlanComponentPerformanceMeasureId: integer (int64)
プラン・コンポーネントに関連付けられたパフォーマンス・メジャー・レコードの一意の識別子です。
-
ProcessTransactions: string
タイトル:
Process Transactions
読取り専用:true
最大長:30
メジャーでのトランザクションの処理方法を示します。 指定可能な値には、達成計算のためのグループ・トランザクションのGROUP、達成計算のためのINDIVIDUAL、達成計算のための各トランザクションの個別評価のためのINDIVIDUALが含まれます。 許容可能な値のリストは、参照CN_PROCESS_TXNで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
StartDate: 文字列(日付)
タイトル:
Start Date
読取り専用:true
パフォーマンス・メジャーに関連付けられたパフォーマンス・メジャーがアクティブになる日付。 これは読取り専用フィールドです。 パフォーマンス・メジャーは、プラン・コンポーネントの日付を取得します。 書式はyyyy-mm-ddです。 -
UnitOfMeasure: string
タイトル:
Unit of Measure
読取り専用:true
最大長:30
デフォルト値:AMOUNT
パフォーマンス・メジャー・プロパティの発生数量を表すファクタとして使用される標準化された数量。 可能な値には、メジャー達成のAMOUNTは金額に基づき、メジャー達成のPERCENTはパーセントに基づき、メジャー達成のQUANTITYは数量に基づき、メジャー達成のSCOREはスコアに基づきます。 デフォルト値はAMOUNTです。 許容可能な値のリストは、参照CN_MEASURE_UOMで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
ValidForCalculation: string
タイトル:
Valid for Calculation
読取り専用:true
最大長:30
デフォルト値:INCOMPLETE
パフォーマンス・メジャーの計算準備が完了しているかどうかを示します。 可能な値には、有効で計算の準備ができている場合はCOMPLETE、無効で計算の準備ができていない場合はINCOMPLETEが含まれます。 デフォルト値はINCOMPLETEです。 許容可能な値のリストは、参照CN_COMP_PLAN_STATUSで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。
例:
次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、すべてのパフォーマンス・メジャーを取得する方法を示しています。
cURLコマンド
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/planComponents/00020000000EACED00057708000110F07F4ABECA0000000EACED0005770800000000000000CC/child/planComponentPerformanceMeasures
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{ "items": [ { "PlanComponentPerformanceMeasureId": 300100090511057, "CalculationSequence": 1, "PerformanceMeasureWeight": 90, "PerformanceMeasureId": 300100090511017, "PerformanceMeasureName": "Sales Attainment 2016", "StartDate": "2016-01-01", "EndDate": "2016-12-31", "EarningBasis": "Y", "PlanComponentName": "Sales Plan Bonus", "UnitOfMeasure": "AMOUNT", "ValidForCalculation": "COMPLETE", "ProcessTransactions": "INDIVIDUAL", "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "CreationDate": "2017-06-08T23:07:22-07:00", "LastUpdateDate": "2017-06-08T23:22:52.055-07:00", "LastUpdateLogin": "517961123F1147A9E0532DD6F00A9182", "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "PerformanceInterval": "-1000", "PlanComponentId": 300100090511050, "links": [ ... ], } , ..] }