機械翻訳について

すべてのパフォーマンス・メジャー・スコア・カードの取得

get

/fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}/child/ParticipantPerformanceMeasureScorecards

リクエスト

パス・パラメータ
  • 参加者プラン・コンポーネントに関連付けられたパフォーマンス・メジャーの一意の識別子。
  • 参加者報酬プランに関連付けられたプラン・コンポーネントの一意の識別子です。
  • これは、関係者報酬プラン・リソースの複合キーを構成し、関係者報酬プランのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、参加者報酬プラン・コレクション・リソースを問い合せて、ハッシュ・キーを取得するために参加者報酬プランの特定のインスタンスに移動する必要があります。
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2

    フォーマット: <attr1>=<val1>,<attr2>=<value2>
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

    フォーマット : ?fields=Attribute1,Attribute2

    子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    使用可能なファインダ名および対応するファインダ変数を次に示します:

    • PrimaryKey : 指定した主キーを持つ参加者パフォーマンス・メジャー・スコア・カードを検索します。
      ファインダ変数:
      • ParticipantPerformanceMeasureScorecardId; integer;参加者パフォーマンス・メジャー・スコア・カードの一意の識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
  • このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
  • この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY

    フォーマット : ?q=expression1;expression2

    次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • CreatedBy; string;参加者スコア・カード・レート表を作成したユーザー。
    • CreationDate; string;参加者スコア・カードのレート表が作成される日時。
    • EndDate; string; パフォーマンス・メジャーに関連付けられたスコア・カード・レート表が非アクティブになる日付。
    • LastUpdateDate; string;参加者スコア・カードのレート表が最後に更新された日時。
    • LastUpdatedBy; string; 参加者スコア・カードのレート表を最後に更新したユーザー。
    • ParticipantPerformanceMeasureId; integer; 参加者プラン・コンポーネントに関連付けられたパフォーマンス・メジャーの一意の識別子。
    • ParticipantPerformanceMeasureScorecardId; integer; 参加者パフォーマンス・メジャーに関連付けられたスコア・カード・レート表の一意の識別子。
    • PerformanceMeasureId; integer; 基本報酬プランに関連付けられたパフォーマンス・メジャーの一意の識別子。 ベース・プランはプラン管理者によってモデル化され、参加者プランのソースです。
    • ScorecardDescription; string;スコア・カードの作成時にユーザーが入力したスコア・カードのレート表の説明。
    • ScorecardId; integer; 基本報酬プランに関連付けられたスコア・カード・レート表の一意の識別子。 ベース・プランはプラン管理者によってモデル化され、参加者プランのソースです。
    • ScorecardName; string;スコア・カード・レート表の名前。
    • StartDate; string; パフォーマンス・メジャーに関連付けられたスコア・カード・レート表がアクティブになる日付。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureScorecards
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureScorecards-item-response
タイプ: object
ソースを表示
  • 読取り専用: true
    最大長: 64
    参加者スコア・カード・レート表を作成したユーザー。
  • 読取り専用: true
    参加者スコア・カード・レート表が作成された日時。
  • 読取り専用: true
    パフォーマンス・メジャーに関連付けられたスコア・カード・レート表が非アクティブになる日付。
  • 読取り専用: true
    参加者スコア・カード・レート表が最後に更新された日時。
  • 読取り専用: true
    最大長: 64
    関係者スコア・カード・レート表を最後に更新したユーザー。
  • Links
  • 読取り専用: true
    参加者プラン・コンポーネントに関連付けられたパフォーマンス・メジャーの一意の識別子。
  • 読取り専用: true
    関係者パフォーマンス・メジャーに関連付けられたスコア・カード・レート表の一意の識別子です。
  • Scorecard Rates
    タイトル: Scorecard Rates
    スコア・カード・レート・リソースは、個別設定できる参加者スコア・カードのレートを作成、表示および更新するために使用されます。 関連する参加者プラン・コンポーネントの個別設定オプションをはいに設定して、スコア・カードの個別設定を有効にします。
  • 読取り専用: true
    基本報酬プランに関連付けられたパフォーマンス・メジャーの一意の識別子。 ベース・プランはプラン管理者によってモデル化され、参加者プランのソースです。
  • タイトル: Description
    読取り専用: true
    最大長: 1000
    スコア・カードの作成時にユーザーが入力したスコア・カード・レート表の摘要。
  • 基本報酬プランに関連付けられたスコア・カード・レート表の一意の識別子です。 ベース・プランはプラン管理者によってモデル化され、参加者プランのソースです。
  • タイトル: Name
    読取り専用: true
    最大長: 80
    スコア・カード・レート表の名前。
  • 読取り専用: true
    パフォーマンス・メジャーに関連付けられたスコア・カード・レート表がアクティブになる日付。
