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

機械翻訳について

すべての報酬プランの取得

get

/fscmRestApi/resources/11.13.18.05/compensationPlans

リクエスト

問合せパラメータ

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 : 指定した主キーを持つ報酬プランを検索します。
  ファインダ変数:
  - CompensationPlanId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
- AllowCreditCategoryOverlapFlag; boolean;クレジット・カテゴリが報酬プラン内の複数のプラン・コンポーネントに存在できるかどうかを示します。指定可能な値は、N、FALSE、YまたはTRUEです。デフォルト値はFALSEです。許容可能な値のリストは、参照CN_ECAT_OVERLAP_FLAGで定義されます。設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
- ApprovalStatus; string; 承認プロセスにおける報酬プランのステータス。指定可能な値は、APPROVED、NOT_APPROVED、PENDINGおよびREJECTEDです。デフォルト値はNOT_APPROVEDです。受理可能な値のリストは、参照CN_PLAN_APPR_STATUSで定義されます。設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
- CompensationPlanId; integer;報酬プランの一意の識別子。
- CreatedBy; string; レコードを作成したユーザー。
- CreationDate; string; レコードが作成された日時。
- 説明;文字列;報酬プランの摘要。
- DisplayName; string;営業担当のユーザー・インタフェースに表示される報酬プランの名前。
- EndDate; string; 報酬プランが非アクティブになる日時。許容可能な書式はyyyy-mm-ddです。日付が割り当てられると、nullに更新できません。
- InvalidReason; string; 報酬プランが無効である理由を説明する理由。
- LastUpdateDate; string; レコードが最後に更新された日時。
- LastUpdateLogin; string; レコードを最後に更新したユーザーに関連付けられたセッション・ログイン。
- LastUpdatedBy; string; レコードを最後に更新したユーザー。
- 名前;文字列;報酬プランの名前。
- OrgId; integer;ビジネス・ユニットの一意の識別子。
- PlanDocumentTemplate; string;報酬プランの作成に使用されるレポート・テンプレートの名前。
- StartDate; string; 報酬プランがアクティブになる日時。許容可能な書式はyyyy-mm-ddです。
- TargetIncentive; number;プラン内のすべての目標または目標が満たされた場合の、参加者の予想支給(変動報酬)です。デフォルト値は、0です。
- 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のデフォルト・バージョンを選択します。

ルート・スキーマ : compensationPlans

タイプ: 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/compensationPlans-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

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

タイプ: array

タイトル: Items

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

ソースを表示

Array of: object compensationPlans-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/compensationPlans-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"
    }
}

ネストされたスキーマ : compensationPlans-item-response

タイプ: object

ソースを表示

AllowCreditCategoryOverlapFlag: boolean

タイトル: Allow Credit Category Overlap

最大長: 1

デフォルト値: false

クレジット・カテゴリが報酬プラン内の複数のプラン・コンポーネントに存在できるかどうかを示します。指定可能な値は、N、FALSE、YまたはTRUEです。デフォルト値はFALSEです。許容可能な値のリストは、参照CN_ECAT_OVERLAP_FLAGで定義されます。設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
ApprovalStatus: string

タイトル: Approval Status

最大長: 30

デフォルト値: NOT_APPROVED

承認プロセスの報酬プランのステータスです。指定可能な値は、APPROVED、NOT_APPROVED、PENDINGおよびREJECTEDです。デフォルト値はNOT_APPROVEDです。受理可能な値のリストは、参照CN_PLAN_APPR_STATUSで定義されます。設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
CompensationPlanAssignments: array Assigned Participants

タイトル: Assigned Participants

割当リソースは、報酬プランに関連付けられているすべての関係者を表示するために使用されます。これには、直接割り当てられる参加者、またはインセンティブ報酬ロールを介して割り当てられる参加者が含まれます。アサイメントは、参加者が報酬プランの一部になった日付を示します。アクティブな報酬プランおよび参加者は、アサイメントを作成する前に存在する必要があります。
CompensationPlanComponents: array Compensation Plan - Plan Components

タイトル: Compensation Plan - Plan Components

プラン・コンポーネント・リソースは、プラン・コンポーネントと報酬プランの関連を作成、更新または削除するために使用されます。また、報酬プランのプラン・コンポーネントのすべての詳細を表示するためにも使用できます。プラン・コンポーネント・リソースは、プラン・コンポーネントを報酬にリンクし、このレベルで追加詳細を提供します。このレコードを作成する前に、プラン・コンポーネントが存在する必要があります。
CompensationPlanDirectAssignmentRequests: array Direct Assignment Requests

タイトル: Direct Assignment Requests

直接割当リクエスト・リソースは、直接参加者割当リクエストを表示、作成および削除するために使用されます。リソースを使用して、プランへの新規参加者の割当をリクエストしたり、既存の参加者割当を編集したり、プランに割り当てられた参加者を削除したりできます。リソースを使用して、以前に呼び出されたリクエストを削除することもできます。リクエストを作成したら、適用する給与プランのデプロイ・プロセスを実行する必要があります。この変更は適用されると、割当リソースに表示されます。
CompensationPlanId: integer (int64)

