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

プラン・コンポーネントの取得

get

/fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/CompensationPlanComponents/{CompensationPlanComponentId}

リクエスト

パス・パラメータ

CompensationPlanComponentId(required): integer(int64)

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

報酬プランの一意の識別子。

問合せパラメータ

dependency: string

このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。通常、これらは属性変更の影響をプレビューするために使用されます。このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。この問合せパラメータの値は、依存性フィールドのセットです。例: dependency=ProductId=2

フォーマット: <attr1>=<val1>,<attr2>=<value2>
expand: string

このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。この問合せパラメータの値は"all"または""です。カンマをセパレータとして使用して、複数の子を指定できます。例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
fields: string

このパラメータは、リソース・フィールドをフィルタします。指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。両方を指定した場合、フィールドのみが考慮されます。

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

子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
links: string

このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

例:
self,canonical
onlyData: boolean

リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。

ヘッダー・パラメータ

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-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"
    }
}

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

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

リンク

CnLookupPlanComponentCalculateIncentiveVO

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DCN_PLAN_INCENTIVE_TYPE

プラン・コンポーネントの支給計算の性質を示す値リスト。指定可能な値には、間隔ごとにBONUS、イベントごとにCOMMISSIONがあります。これは、プラン・コンポーネントの作成後は更新できません。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: CalculateIncentive;ターゲット属性: LookupCode
表示属性: 意味

CnLookupPlanComponentCalculationPhaseVO

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DCN_CALCULATION_PHASE

アプリケーションがプラン・コンポーネントを計算のために考慮するフェーズを示す値リスト。サポートされている2つのフェーズ : フェーズ1およびフェーズ2。デフォルト値はフェーズ1です。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: CalculationPhase;ターゲット属性: LookupCode
表示属性: 意味

CnLookupPlanComponentValidforCalculationVO

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DCN_COMP_PLAN_STATUS

プラン・コンポーネントを計算できるかどうかを示す値リスト。可能な値には、有効で計算の準備ができている場合はCOMPLETE、無効で計算の準備ができていない場合はINCOMPLETEがあります。デフォルト値はINCOMPLETEです。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: PlanComponentValidForCalculation;ターゲット属性: LookupCode
表示属性: 意味

PlanComponentsVO

操作: /fscmRestApi/resources/11.13.18.05/planComponents

プラン・コンポーネントの一意の識別子を含む値リスト。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: PlanComponentId;ターゲット属性: PlanComponentId
表示属性: 名前、StartDate、EndDate

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行して、プラン・コンポーネントを取得する方法を示しています。

cURLコマンド

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

レスポンス本文の例

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

{
  "PlanComponentId": 300100085059410,
  "CalculationSequence": 1,
  "TargetIncentivePercent": 90,
  "StartDate": "2016-01-01",
  "EndDate": "2016-12-31",
  "CalculationPhase": 1,
  "CalculateIncentive": "BONUS",
  "PlanComponentValidForCalculation": "COMPLETE",
  "PlanComponentName": "2016 QA calc scenario 800 PC",
  "TargetIncentiveAmount": 9000,
  "CompensationPlanComponentId": 300100090480156,
  "CompensationPlanId": 300100090306794,
  "CompensationPlanName": "Silver Inc Plan",
  "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
  "CreationDate": "2017-06-07T07:52:52-07:00",
  "LastUpdateDate": "2017-06-07T07:58:01.058-07:00",
  "LastUpdateLogin": "5160681C1C454D39E0532DD6F00A08CA",
  "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
  "links": [
   ...
  ]
}

「トップに戻る」