機械翻訳について

ジャンプ先

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

すべてのパフォーマンス測定目標の取得

get

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

リクエスト

パス・パラメータ

• ParticipantPerformanceMeasureId(required): integer(int64)
  参加者プラン・コンポーネントに関連付けられたパフォーマンス・メジャーの一意の識別子。
• ParticipantPlanComponentId(required): integer(int64)
  参加者報酬プランに関連付けられたプラン・コンポーネントの一意の識別子です。
• participantCompensationPlansUniqID(required): string
  これは、関係者報酬プラン・リソースの複合キーを構成し、関係者報酬プランのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、参加者報酬プラン・コレクション・リソースを問い合せて、ハッシュ・キーを取得するために参加者報酬プランの特定のインスタンスに移動する必要があります。

問合せパラメータ

• 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: 指定した主キーを持つ参加者目標を検索します。 関連プラン・コンポーネントの個別設定オプションをはいに設定する必要があります。
    ファインダ変数:
    • ParticipantGoalId; integer;参加者目標の一意の識別子。
• 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問合せパラメータを使用してこの収集リソースをフィルタできます:
  

  • AlternateTarget1; number;メジャーの代替ターゲット番号。たとえば、ストレッチ目標。
  • AlternateTarget2; number;メジャーの代替ターゲット番号。たとえば、ストレッチ目標。
  • AlternateTarget3; number;メジャーの代替ターゲット番号。たとえば、ストレッチ目標。
  • AlternateTarget4; number;メジャーの代替ターゲット番号。たとえば、ストレッチ目標。
  • AlternateTarget5; number;メジャーの代替ターゲット番号。たとえば、ストレッチ目標。
  • CreatedBy; string; 参加者パフォーマンス・メジャー目標を作成したユーザー。
  • CreationDate; string; 参加者パフォーマンス・メジャー目標が作成された日時。
  • GoalId; integer;基本報酬プランに関連付けられた目標の一意の識別子。 ベース・プランはプラン管理者によってモデル化され、参加者プランのソースです。
  • GoalInterval; string;期間、四半期、年など、目標金額の達成のために測定される期間を表すパフォーマンス間隔。 この間隔は、対応するパフォーマンス(メジャー)間隔と同じです。
  • GoalTarget; number;メジャーの参加者に割り当てられる予測達成レベル。
  • LastUpdateDate; string;参加者パフォーマンス・メジャー目標が最後に更新された日時。
  • LastUpdatedBy; string; 参加者パフォーマンス・メジャー目標を最後に更新したユーザー。
  • ParticipantGoalId; integer;参加者パフォーマンス・メジャーに関連付けられた目標の一意の識別子。
  • ParticipantPerformanceMeasureId; integer;参加者パフォーマンス・メジャーの一意の識別子。
  • PerformanceMeasureId; integer; 基本報酬プランに関連付けられたパフォーマンス・メジャーの一意の識別子。 ベース・プランはプラン管理者によってモデル化され、参加者プランのソースです。
  • PerformanceMeasureName; string;パフォーマンス・メジャーの名前。
• 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のデフォルト・バージョンを選択します。

本文( )

ルート・スキーマ : participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals

タイプ: 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"の場合の推定行数。それ以外の場合、カウントは含まれません。

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals-item-response"
            }
        }
    }
}

ネストされたスキーマ : アイテム

タイプ: array

タイトル: Items

コレクション内のアイテム。

ソースを表示

• Array of: object participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals-item-response"
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

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

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals-item-response

タイプ: object

ソースを表示

• AlternateTarget1: number
  タイトル: Alternate Target 1

  デフォルト値: 0

  ストレッチ目標など、メジャーの代替ターゲット番号。
• AlternateTarget2: number
  タイトル: Alternate Target 2

  デフォルト値: 0

  ストレッチ目標など、メジャーの代替ターゲット番号。
• AlternateTarget3: number
  タイトル: Alternate Target 3

  デフォルト値: 0

  ストレッチ目標など、メジャーの代替ターゲット番号。
• AlternateTarget4: number
  タイトル: Alternate Target 4

  デフォルト値: 0

  ストレッチ目標など、メジャーの代替ターゲット番号。
• AlternateTarget5: number
  タイトル: Alternate Target 5

  デフォルト値: 0

  ストレッチ目標など、メジャーの代替ターゲット番号。
• CreatedBy: string
  読取り専用: true

  最大長: 64

  参加者パフォーマンス・メジャー目標を作成したユーザー。
• CreationDate: string (date-time)
  読取り専用: true

  参加者パフォーマンス・メジャー目標が作成された日時。