タイトル: Compensation Plan ID

報酬プランの一意の識別子。
CompensationPlanRoles: array Compensation Plan - Roles

タイトル: Compensation Plan - Roles

ロール・リソースは、報酬プランへのロールの割当を作成、更新または削除するために使用されます。報酬プランに割り当てられたロールのすべての詳細を表示するためにも使用されます。ロール・リソースは、インセンティブ報酬ロールを報酬プランにリンクし、このレベルで追加詳細を提供します。このレコードを作成する前に、ロールが存在している必要があります。このサービスを使用して報酬プランにロールを割り当てることができるのは、プラン管理者のみです。
compensationPlansDFF: array Compensation Plan - Descriptive Flex Fields

タイトル: Compensation Plan - Descriptive Flex Fields

付加フレックス・フィールド・リソースは、報酬プランのユーザー定義値を格納するために使用されます。新しいAPI名を定義するには、Setup and Maintenance(設定および保守)に移動し、Manage Descriptive Flex Fields(付加フレックスフィールドの管理)タスクを開きます。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

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

タイトル: Creation Date

読取り専用: true

レコードが作成された日時。
Description: string

タイトル: Description

最大長: 1000

報酬プランの摘要。
DisplayName: string

タイトル: Display Name

最大長: 80

営業担当のユーザー・インタフェースに表示される報酬プランの名前。
EndDate: 文字列(日付)

タイトル: End Date

報酬プランが非アクティブになる日時。許容可能な書式はyyyy-mm-ddです。日付が割り当てられると、nullに更新できません。
InvalidReason: string

読取り専用: true

報酬プランが無効である理由を説明する事由です。
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

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

タイトル: Compensation Plan Name

最大長: 80

報酬プランの名前。
OrgId: integer (int64)

タイトル: Business Unit

ビジネス・ユニットの一意の識別子。
PlanDocumentTemplate: string

タイトル: Plan Document Template

最大長: 80

報酬プランの作成に使用されるレポート・テンプレートの名前。
StartDate: 文字列(日付)

タイトル: Start Date

報酬プランがアクティブになる日時。許容可能な書式はyyyy-mm-ddです。
TargetIncentive: number

タイトル: Target Incentive

デフォルト値: 0

プラン内のすべての目標または目標が達成された場合の、参加者の予想支給(変動報酬)です。デフォルト値は、0です。
ValidForCalculation: string

タイトル: Valid for Calculation

読取り専用: true

最大長: 30

デフォルト値: INCOMPLETE

