1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Plan Components
  4. Plan Component - Performance Measures

Get all performance measures

get

/fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentPerformanceMeasures

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key--- PlanComponentId and OrgId ---for the Plan Components resource and used to uniquely identify an instance of Plan Components. The client should not generate the hash key value. Instead, the client should query on the Plan Components collection resource with a filter on the primary key values in order to navigate to a specific instance of Plan Components.

    For example: planComponents?q=PlanComponentId=<value1>;OrgId=<value2>
Query Parameters
  • 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>
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds a resource with the specified primary key.
      Finder Variables:
      • PlanComponentPerformanceMeasureId; integer; The unique identifier for the performance measure record associated with the plan component.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • CalculationSequence; integer; The order in which the calculation engine considers a performance measure within a plan component. This is set when dependent measures refer to the calculated results of other base measures. Dependent measures must have a higher calculation sequence than base measures.
    • CreatedBy; string; The user who created the record.
    • CreationDate; string; The date and time when the record was created.
    • EarningBasis; string; Specifies whether attainment and earnings calculations use the same credit categories and whether the incentive formula uses the measure attainment in calculations. Possible values include Y, N. Keep it Y, references the performance measure attainment in the incentive formula expression of the plan component. Earning basis must be Y when a performance measure that processes transactions individually is associated with plan components that calculate incentive per event. A list of acceptable values is defined in the lookup CN_YES_NO. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
    • EndDate; string; The date when the performance measure associated with the performance measure becomes inactive. This is a read only field. The performance measure takes the date of the plan component. The format is yyyy-mm-dd.
    • LastUpdateDate; string; The date and time when the record was last updated.
    • LastUpdateLogin; string; The session login of the user who last updated the record.
    • LastUpdatedBy; string; The user who last updated the record.
    • PerformanceInterval; string; This is the interval value for the performance measurement. Where running total is considered, the accumulated value is reset based on this interval value. Interval would represent a unit of time like month, quarter, year. The default value is '-1000'.
    • PerformanceMeasureId; integer; The unique identifier of a performance measure record.
    • PerformanceMeasureName; string; The name of a performance measure, which is an indicator used to measure the progress toward a specified outcome or goal.
    • PerformanceMeasureWeight; integer; The percentage of influence a performance measure has on the plan component.
    • PlanComponentId; integer; The unique identifier of the plan component record within a business unit.
    • PlanComponentName; string; The name of a plan component, which defines the earnings of a participant based on their performance.
    • PlanComponentPerformanceMeasureId; integer; The unique identifier for the performance measure record associated with the plan component.
    • ProcessTransactions; string; Indicates how the application processes transactions in a measure. The possible values include GROUP for Group transactions for the specified interval, for attainment calculation and INDIVIDUAL for evaluating each transaction independently, for attainment calculation. A list of acceptable values is defined in the lookup CN_PROCESS_TXN. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
    • StartDate; string; The date when the performance measure associated with the performance measure becomes active. This is a read only field. The performance measure takes the date of the plan component. The format is yyyy-mm-dd.
    • UnitOfMeasure; string; The standardized quantity used as a factor to express occurring quantities of the performance measure property. Possible values include AMOUNT for measure attainment is based on an amount, PERCENT for measure attainment is based on a percent, QUANTITY for measure attainment is based on a quantity, and SCORE for measure attainment is based on a score. The default value is AMOUNT. A list of acceptable values is defined in the lookup CN_MEASURE_UOM. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
    • ValidForCalculation; string; Indicates whether the performance measure is ready for calculation. Possible values include COMPLETE for valid and ready for calculation and INCOMPLETE for invalid and not ready for calculation. 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.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : planComponents-planComponentPerformanceMeasures
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : planComponents-planComponentPerformanceMeasures-item-response
Type: object
Show Source
  • Title: Calculation Sequence
    Default Value: 1
    The order in which the calculation engine considers a performance measure within a plan component. This is set when dependent measures refer to the calculated results of other base measures. Dependent measures must have a higher calculation sequence than base measures.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Title: Creation Date
    Read Only: true
    The date and time when the record was created.
  • Title: Earning Basis
    Maximum Length: 1
    Default Value: Y
    Specifies whether attainment and earnings calculations use the same credit categories and whether the incentive formula uses the measure attainment in calculations. Possible values include Y, N. Keep it Y, references the performance measure attainment in the incentive formula expression of the plan component. Earning basis must be Y when a performance measure that processes transactions individually is associated with plan components that calculate incentive per event. A list of acceptable values is defined in the lookup CN_YES_NO. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
  • Title: End Date
    Read Only: true
    The date when the performance measure associated with the performance measure becomes inactive. This is a read only field. The performance measure takes the date of the plan component. The format is yyyy-mm-dd.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The session login of the user who last updated the record.
  • Links
  • Title: Performance Interval
    Read Only: true
    Default Value: -1000
    This is the interval value for the performance measurement. Where running total is considered, the accumulated value is reset based on this interval value. Interval would represent a unit of time like month, quarter, year. The default value is '-1000'.
  • Title: Performance Measure ID
    The unique identifier of a performance measure record.
  • Title: Performance Measure Name
    Read Only: true
    Maximum Length: 80
    The name of a performance measure, which is an indicator used to measure the progress toward a specified outcome or goal.
  • Title: Weight
    Default Value: 100
    The percentage of influence a performance measure has on the plan component.
  • Title: Plan Component ID
    The unique identifier of the plan component record within a business unit.
  • Title: Plan Component Name
    Read Only: true
    Maximum Length: 80
    The name of a plan component, which defines the earnings of a participant based on their performance.
  • The unique identifier for the performance measure record associated with the plan component.
  • Title: Process Transactions
    Read Only: true
    Maximum Length: 30
    Indicates how the application processes transactions in a measure. The possible values include GROUP for Group transactions for the specified interval, for attainment calculation and INDIVIDUAL for evaluating each transaction independently, for attainment calculation. A list of acceptable values is defined in the lookup CN_PROCESS_TXN. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
  • Title: Start Date
    Read Only: true
    The date when the performance measure associated with the performance measure becomes active. This is a read only field. The performance measure takes the date of the plan component. The format is yyyy-mm-dd.
  • Title: Unit of Measure
    Read Only: true
    Maximum Length: 30
    Default Value: AMOUNT
    The standardized quantity used as a factor to express occurring quantities of the performance measure property. Possible values include AMOUNT for measure attainment is based on an amount, PERCENT for measure attainment is based on a percent, QUANTITY for measure attainment is based on a quantity, and SCORE for measure attainment is based on a score. The default value is AMOUNT. A list of acceptable values is defined in the lookup CN_MEASURE_UOM. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
  • Title: Valid for Calculation
    Read Only: true
    Maximum Length: 30
    Default Value: INCOMPLETE
    Indicates whether the performance measure is ready for calculation. Possible values include COMPLETE for valid and ready for calculation and INCOMPLETE for invalid and not ready for calculation. 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.
Back to Top

Examples

The following example shows how to get all performance measures by submitting a GET request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/planComponents/00020000000EACED00057708000110F07F4ABECA0000000EACED0005770800000000000000CC/child/planComponentPerformanceMeasures

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
"items": [
  {
"PlanComponentPerformanceMeasureId": 300100090511057,
"CalculationSequence": 1,
"PerformanceMeasureWeight": 90,
"PerformanceMeasureId": 300100090511017,
"PerformanceMeasureName": "Sales Attainment 2016",
"StartDate": "2016-01-01",
"EndDate": "2016-12-31",
"EarningBasis": "Y",
"PlanComponentName": "Sales Plan Bonus",
"UnitOfMeasure": "AMOUNT",
"ValidForCalculation": "COMPLETE",
"ProcessTransactions": "INDIVIDUAL",
"CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
"CreationDate": "2017-06-08T23:07:22-07:00",
"LastUpdateDate": "2017-06-08T23:22:52.055-07:00",
"LastUpdateLogin": "517961123F1147A9E0532DD6F00A9182",
"LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
"PerformanceInterval": "-1000",
"PlanComponentId": 300100090511050,
"links": 	[
 ...
],
}
,
..]
}
Back to Top