• DistributeEvenlyFlag: boolean
  合計ターゲットおよび代替ターゲットを、このwebサービス・リクエストのそれぞれの間隔および期間の金額に均等に配分するアプリケーションの指示。 指定可能な値はTRUEおよびFALSEです。
• GoalId: integer (int64)
  読取り専用: true

  基本報酬プランに関連付けられた目標の一意の識別子。 ベース・プランはプラン管理者によってモデル化され、参加者プランのソースです。
• GoalInterval: string
  タイトル: Interval

  読取り専用: true

  期間、四半期、年など、目標金額の達成に対して測定される時間の範囲を記述するパフォーマンス間隔。 この間隔は、対応するパフォーマンス(メジャー)間隔と同じです。
• GoalTarget: number
  タイトル: Total Target

  デフォルト値: 0

  メジャーの参加者に割り当てられる予定達成レベル。
• LastUpdateDate: string (date-time)
  読取り専用: true

  関係者パフォーマンス・メジャー目標が最後に更新された日時。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  関係者パフォーマンス・メジャー目標を最後に更新したユーザー。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• ParticipantGoalId: integer (int64)
  読取り専用: true

  参加者パフォーマンス・メジャーに関連付けられた目標の一意の識別子です。
• ParticipantGoalIntervalGoals: array Interval Goals
  タイトル: Interval Goals

  パフォーマンス・メジャー間隔目標サービスは、個別設定できる参加者パフォーマンス・メジャーの間隔ターゲット金額を表示するために使用されます。 パフォーマンス・メジャーの個別設定を有効にするには、関連する参加者プラン・コンポーネントに対して個別設定オプションをはいに設定します。
• ParticipantGoalPeriodGoals: array Period Goals
  タイトル: Period Goals

  パフォーマンス・メジャー期間目標サービスは、個別設定できる参加者パフォーマンス・メジャーの期間ターゲット金額を表示および更新するために使用します。 パフォーマンス・メジャーの個別設定を有効にするには、関連する参加者プラン・コンポーネントに対して個別設定オプションをはいに設定します。
• ParticipantPerformanceMeasureId: integer (int64)
  読取り専用: true

  参加者パフォーマンス・メジャーの一意の識別子。
• PerformanceMeasureId: integer (int64)
  読取り専用: true

  基本報酬プランに関連付けられたパフォーマンス・メジャーの一意の識別子。 ベース・プランはプラン管理者によってモデル化され、参加者プランのソースです。
