Jump to

• Request
• Response

Get a plan component

get

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

Request

Path Parameters

• CompensationPlanComponentId(required): integer(int64)
  The unique identifier for a plan component associated with a compensation plan.
• CompensationPlanId(required): integer(int64)
  The unique identifier of the compensation plan.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : compensationPlans-CompensationPlanComponents-item-response

Type: object

Show Source

• CalculateIncentive: string
  Title: Calculate Incentive

  Read Only: true

  Maximum Length: 30

  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.
• CalculationPhase: integer (int32)
  Title: Calculation Phase

  Read Only: true

  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.
• CalculationSequence: integer (int64)
  Title: Calculation Sequence

  Default Value: 1

  Indicates the order in which the calculation engine considers the plan component within a compensation plan. The default value is 1.
• CompensationPlanComponentId: integer (int64)
  The unique identifier for a plan component associated with a compensation plan.
• CompensationPlanId: integer (int64)
  Title: Compensation Plan ID

  The unique identifier for a compensation plan.
• CompensationPlanName: string
  Title: Compensation Plan Name

  Read Only: true

  Maximum Length: 80

  The name of the compensation plan.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the record was created.
• EndDate: string (date)
  Title: End Date

  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.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The session login associated to the user who last updated the record.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The date when the record was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PlanComponentId: integer (int64)
  Title: Plan Component ID

  The unique identifier of a plan component.
• PlanComponentName: string
  Title: Plan Component Name

  Read Only: true

  Maximum Length: 80

  The name of a plan component.
• PlanComponentValidForCalculation: string
  Title: Valid for Calculation

  Read Only: true

  Maximum Length: 30

  Default Value: INCOMPLETE

  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.
• StartDate: string (date)
  Title: Start Date

  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.
• TargetIncentiveAmount: number
  Title: Target Incentive Amount

  Read Only: true

  Default Value: 100

  The amount for each plan component derived by multiplying the weight with the compensation plan target incentive.
• TargetIncentivePercent: number
  Title: Target Incentive Percent

  Default Value: 100

  The percentage of influence a plan component has on the compensation plan. The default value is 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
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: 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."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

CnLookupPlanComponentCalculateIncentiveVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DCN_PLAN_INCENTIVE_TYPE

The list of values indicating the nature of plan component earning calculation. Possible values include BONUS for per interval and COMMISSION for per event. This cannot be updated once the plan component is created.

The following properties are defined on the LOV link relation:

• Source Attribute: CalculateIncentive; Target Attribute: LookupCode
• Display Attribute: Meaning

CnLookupPlanComponentCalculationPhaseVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DCN_CALCULATION_PHASE

The list of values indicating the phase in which the application considers plan component for calculation. Two supported phases: Phase 1 and Phase 2.The default value is Phase 1.

The following properties are defined on the LOV link relation:

• Source Attribute: CalculationPhase; Target Attribute: LookupCode
• Display Attribute: Meaning

CnLookupPlanComponentValidforCalculationVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DCN_COMP_PLAN_STATUS

The list of values indicating whether the plan component is ready for calculation. Possible values include COMPLETE for valid and ready for calculation, and INCOMPLETE for not valid and not ready for calculation. The default value is INCOMPLETE.

The following properties are defined on the LOV link relation:

• Source Attribute: PlanComponentValidForCalculation; Target Attribute: LookupCode
• Display Attribute: Meaning

PlanComponentsVO

Operation: /fscmRestApi/resources/11.13.18.05/planComponents

The list of values containing the unique identifiers for plan components.

The following properties are defined on the LOV link relation:

• Source Attribute: PlanComponentId; Target Attribute: PlanComponentId
• Display Attribute: Name, StartDate, EndDate

Back to Top