ネストされたスキーマ : スコア・カード・レート
タイプ: array
タイトル: Scorecard Rates
スコア・カード・レート・リソースは、個別設定できる参加者スコア・カードのレートを作成、表示および更新するために使用されます。 関連する参加者プラン・コンポーネントの個別設定オプションをはいに設定して、スコア・カードの個別設定を有効にします。
ソースを表示
ネストされたスキーマ : participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureScorecards-ParticipantScorecardRates-item-response
タイプ: object
ソースを表示
  • 読取り専用: true
    最大長: 64
    参加者レートを作成したユーザー。
  • 読取り専用: true
    参加者レートが作成された日時。
  • 読取り専用: true
    参加者レートが最後に更新された日時。
  • 読取り専用: true
    最大長: 64
    関係者レートを最後に更新したユーザー。
  • Links
  • 読取り専用: true
    関係者パフォーマンス・メジャーに関連付けられたスコア・カード・レート表の一意の識別子です。
  • 読取り専用: true
    参加者スコア・カードに関連付けられたレートの一意の識別子。
  • タイトル: Rate
    スコア・カード・レート表の出力値は、様々なパフォーマンス・レベルに対して達成レートまたは固定金額を設定するために使用されます。 レート表に設定されたレート表タイプに応じて、この値はパーセントまたは金額になります。 レート表タイプがパーセントの場合、実際の値を取得するには、ここに保存されている値を100で割る必要があります。 たとえば、レート表タイプがパーセントで、レート値が10%の場合、出力値は10です。
  • レートに関連付けられた10番目のディメンションの一意の識別子。 スコア・カード・レート表に10個のディメンションがある場合にのみ使用されます。
  • タイトル: Name
    読取り専用: true
    10番目のディメンションの名前。
  • レートに関連付けられた10番目のディメンションの階層の一意の識別子。
  • タイトル: Sequence
    読取り専用: true
    ディメンション内の階層連番。
  • レートに関連付けられた最初のディメンションの一意の識別子。
  • タイトル: Name
    読取り専用: true
    最初のディメンションの名前。
  • レートに関連付けられた最初のディメンションの階層の一意の識別子。
  • タイトル: Sequence
    読取り専用: true
    ディメンション内の階層連番。
  • レートに関連付けられた2番目のディメンションの一意の識別子。 スコア・カード・レート表に2つ以上のディメンションがある場合にのみ使用されます。
  • タイトル: Name
    読取り専用: true
    2番目のディメンションの名前。
  • レートに関連付けられた2番目のディメンションの階層の一意の識別子。
  • タイトル: Sequence
    読取り専用: true
    ディメンション内の階層連番。
  • レートに関連付けられた3番目のディメンションの一意の識別子。 スコア・カード・レート表に3つ以上のディメンションがある場合にのみ使用されます。
  • タイトル: Name
    読取り専用: true
    3番目のディメンションの名前。
  • レートに関連付けられた第3ディメンションの階層の一意の識別子。
  • タイトル: Sequence
    読取り専用: true
    ディメンション内の階層連番。
  • レートに関連付けられた4番目のディメンションの一意の識別子。 スコア・カード・レート表に4つ以上のディメンションがある場合にのみ使用されます。
  • タイトル: Name
    読取り専用: true
    4番目のディメンションの名前。
  • レートに関連付けられた4番目のディメンションの階層の一意の識別子。
  • タイトル: Sequence
    読取り専用: true
    ディメンション内の階層連番。
  • レートに関連付けられた5番目のディメンションの一意の識別子。 スコア・カード・レート表に少なくとも5つのディメンションがある場合にのみ使用されます。
  • タイトル: Name
    読取り専用: true
    5番目のディメンションの名前。
  • レートに関連付けられた5番目のディメンションの階層の一意の識別子。
  • タイトル: Sequence
    読取り専用: true
    ディメンション内の階層連番。
  • レートに関連付けられた6番目のディメンションの一意の識別子。 スコア・カード・レート表に少なくとも6つのディメンションがある場合にのみ使用されます。
  • タイトル: Name
    読取り専用: true
    6番目のディメンションの名前。
  • レートに関連付けられた6番目のディメンションの階層の一意の識別子。
  • タイトル: Sequence
    読取り専用: true
    ディメンション内の階層連番。
  • レートに関連付けられた7番目のディメンションの一意の識別子。 スコア・カード・レート表に少なくとも7つのディメンションがある場合にのみ使用されます。
  • タイトル: Name
    読取り専用: true
    7番目のディメンションの名前。
  • レートに関連付けられた7番目のディメンションの階層の一意の識別子。
  • タイトル: Sequence
    読取り専用: true
    ディメンション内の階層連番。
  • レートに関連付けられた8番目のディメンションの一意の識別子。 スコア・カード・レート表に8つ以上のディメンションがある場合にのみ使用されます。
  • タイトル: Name
    読取り専用: true
    第8ディメンションの名前。
  • レートに関連付けられた8番目のディメンションの階層の一意の識別子。
  • タイトル: Sequence
    読取り専用: true
    ディメンション内の階層連番。
  • レートに関連付けられた9番目のディメンションの一意の識別子。 スコア・カード・レート表に少なくとも9つのディメンションがある場合にのみ使用されます。
  • タイトル: Name
    読取り専用: true
    9番目のディメンションの名前。
  • レートに関連付けられた9番目のディメンションの階層の一意の識別子。
  • タイトル: Sequence
    読取り専用: true
    ディメンション内の階層連番。
  • 読取り専用: true
    基本報酬プランに関連付けられたスコア・カード・レート表の一意の識別子です。 ベース・プランはプラン管理者によってモデル化され、参加者プランのソースです。
  • 基本報酬プランに関連付けられたレートの一意の識別子です。 ベース・プランはプラン管理者によってモデル化され、参加者プランのソースです。
「トップに戻る」