• PerformanceMeasureName: string
  タイトル: Name

  読取り専用: true

  パフォーマンス・メジャーの名前。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the participant performance measure goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the participant performance measure goal is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PerformanceMeasureName":{
            "title":"Name",
            "type":"string",
            "description":"The name of the performance measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantGoalId":{
            "type":"integer",
            "description":"The unique identifier of the goal associated with the participant performance measure.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the participant performance measure goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalInterval":{
            "title":"Interval",
            "type":"string",
            "description":"The performance interval that describes the span of time to be measured for the attainment of the goal amounts, such as period, quarter, or year. This interval is the same as the corresponding performance (measure) interval.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalTarget":{
            "title":"Total Target",
            "type":"number",
            "description":"The expected level of attainment assigned to the participant for the measure.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "AlternateTarget1":{
            "title":"Alternate Target 1",
            "type":"number",
            "description":"The alternate target number for a measure, for example, stretch goal.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "AlternateTarget2":{
            "title":"Alternate Target 2",
            "type":"number",
            "description":"The alternate target number for a measure, for example, stretch goal.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "ParticipantGoalIntervalGoals":{
            "title":"Interval Goals",
            "type":"array",
            "description":"The performance measure interval goals service is used to view the interval target amounts for a participant performance measure that can be individualized. You enable individualization for a performance measure by setting the Individualize option to Yes for the related participant plan component.",
            "items":{
                "$ref":"#/components/schemas/participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals-ParticipantGoalIntervalGoals-item-response"
            }
        },
        "AlternateTarget3":{
            "title":"Alternate Target 3",
            "type":"number",
            "description":"The alternate target number for a measure, for example, stretch goal.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "ParticipantPerformanceMeasureId":{
            "type":"integer",
            "description":"The unique identifier of the participant performance measure.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AlternateTarget4":{
            "title":"Alternate Target 4",
            "type":"number",
            "description":"The alternate target number for a measure, for example, stretch goal.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "AlternateTarget5":{
            "title":"Alternate Target 5",
            "type":"number",
            "description":"The alternate target number for a measure, for example, stretch goal.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "PerformanceMeasureId":{
            "type":"integer",
            "description":"The unique identifier of the performance measure associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DistributeEvenlyFlag":{
            "type":"boolean",
            "description":"The instruction for the application to evenly distribute the total target and alternate targets to the respective interval and period amounts for this web service request. The possible values are TRUE and FALSE.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParticipantGoalPeriodGoals":{
            "title":"Period Goals",
            "type":"array",
            "description":"The performance measure period goals service is used to view and update the period target amounts for a participant performance measure that can be individualized. You enable individualization for a performance measure by setting the Individualize option to Yes for the related participant plan component.",
            "items":{
                "$ref":"#/components/schemas/participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals-ParticipantGoalPeriodGoals-item-response"
            }
        },
        "GoalId":{
            "type":"integer",
            "description":"The unique identifier of the goal associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the participant performance measure goal is last updated.",
            "format":"date-time",
            "nullable":false,
            "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"
    }
}

ネストされたスキーマ : 間隔目標

タイプ: array

タイトル: Interval Goals

パフォーマンス・メジャー間隔目標サービスは、個別設定できる参加者パフォーマンス・メジャーの間隔ターゲット金額を表示するために使用されます。 パフォーマンス・メジャーの個別設定を有効にするには、関連する参加者プラン・コンポーネントに対して個別設定オプションをはいに設定します。

ソースを表示

• Array of: object participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals-ParticipantGoalIntervalGoals-item-response

{
    "title":"Interval Goals",
    "type":"array",
    "description":"The performance measure interval goals service is used to view the interval target amounts for a participant performance measure that can be individualized. You enable individualization for a performance measure by setting the Individualize option to Yes for the related participant plan component.",
    "items":{
        "$ref":"#/components/schemas/participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals-ParticipantGoalIntervalGoals-item-response"
    }
}

ネストされたスキーマ : 期間目標

タイプ: array

タイトル: Period Goals

パフォーマンス・メジャー期間目標サービスは、個別設定できる参加者パフォーマンス・メジャーの期間ターゲット金額を表示および更新するために使用します。 パフォーマンス・メジャーの個別設定を有効にするには、関連する参加者プラン・コンポーネントに対して個別設定オプションをはいに設定します。

ソースを表示

• Array of: object participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals-ParticipantGoalPeriodGoals-item-response

{
    "title":"Period Goals",
    "type":"array",
    "description":"The performance measure period goals service is used to view and update the period target amounts for a participant performance measure that can be individualized. You enable individualization for a performance measure by setting the Individualize option to Yes for the related participant plan component.",
    "items":{
        "$ref":"#/components/schemas/participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals-ParticipantGoalPeriodGoals-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."
        }
    }
}

ネストされたスキーマ : participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals-ParticipantGoalIntervalGoals-item-response

タイプ: object

ソースを表示

• AlternateIntervalTarget1: number
  タイトル: Alternate Interval Target 1

  読取り専用: true

  デフォルト値: 0

  間隔のストレッチ目標など、メジャーの代替間隔ターゲット。
• AlternateIntervalTarget2: number
  タイトル: Alternate Interval Target 2

  読取り専用: true

  デフォルト値: 0

  間隔のストレッチ目標など、メジャーの代替間隔ターゲット。
• AlternateIntervalTarget3: number
  タイトル: Alternate Interval Target 3

  読取り専用: true

  デフォルト値: 0

  間隔のストレッチ目標など、メジャーの代替間隔ターゲット。
• AlternateIntervalTarget4: number
  タイトル: Alternate Interval Target 4

  読取り専用: true

  デフォルト値: 0

  間隔のストレッチ目標など、メジャーの代替間隔ターゲット。
• AlternateIntervalTarget5: number
  タイトル: Alternate Interval Target 5

  読取り専用: true

  デフォルト値: 0

  間隔のストレッチ目標など、メジャーの代替間隔ターゲット。
• CreatedBy: string
  読取り専用: true

  最大長: 64

  間隔目標を作成したユーザー。
• CreationDate: string (date-time)
  読取り専用: true

  間隔目標が作成された日時。
• GoalId: integer (int64)
  読取り専用: true

  基本報酬プランに関連付けられた目標の一意の識別子。 ベース・プランはプラン管理者によってモデル化され、参加者プランのソースです。
• IntervalGoalId: integer (int64)
  タイトル: Period

  読取り専用: true

  基本報酬プランに関連付けられた間隔目標の一意の識別子。 ベース・プランはプラン管理者によってモデル化され、参加者プランのソースです。
• IntervalNumber: number
  タイトル: Period

  読取り専用: true

  間隔の表示番号。
• IntervalTarget: number
  タイトル: Interval Target

  読取り専用: true

  デフォルト値: 0

  目標間隔に指定されたターゲット番号。
• LastUpdateDate: string (date-time)
  読取り専用: true

  間隔が最後に更新された日時。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  間隔目標を最後に更新したユーザー。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• ParticipantGoalId: integer (int64)
  読取り専用: true

  目標の一意のID。
• ParticipantIntervalGoalId: integer (int64)
  読取り専用: true

  参加者間隔目標詳細の一意の識別子。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the interval goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the interval goal is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantIntervalGoalId":{
            "type":"integer",
            "description":"The unique identifier of the participant interval goal details.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParticipantGoalId":{
            "type":"integer",
            "description":"The unique identifier of the goal.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the interval goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IntervalTarget":{
            "title":"Interval Target",
            "type":"number",
            "description":"The target number specified for the goal interval.",
            "nullable":true,
            "readOnly":true,
            "default":0,
            "x-queryable":true
        },
        "AlternateIntervalTarget1":{
            "title":"Alternate Interval Target 1",
            "type":"number",
            "description":"The alternate interval target for a measure, for example, stretch goal for an interval.",
            "nullable":true,
            "readOnly":true,
            "default":0,
            "x-queryable":true
        },
        "AlternateIntervalTarget2":{
            "title":"Alternate Interval Target 2",
            "type":"number",
            "description":"The alternate interval target for a measure, for example, stretch goal for an interval.",
            "nullable":true,
            "readOnly":true,
            "default":0,
            "x-queryable":true
        },
        "AlternateIntervalTarget3":{
            "title":"Alternate Interval Target 3",
            "type":"number",
            "description":"The alternate interval target for a measure, for example, stretch goal for an interval.",
            "nullable":true,
            "readOnly":true,
            "default":0,
            "x-queryable":true
        },
        "AlternateIntervalTarget4":{
            "title":"Alternate Interval Target 4",
            "type":"number",
            "description":"The alternate interval target for a measure, for example, stretch goal for an interval.",
            "nullable":true,
            "readOnly":true,
            "default":0,
            "x-queryable":true
        },
        "AlternateIntervalTarget5":{
            "title":"Alternate Interval Target 5",
            "type":"number",
            "description":"The alternate interval target for a measure, for example, stretch goal for an interval.",
            "nullable":true,
            "readOnly":true,
            "default":0,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "IntervalGoalId":{
            "title":"Period",
            "type":"integer",
            "description":"The unique identifier of the interval goal associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IntervalNumber":{
            "title":"Period",
            "type":"number",
            "description":"The display number for the interval.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalId":{
            "type":"integer",
            "description":"The unique identifier of the goal associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the interval is last updated.",
            "format":"date-time",
            "nullable":false,
            "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"
    }
}

ネストされたスキーマ : participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals-ParticipantGoalPeriodGoals-item-response

タイプ: object

ソースを表示

• AlternateITDTarget1: number
  タイトル: Alternate ITD Target 1

  読取り専用: true

  デフォルト値: 0

  メジャーの代替間隔累計ターゲット番号。
• AlternateITDTarget2: number
  タイトル: Alternate ITD Target 2

  読取り専用: true

  デフォルト値: 0

  メジャーの代替間隔累計ターゲット番号。
• AlternateITDTarget3: number
  タイトル: Alternate ITD Target 3

  読取り専用: true

  デフォルト値: 0

  メジャーの代替間隔累計ターゲット番号。
• AlternateITDTarget4: number
  タイトル: Alternate ITD Target 4

  読取り専用: true

  デフォルト値: 0

  メジャーの代替間隔累計ターゲット番号。
• AlternateITDTarget5: number
  タイトル: Alternate ITD Target 5

  読取り専用: true

  デフォルト値: 0

  メジャーの代替間隔累計ターゲット番号。
• AlternatePeriodTarget1: number
  タイトル: Alternate Period Target 1

  デフォルト値: 0

  期間のストレッチ目標など、メジャーの代替期間ターゲット番号。
• AlternatePeriodTarget2: number
  タイトル: Alternate Period Target 2

  デフォルト値: 0

  期間のストレッチ目標など、メジャーの代替期間ターゲット番号。
• AlternatePeriodTarget3: number
  タイトル: Alternate Period Target 3

  デフォルト値: 0

  期間のストレッチ目標など、メジャーの代替期間ターゲット番号。
• AlternatePeriodTarget4: number
  タイトル: Alternate Period Target 4

  デフォルト値: 0

  期間のストレッチ目標など、メジャーの代替期間ターゲット番号。
• AlternatePeriodTarget5: number
  タイトル: Alternate Period Target 5

  デフォルト値: 0

  期間のストレッチ目標など、メジャーの代替期間ターゲット番号。
• CreatedBy: string
  読取り専用: true

  最大長: 64

  期間目標を作成したユーザー。
• CreationDate: string (date-time)
  読取り専用: true

  期間目標が作成された日時。
• GoalId: integer (int64)
  読取り専用: true

  基本報酬プランに関連付けられた目標の一意の識別子。 ベース・プランはプラン管理者によってモデル化され、参加者プランのソースです。
• IntervalGoalId: integer (int64)
  読取り専用: true

  基本報酬プランに関連付けられた間隔目標の一意の識別子。 ベース・プランはプラン管理者によってモデル化され、参加者プランのソースです。
• ITDTarget: number
  タイトル: ITD Target

  読取り専用: true

  デフォルト値: 0

  メジャーの間隔累計ターゲット番号。
• LastUpdateDate: string (date-time)
  読取り専用: true

  期間目標が最後に更新された日時。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  期間目標を最後に更新したユーザー。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• ParticipantGoalId: integer (int64)
  読取り専用: true

  目標の一意のID。
• ParticipantIntervalGoalId: integer (int64)
  読取り専用: true

  参加者間隔目標詳細の一意の識別子。
• ParticipantPeriodGoalId: integer (int64)
  読取り専用: true

  期間目標の一意の識別子。
• PeriodEndDate: 文字列(日付)
  タイトル: End Date

  読取り専用: true

  期間が終了する日付。
• PeriodGoalId: integer (int64)
  読取り専用: true

  基本報酬プランに関連付けられた期間目標の一意の識別子です。 ベース・プランはプラン管理者によってモデル化され、参加者プランのソースです。
• PeriodId: integer (int64)
  タイトル: Period

  読取り専用: true

  カレンダに定義されている期間の一意の識別子。
• PeriodName: string
  タイトル: Period

  読取り専用: true

  最大長: 30

  カレンダで定義された期間の名前。
• PeriodStartDate: 文字列(日付)
  タイトル: Start Date

  読取り専用: true

  期間の開始日。
• PeriodTarget: number
  タイトル: Period Target

  デフォルト値: 0

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

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the period goal is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodGoalId":{
            "type":"integer",
            "description":"The unique identifier of the period goal associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PeriodEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the period of time ends.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "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,
            "default":0,
            "x-hints":{
                "dependencies":[
                    "AlternatePeriodTarget2"
                ]
            },
            "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.",
            "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,
            "default":0,
            "x-hints":{
                "dependencies":[
                    "AlternatePeriodTarget3"
                ]
            },
            "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.",
            "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,
            "default":0,
            "x-hints":{
                "dependencies":[
                    "AlternatePeriodTarget1"
                ]
            },
            "x-queryable":true
        },
        "AlternateITDTarget4":{
            "title":"Alternate ITD Target 4",
            "type":"number",
            "description":"The alternate interval-to-date target number for a measure.",
            "nullable":true,
            "readOnly":true,
            "default":0,
            "x-hints":{
                "dependencies":[
                    "AlternatePeriodTarget4"
                ]
            },
            "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,
            "default":0,
            "x-hints":{
                "dependencies":[
                    "AlternatePeriodTarget5"
                ]
            },
            "x-queryable":true
        },
        "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,
            "default":0,
            "x-hints":{
                "dependencies":[
                    "PeriodTarget"
                ]
            },
            "x-queryable":true
        },
        "ParticipantPeriodGoalId":{
            "type":"integer",
            "description":"The unique identifier of the period goal.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AlternatePeriodTarget1":{
            "title":"Alternate Period Target 1",
            "type":"number",
            "description":"The alternate period target number for a measure, for example, stretch goal for a period.",
            "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.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "GoalId":{
            "type":"integer",
            "description":"The unique identifier of the goal associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "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.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the period goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantIntervalGoalId":{
            "type":"integer",
            "description":"The unique identifier of the participant interval goal details.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the period goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantGoalId":{
            "type":"integer",
            "description":"The unique identifier of the goal.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PeriodId":{
            "title":"Period",
            "type":"integer",
            "description":"The unique identifier for the period of time defined in the calendar.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PeriodTarget":{
            "title":"Period Target",
            "type":"number",
            "description":"The period target number for a measure.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "PeriodStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the period of time begins.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IntervalGoalId":{
            "type":"integer",
            "description":"The unique identifier of the interval goal associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PeriodName":{
            "title":"Period",
            "maxLength":30,
            "type":"string",
            "description":"The name for a period of time defined in the calendar.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the period goal is last updated.",
            "format":"date-time",
            "nullable":false,
            "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"
    }
}

「トップに戻る」