報酬プランが計算に有効かどうかを示します。使用可能な値には、COMPLETEおよびINCOMPLETEがあります。デフォルト値はINCOMPLETEです。許容可能な値のリストは、参照CN_COMP_PLAN_STATUSで定義されます。設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "compensationPlansDFF":{
            "title":"Compensation Plan - Descriptive Flex Fields",
            "type":"array",
            "description":"The descriptive flex fields resource is used to store user defined values for the compensation plan. A new API name can be defined by going to Setup and Maintenance and opening the Manage Descriptive Flex Fields task.",
            "items":{
                "$ref":"#/components/schemas/compensationPlans-compensationPlansDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "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
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CompensationPlanId":{
            "title":"Compensation Plan ID",
            "type":"integer",
            "description":"The unique identifier of the compensation plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the compensation plan.",
            "nullable":true,
            "x-queryable":true
        },
        "ValidForCalculation":{
            "title":"Valid for Calculation",
            "maxLength":30,
            "type":"string",
            "description":"Indicates if the compensation plan is valid for calculation. Possible values include COMPLETE and INCOMPLETE. The default value is INCOMPLETE. A list of acceptable values is defined in the lookup CN_COMP_PLAN_STATUS. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "readOnly":true,
            "default":"INCOMPLETE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CompensationPlanRoles":{
            "title":"Compensation Plan - Roles",
            "type":"array",
            "description":"The roles resource is used to create, update, or delete the assignment of a role to a compensation plan. It is also be used to display all the details of roles assigned to a compensation plan. A roles resource links the Incentive Compensation role to a compensation plan and provides additional details at this level. A role needs to exist before creating this record. Only the plan administrator can assign a role to the compensation plan using this service.",
            "items":{
                "$ref":"#/components/schemas/compensationPlans-CompensationPlanRoles-item-response"
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date and time when the compensation plan becomes inactive. The acceptable format is yyyy-mm-dd. Once the date is assigned, it cannot be updated to null.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ApprovalStatus":{
            "title":"Approval Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the compensation plan in the approval process. Possible values include APPROVED, NOT_APPROVED, PENDING, and REJECTED. The default value is NOT_APPROVED. A list of acceptable values is defined in the lookup CN_PLAN_APPR_STATUS. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "default":"NOT_APPROVED",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Compensation Plan Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of the compensation plan.",
            "nullable":false,
            "x-queryable":true
        },
        "CompensationPlanAssignments":{
            "title":"Assigned Participants",
            "type":"array",
            "description":"The assignments resource is used to view all the participants associated with a compensation plan. This includes participants that are assigned directly or assigned through incentive compensation roles. An assignments provides the dates when a participant became a part of a compensation plan. An active compensation plan and a participant need to exist before creating an assignment.",
            "items":{
                "$ref":"#/components/schemas/compensationPlans-CompensationPlanAssignments-item-response"
            }
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date and time when the compensation plan becomes active. The acceptable format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "controlType":"date"
            },
            "x-queryable":true
        },
        "OrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "TargetIncentive":{
            "title":"Target Incentive",
            "type":"number",
            "description":"The expected earnings (variable compensation) of a participant when all the objectives or goals in a plan are met. The default value is 0.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "CompensationPlanComponents":{
            "title":"Compensation Plan - Plan Components",
            "type":"array",
            "description":"The plan components resource is used to create, update, or delete the association of a plan component with a compensation plan. It can also be used to display all the details of plan components under a compensation plan. A plan component resource links the plan component with the compensation and provides additional details at this level. A plan component needs to exist before creating this record.",
            "items":{
                "$ref":"#/components/schemas/compensationPlans-CompensationPlanComponents-item-response"
            }
        },
        "CompensationPlanDirectAssignmentRequests":{
            "title":"Direct Assignment Requests",
            "type":"array",
            "description":"The direct assignment requests resource is used to view, create, and delete direct participant assignment requests. The resource can be used to request a new participant to be assigned to a plan, edit an existing participant assignment, or delete a participant assigned to a plan. The resource can also be used to delete a previously raised request. Once a request is created, the user must run the Deploy Compensation Plans process for it to apply. Once applied, this change can be seen in the Assignments resource.",
            "items":{
                "$ref":"#/components/schemas/compensationPlans-CompensationPlanDirectAssignmentRequests-item-response"
            }
        },
        "DisplayName":{
            "title":"Display Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of the compensation plan that is displayed on the sales representative's user interface.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AllowCreditCategoryOverlapFlag":{
            "title":"Allow Credit Category Overlap",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a credit category can exist in multiple plan components within the compensation plan. Possible values include N, or FALSE, and Y, or TRUE. The default value is FALSE. A list of acceptable values is defined in the lookup CN_ECAT_OVERLAP_FLAG. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PlanDocumentTemplate":{
            "title":"Plan Document Template",
            "maxLength":80,
            "type":"string",
            "description":"The name of the report template used to create a compensation plan.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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 associated to the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvalidReason":{
            "type":"string",
            "description":"The reason explaining why the compensation plan is invalid.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : 割当済関係者

タイプ: array

タイトル: Assigned Participants

割当リソースは、報酬プランに関連付けられているすべての関係者を表示するために使用されます。これには、直接割り当てられる参加者、またはインセンティブ報酬ロールを介して割り当てられる参加者が含まれます。アサイメントは、参加者が報酬プランの一部になった日付を示します。アクティブな報酬プランおよび参加者は、アサイメントを作成する前に存在する必要があります。

ソースを表示

Array of: object compensationPlans-CompensationPlanAssignments-item-response

{
    "title":"Assigned Participants",
    "type":"array",
    "description":"The assignments resource is used to view all the participants associated with a compensation plan. This includes participants that are assigned directly or assigned through incentive compensation roles. An assignments provides the dates when a participant became a part of a compensation plan. An active compensation plan and a participant need to exist before creating an assignment.",
    "items":{
        "$ref":"#/components/schemas/compensationPlans-CompensationPlanAssignments-item-response"
    }
}

ネストされたスキーマ : 報酬プラン - プラン・コンポーネント

タイプ: array

タイトル: Compensation Plan - Plan Components

プラン・コンポーネント・リソースは、プラン・コンポーネントと報酬プランの関連を作成、更新または削除するために使用されます。また、報酬プランのプラン・コンポーネントのすべての詳細を表示するためにも使用できます。プラン・コンポーネント・リソースは、プラン・コンポーネントを報酬にリンクし、このレベルで追加詳細を提供します。このレコードを作成する前に、プラン・コンポーネントが存在する必要があります。

ソースを表示

Array of: object compensationPlans-CompensationPlanComponents-item-response

{
    "title":"Compensation Plan - Plan Components",
    "type":"array",
    "description":"The plan components resource is used to create, update, or delete the association of a plan component with a compensation plan. It can also be used to display all the details of plan components under a compensation plan. A plan component resource links the plan component with the compensation and provides additional details at this level. A plan component needs to exist before creating this record.",
    "items":{
        "$ref":"#/components/schemas/compensationPlans-CompensationPlanComponents-item-response"
    }
}

ネストされたスキーマ : 直接割当リクエスト

タイプ: array

タイトル: Direct Assignment Requests

直接割当リクエスト・リソースは、直接参加者割当リクエストを表示、作成および削除するために使用されます。リソースを使用して、プランへの新規参加者の割当をリクエストしたり、既存の参加者割当を編集したり、プランに割り当てられた参加者を削除したりできます。リソースを使用して、以前に呼び出されたリクエストを削除することもできます。リクエストを作成したら、適用する給与プランのデプロイ・プロセスを実行する必要があります。この変更は適用されると、割当リソースに表示されます。

ソースを表示

Array of: object compensationPlans-CompensationPlanDirectAssignmentRequests-item-response

{
    "title":"Direct Assignment Requests",
    "type":"array",
    "description":"The direct assignment requests resource is used to view, create, and delete direct participant assignment requests. The resource can be used to request a new participant to be assigned to a plan, edit an existing participant assignment, or delete a participant assigned to a plan. The resource can also be used to delete a previously raised request. Once a request is created, the user must run the Deploy Compensation Plans process for it to apply. Once applied, this change can be seen in the Assignments resource.",
    "items":{
        "$ref":"#/components/schemas/compensationPlans-CompensationPlanDirectAssignmentRequests-item-response"
    }
}

ネストされたスキーマ : 報酬プラン - ロール

タイプ: array

タイトル: Compensation Plan - Roles

ロール・リソースは、報酬プランへのロールの割当を作成、更新または削除するために使用されます。報酬プランに割り当てられたロールのすべての詳細を表示するためにも使用されます。ロール・リソースは、インセンティブ報酬ロールを報酬プランにリンクし、このレベルで追加詳細を提供します。このレコードを作成する前に、ロールが存在している必要があります。このサービスを使用して報酬プランにロールを割り当てることができるのは、プラン管理者のみです。

ソースを表示

Array of: object compensationPlans-CompensationPlanRoles-item-response

{
    "title":"Compensation Plan - Roles",
    "type":"array",
    "description":"The roles resource is used to create, update, or delete the assignment of a role to a compensation plan. It is also be used to display all the details of roles assigned to a compensation plan. A roles resource links the Incentive Compensation role to a compensation plan and provides additional details at this level. A role needs to exist before creating this record. Only the plan administrator can assign a role to the compensation plan using this service.",
    "items":{
        "$ref":"#/components/schemas/compensationPlans-CompensationPlanRoles-item-response"
    }
}

ネストされたスキーマ : 報酬プラン - 付加フレックスフィールド

タイプ: array

タイトル: Compensation Plan - Descriptive Flex Fields

付加フレックス・フィールド・リソースは、報酬プランのユーザー定義値を格納するために使用されます。新しいAPI名を定義するには、Setup and Maintenance(設定および保守)に移動し、Manage Descriptive Flex Fields(付加フレックスフィールドの管理)タスクを開きます。

ソースを表示

Array of: object compensationPlans-compensationPlansDFF-item-response

{
    "title":"Compensation Plan - Descriptive Flex Fields",
    "type":"array",
    "description":"The descriptive flex fields resource is used to store user defined values for the compensation plan. A new API name can be defined by going to Setup and Maintenance and opening the Manage Descriptive Flex Fields task.",
    "items":{
        "$ref":"#/components/schemas/compensationPlans-compensationPlansDFF-item-response"
    },
    "x-cardinality":"1"
}

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

タイプ: array

タイトル: Links

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

ソースを表示

Array of: object link

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

ネストされたスキーマ : compensationPlans-CompensationPlanAssignments-item-response

タイプ: object

ソースを表示

AcceptanceStatus: string

タイトル: Acceptance Status

最大長: 30

デフォルト値: ACCEPTED

公開済関係者報酬プラン文書のステータス。受理可能な値のリストが参照CN_SRP_APPR_STATUSに定義されています。設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューします。受入ステータスは、ビジネス・ユニットのプラン承認および受入ワークフロー使用可能属性がいいえに設定されている場合、更新できます。設定およびメンテナンスのパラメータの管理タスクを使用して、属性値をレビューおよび更新します。
AnalystId: integer (int64)

タイトル: Analyst

読取り専用: true

関係者に割り当てられたアナリストの一意の識別子。
AnalystName: string

タイトル: Name

読取り専用: true

最大長: 360

関係者に割り当てられたアナリストの名前。
AssignmentType: string

タイトル: Assignment Type

最大長: 30

参加者が報酬プランに直接割り当てられるか、ロールを介して割り当てられるかなど、アサイメントのタイプ。許容可能な値のリストは、参照CN_PARTICIPANT_PLN_ASSIGN_TYPEで定義されます。設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
CompensationPlanId: integer (int64)

タイトル: Compensation Plan

基本報酬プランの一意の識別子です。
CreatedBy: string

読取り専用: true

最大長: 64

報酬プラン割当を作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

報酬プラン割当が作成された日時。
EndDate: 文字列(日付)

タイトル: End Date

報酬プラン割当が非アクティブになる日付。
LastUpdateDate: string (date-time)

読取り専用: true

報酬プラン割当が最後に更新された日時。
LastUpdatedBy: string

読取り専用: true

最大長: 64

報酬プラン割当を最後に更新したユーザー。
LastUpdateLogin: string

読取り専用: true

最大長: 32

レコードを最後に更新したユーザーのログイン詳細。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
ParticipantId: integer (int64)

タイトル: Participant Name

関係者の一意の識別子。
ParticipantName: string

タイトル: Name

読取り専用: true

最大長: 360

参加者の名前。
ParticipantPlanNumber: string

タイトル: Participant Plan Number

最大長: 30

参加者プランの代替キー識別子。
ParticipantType: string

タイトル: Type

読取り専用: true

最大長: 60

デフォルト値: PARTICIPANT

参加者のタイプ。この属性は、参加者が管理者であるか、ツールの更新を担当しているか、営業チーム・メンバーであり、販売実績を取得できるかを示します。取り得る値は、管理者の場合はANALYST、営業チーム・メンバーの場合はPARTICIPANTです。受理可能な値のリストは、参照CN_PARTICIPANT_TYPEで定義されます。設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
PersonNumber: string

タイトル: Person Number

読取り専用: true

最大長: 30

企業との関係に関係なく、アプリケーション内の個人を一意に識別するFusion HCM固有の識別子。国別識別子コンポーネントとの関連はありません。
RoleId: integer (int64)

タイトル: Name

読取り専用: true

インセンティブ報酬ロールの一意の識別子。
RoleName: string

タイトル: Name

読取り専用: true

最大長: 60

インセンティブ報酬ロールの名前。
SrpCompPlanId: integer (int64)

報酬プランの一意の識別子。
StartDate: 文字列(日付)

タイトル: Start Date

報酬プラン割当がアクティブになる日付。
ViewPlanDocument: 文字列(バイト)

読取り専用: true

プラン文書へのリンク。プラン文書には、関係者に割り当てられた報酬プランに関する詳細が含まれています。これは、設定およびメンテナンスのパラメータの管理タスクを使用してプラン承認機能が有効になっている場合にのみ使用できます。参加者のプランが承認のために送信されると、プラン文書が生成されます。

{
    "type":"object",
    "properties":{
        "PersonNumber":{
            "title":"Person Number",
            "maxLength":30,
            "type":"string",
            "description":"The Fusion HCM specific identifier that uniquely identifies a person in the application, regardless of their relationship to the enterprise. It does not have any relation to any national identifier component.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the compensation plan assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the compensation plan assignment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcceptanceStatus":{
            "title":"Acceptance Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the published participant compensation plan document. A list of acceptable values is defined for the lookup CN_SRP_APPR_STATUS. Review the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. The acceptance status can be updated when the Enable Plan Approval and Acceptance Workflow attribute are set to the No for the business unit. Review and update the attribute value using the Setup and Maintenance, Manage Parameters task.",
            "nullable":false,
            "default":"ACCEPTED",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the compensation plan assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SrpCompPlanId":{
            "type":"integer",
            "description":"The unique identifier of the compensation plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CompensationPlanId":{
            "title":"Compensation Plan",
            "type":"integer",
            "description":"The unique identifier of the base compensation plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParticipantName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the participant.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleId":{
            "title":"Name",
            "type":"integer",
            "description":"The unique identifier of a incentive compensation role.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the compensation plan assignment becomes inactive.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AnalystName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the analyst assigned to a participant.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ViewPlanDocument":{
            "type":"string",
            "description":"The link to the plan document. The plan document contains details about the compensation plan assigned to the participant. It is only available if the plan approval feature has been enabled using the Setup and Maintenance, Manage Parameters task. The plan document gets generated once the participant's plan is submitted for approval.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ParticipantId":{
            "title":"Participant Name",
            "type":"integer",
            "description":"The unique identifier of the participant.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the compensation plan assignment becomes active.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "RoleName":{
            "title":"Name",
            "maxLength":60,
            "type":"string",
            "description":"The name of the incentive compensation role.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AnalystId":{
            "title":"Analyst",
            "type":"integer",
            "description":"The unique identifier of the analyst assigned to a participant.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssignmentType":{
            "title":"Assignment Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the assignment, for example whether a participant is assigned to a compensation plan directly or through a role. A list of acceptable values is defined in the lookup CN_PARTICIPANT_PLN_ASSIGN_TYPE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParticipantType":{
            "title":"Type",
            "maxLength":60,
            "type":"string",
            "description":"The type of the participant. This attribute indicates whether the participant is an administrator, responsible for updating tools, or a sales team member, capable of getting a sales credit. Possible values include ANALYST for an Administrator, and PARTICIPANT for a Sales Team member. A list of acceptable values is defined in the lookup CN_PARTICIPANT_TYPE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "readOnly":true,
            "default":"PARTICIPANT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ParticipantPlanNumber":{
            "title":"Participant Plan Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the participant plan.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the compensation plan assignment was 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"
    }
}

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

タイプ: 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."
        }
    }
}

ネストされたスキーマ : compensationPlans-CompensationPlanComponents-item-response

タイプ: object

ソースを表示

CalculateIncentive: string

タイトル: Calculate Incentive

読取り専用: true

最大長: 30

プラン・コンポーネントの支給計算の性質がイベントごとか間隔ごとかを示します。指定可能な値には、間隔ごとにBONUS、イベントごとにCOMMISSIONがあります。これは、プラン・コンポーネントの作成後は更新できません。許容可能な値のリストは、参照CN_PLAN_INCENTIVE_TYPEで定義されます。設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
CalculationPhase: 整数(int32)

タイトル: Calculation Phase

読取り専用: true

アプリケーションでプラン・コンポーネントが計算対象とみなされるフェーズ。サポートされている2つのフェーズ: フェーズ1およびフェーズ2。取り得る値は1と2です。デフォルト値は、1です。許容可能な値のリストは、参照CN_CALCULATION_PHASEで定義されます。設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
CalculationSequence: integer (int64)

タイトル: Calculation Sequence

デフォルト値: 1

報酬プラン内のプラン・コンポーネントが計算エンジンによって考慮される順序を示します。デフォルト値は、1です。
CompensationPlanComponentId: integer (int64)

報酬プランに関連付けられたプラン・コンポーネントの一意の識別子です。
CompensationPlanId: integer (int64)

タイトル: Compensation Plan ID

報酬プランの一意の識別子です。
CompensationPlanName: string

タイトル: Compensation Plan Name

読取り専用: true

最大長: 80

報酬プランの名前。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

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

タイトル: Creation Date

読取り専用: true

レコードが作成された日時。
EndDate: 文字列(日付)

タイトル: End Date

報酬プランに関連付けられたプラン・コンポーネントが非アクティブになる日時。このフィールドは必須です。許容可能な書式はyyyy-mm-ddです。日付を割り当てた後は、NULLに更新できません。
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

リソース・インスタンスに関連付けられたリンク関係。
PlanComponentId: integer (int64)

タイトル: Plan Component ID

プラン・コンポーネントの一意の識別子。
PlanComponentName: string

タイトル: Plan Component Name

読取り専用: true

最大長: 80

プラン・コンポーネントの名前。
PlanComponentValidForCalculation: string

タイトル: Valid for Calculation

読取り専用: true

最大長: 30

デフォルト値: INCOMPLETE

プラン・コンポーネントの計算準備が完了しているかどうかを示します。可能な値には、プラン・コンポーネントが有効で計算の準備ができている場合はCOMPLETE、計算の準備ができていない場合はINCOMPLETEが含まれます。デフォルト値はINCOMPLETEです。許容可能な値のリストは、参照CN_FORMULA_STATUSで定義されます。設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
StartDate: 文字列(日付)

タイトル: Start Date

報酬プランに関連付けられたプラン・コンポーネントがアクティブになる日時。このフィールドは必須です。許容可能な書式はyyyy-mm-ddです。日付を割り当てた後は、NULLに更新できません。
TargetIncentiveAmount: number

タイトル: Target Incentive Amount

読取り専用: true

デフォルト値: 100

加重と報酬プラン・ターゲット・インセンティブを乗算して導出された各プラン・コンポーネントの金額。
TargetIncentivePercent: number

タイトル: Target Incentive Percent

デフォルト値: 100

プラン・コンポーネントが報酬プランに与える影響のパーセント。デフォルト値は100です。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "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
        },
        "TargetIncentivePercent":{
            "title":"Target Incentive Percent",
            "type":"number",
            "description":"The percentage of influence a plan component has on the compensation plan. The default value is 100.",
            "nullable":true,
            "default":100,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CompensationPlanId":{
            "title":"Compensation Plan ID",
            "type":"integer",
            "description":"The unique identifier for a compensation plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CompensationPlanName":{
            "title":"Compensation Plan Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of the compensation plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CalculateIncentive":{
            "title":"Calculate Incentive",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the nature of plan component earning calculation is per event or per interval. Possible values include BONUS for per interval, and COMMISSION for per event. This cannot be updated once the plan component has been created.  A list of acceptable values is defined in the lookup CN_PLAN_INCENTIVE_TYPE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"default"
            },
            "x-queryable":true
        },
        "PlanComponentId":{
            "title":"Plan Component ID",
            "type":"integer",
            "description":"The unique identifier of a plan component.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date and time when the plan component associated with a compensation plan becomes inactive. This field is mandatory. The acceptable format is yyyy-mm-dd. Once a date is assigned, it cannot be updated to null.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "CalculationSequence":{
            "title":"Calculation Sequence",
            "type":"integer",
            "description":"Indicates the order in which the calculation engine considers the plan component within a compensation plan. The default value is 1.",
            "format":"int64",
            "nullable":true,
            "default":1,
            "x-hints":{
                "controlType":"default",
                "precision":18
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date and time when the plan component associated with a compensation plan becomes active. This field is mandatory. The acceptable format is yyyy-mm-dd. Once a date is assigned, it cannot be updated to null.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "CompensationPlanComponentId":{
            "type":"integer",
            "description":"The unique identifier for a plan component associated with a compensation plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CalculationPhase":{
            "title":"Calculation Phase",
            "type":"integer",
            "description":"The phase in which the application considers plan component for calculation. Two supported phases: Phase 1 and Phase 2. Possible values include 1 and 2. The default value is 1. A list of acceptable values is defined in the lookup CN_CALCULATION_PHASE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"default",
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PlanComponentName":{
            "title":"Plan Component Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of a plan component.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanComponentValidForCalculation":{
            "title":"Valid for Calculation",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the plan component is ready for calculation. Possible values include COMPLETE when the plan component is valid and ready for calculation, and INCOMPLETE when the plan component is not valid and not ready for calculation. The default value is INCOMPLETE.  A list of acceptable values is defined in the lookup CN_FORMULA_STATUS. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "readOnly":true,
            "default":"INCOMPLETE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TargetIncentiveAmount":{
            "title":"Target Incentive Amount",
            "type":"number",
            "description":"The amount for each plan component derived by multiplying the weight with the compensation plan target incentive.",
            "nullable":true,
            "readOnly":true,
            "default":100,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The session login associated to the user who last updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The date when the record was last updated.",
            "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"
    }
}

ネストされたスキーマ : compensationPlans-CompensationPlanDirectAssignmentRequests-item-response

タイプ: object

ソースを表示

CompensationPlanId: integer (int64)

基本報酬プランの一意の識別子です。
CreatedBy: string

読取り専用: true

最大長: 64

直接割当リクエストを作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

直接割当リクエストが作成された日時。
EndDate: 文字列(日付)

直接割当リクエストが非アクティブになる日付。
ErrorReason: string

最大長: 240

報酬プランのデプロイ・プロセスがリクエストを否認した事由です。レコードが処理されている場合、この属性は移入されません。
LastUpdateDate: string (date-time)

読取り専用: true

直接割当リクエストが最後に更新された日時。
LastUpdatedBy: string

読取り専用: true

最大長: 64

直接割当リクエストを最後に更新したユーザー。
LastUpdateLogin: string

読取り専用: true

最大長: 32

レコードを最後に更新したユーザーのログイン詳細。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
ParticipantId: integer (int64)

関係者の一意の識別子。
ParticipantName: string

タイトル: Name

読取り専用: true

最大長: 360

参加者の名前。
ParticipantPlanNumber: string

読取り専用: true

最大長: 30

参加者プランの代替キー識別子。
PlanDirectAssignmentRequestId: integer (int64)

読取り専用: true

直接割当リクエストの一意の識別子。
ProcessingStatus: string

読取り専用: true

リクエストの作成、リクエストの作成完了、リクエストの作成失敗、リクエストの編集、リクエストの更新完了、リクエストの更新失敗、リクエストの削除、リクエストの削除完了またはリクエストの削除失敗など、リクエストのステージを指定する参加者直接割当リクエストの処理ステータス。許容可能な値のリストは、参照ORA_CN_PRT_DRCT_ASGN_RQ_STATUSで定義されます。設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
ProcessRequestId: integer (int64)

読取り専用: true

リクエストを選択した報酬プランのデプロイ・プロセスのリクエストの一意の識別子。
RequestCreateFlag: boolean

直接割当リクエストを作成する必要があるかどうかを示します。
RequestDeleteFlag: boolean

直接割当リクエストを削除する必要があるかどうかを示します。フラグがYに設定されていて、削除が機能しない場合は、フラグをTrueに設定する必要があります。
RequestEditFlag: boolean

直接割当リクエストを編集する必要があるかどうかを示します。
SrpCompPlanId: integer (int64)

報酬プランの一意の識別子。
StartDate: 文字列(日付)

直接割当リクエストがアクティブになる日付。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the direct assignment request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the direct assignment request was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanDirectAssignmentRequestId":{
            "type":"integer",
            "description":"The unique identifier of the direct assignment request.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the direct assignment request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SrpCompPlanId":{
            "type":"integer",
            "description":"The unique identifier of the compensation plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "CompensationPlanId":{
            "type":"integer",
            "description":"The unique identifier of the base compensation plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequestCreateFlag":{
            "type":"boolean",
            "description":"Indicates whether a direct assignment request should be created.",
            "nullable":true,
            "x-queryable":false
        },
        "RequestDeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether a direct assignment request should be deleted. If the flag is set Y and the delete does not work, then you must set the flag to True.",
            "nullable":true,
            "x-queryable":false
        },
        "ProcessRequestId":{
            "type":"integer",
            "description":"The unique identifier of the request of the Deploy Compensation Plan process that picked up the request.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ErrorReason":{
            "maxLength":240,
            "type":"string",
            "description":"The reason why Deploy Compensation Plans process rejected the request. This attribute is not populated if the record has been processed.",
            "nullable":true,
            "x-queryable":true
        },
        "ParticipantName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the participant.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"The date when the direct assignment request becomes inactive.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ParticipantId":{
            "type":"integer",
            "description":"The unique identifier of the participant.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            },
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The date when the direct assignment request becomes active.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParticipantPlanNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the participant plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessingStatus":{
            "type":"string",
            "description":"The processing status of the participant direct assignment request specifying the stage the request is in, such as Create requested, Create request completed, Create request failed, Edit requested, Update request completed, Update request failed, Delete requested, Delete request completed, or Delete request failed. A list of acceptable values is defined in the lookup ORA_CN_PRT_DRCT_ASGN_RQ_STATUS. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the direct assignment request was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestEditFlag":{
            "type":"boolean",
            "description":"Indicates whether a direct assignment request should be edited.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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

タイプ: array

タイトル: Links

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

ソースを表示

Array of: object link

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

ネストされたスキーマ : compensationPlans-CompensationPlanRoles-item-response

タイプ: object

ソースを表示

CompensationPlanId: integer (int64)

報酬プランの一意の識別子です。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

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

タイトル: Creation Date

読取り専用: true

レコードが作成された日時。
EndDate: 文字列(日付)

タイトル: End Date

報酬プランのロール割当が非アクティブになる日付。許容可能な書式はyyyy-mm-ddです。日付を割り当てた後は、NULLに更新できません。
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

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

タイトル: Role Description

読取り専用: true

最大長: 120

ロールの作成時にユーザーが入力したロールの説明。
RoleId: integer (int64)

ロールの一意の識別子。
RoleName: string

タイトル: Role Name

読取り専用: true

最大長: 60

ロールの名前。
RolePlanId: integer (int64)

プランに関連付けられたロールの一意の識別子。
StartDate: 文字列(日付)

タイトル: Start Date

報酬プランのロール割当がアクティブになる日付。許容可能な書式はyyyy-mm-ddです。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "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
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CompensationPlanId":{
            "type":"integer",
            "description":"The unique identifier for a compensation plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RoleDescription":{
            "title":"Role Description",
            "maxLength":120,
            "type":"string",
            "description":"The description of the role entered by the user while creating the role.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleId":{
            "type":"integer",
            "description":"The unique identifier for a role.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the role assignment in a compensation plan becomes inactive. The acceptable format is yyyy-mm-dd. Once a date has been assigned, it cannot be updated to null.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "RolePlanId":{
            "type":"integer",
            "description":"The unique identifier for the role associated with a plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the role assignment in a compensation plan becomes active. The acceptable format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "RoleName":{
            "title":"Role Name",
            "maxLength":60,
            "type":"string",
            "description":"The name of the role.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login associated to the user who last updated the record.",
            "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
        }
    }
}

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

タイプ: array

タイトル: Links

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

ソースを表示

Array of: object link

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

ネストされたスキーマ : compensationPlans-compensationPlansDFF-item-response

タイプ: object

ソースを表示

__FLEX_Context: string

タイトル: Context Segment

最大長: 30

報酬プランのフレックス・コンテキスト・セグメント・コード。どのコンテキスト依存セグメントを表示するかを決定します。
__FLEX_Context_DisplayValue: string

タイトル: Context Segment

報酬プランのフレックス・コンテキスト・セグメント表示名。どのコンテキスト依存セグメントを表示するかを決定します。
CompPlanId: integer (int64)

報酬プランの一意の識別子。
links: array Links

タイトル: Links

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

{
    "type":"object",
    "properties":{
        "CompPlanId":{
            "type":"integer",
            "description":"The unique identifier of the compensation plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"The flex context segment display name for the compensation plan. It determines which context-sensitive segments are displayed.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"The flex context segment code for the compensation plan. It determines which context-sensitive segments are displayed.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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"
    }
}

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、すべての報酬プランを取得する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/compensationPlans

レスポンス本文の例

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

{
  "items": [
    {
      "ApprovalStatus": "APPROVED",
      "ValidForCalculation": "INCOMPLETE",
      "OrgId": 204,
      "StartDate": "2009-01-01",
      "EndDate": "2013-12-31",
      "TargetIncentive": 100000,
      "AllowCreditCategoryOverlapFlag": true,
      "Description": "Compensation Plan for sales managers.",
      "LastUpdateDate": "2017-06-28T06:44:24.618-07:00",
      "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
      "CreationDate": "2009-12-11T05:29:17.282-08:00",
      "CreatedBy": "OPERATIONS",
      "LastUpdateLogin": "52EF522BC19043E6E0532DD6F00A0443",
      "DisplayName": "US Manager Compensation Plan",
      "CompensationPlanId": 100000015115289,
      "PlanDocumentTemplate": "Participant Plan Template",
      "Name": "US Manager Compensation Plan",
      "InvalidReason": "The plan component US Manager Compensation Plan associated with this compensation plan is not valid for calculation. (CN-1575360) Details: Make the plan component valid or associate a valid plan component with this compensation plan to make it valid.",
      "links": [
       ...
      ]
    },
    {
      "ApprovalStatus": "APPROVED",
      "ValidForCalculation": "COMPLETE",
      "OrgId": 204,
      "StartDate": "2012-01-01",
      "EndDate": "2012-12-31",
      "TargetIncentive": 12000,
      "AllowCreditCategoryOverlapFlag": false,
      "Description": null,
      "LastUpdateDate": "2017-05-04T10:51:36.701-07:00",
      "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
      "CreationDate": "2011-12-01T19:48:27-08:00",
      "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
      "LastUpdateLogin": "4EB5ECE12FCF263CE0532DD6F00A9F25",
      "DisplayName": "QA My Team CP",
      "CompensationPlanId": 300100003411846,
      "PlanDocumentTemplate": null,
      "Name": "QA My Team CP",
      "InvalidReason": null,
      "links": [
        ...
      ]
    },
 ...
  ]
}

「トップに戻る」