Jump to

• Request
• Response
• Examples

Get a rate dimensional input

get

/fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureRateDimensionalInputs/{PerformanceMeasureInputExpressionId}

Request

Path Parameters

• PerformanceMeasureId(required): integer(int64)
  The unique identifier for the performance measure.
• PerformanceMeasureInputExpressionId(required): integer(int64)
  The unique identifier for the input expression to the rate dimension of the scorecard used in the performance measure.

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 : incentiveCompensationPerformanceMeasures-performanceMeasureRateDimensionalInputs-item-response

Type: object

Show Source

• AccumulateFlag: boolean
  Title: Accumulate

  Maximum Length: 1

  Default Value: false

  Indicates which rate dimension input expression (rate dimension) does running total apply to, when using running total for a scorecard with multiple dimensions. Possible values include FALSE and TRUE. The default value is FALSE.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  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.
• InputExpressionDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 1000

  The rate dimensional input expression description entered while creating the expression.
• InputExpressionId: integer (int64)
  Title: Input Expression ID

  The unique identifier for the input expression record for a business unit. This represents the input expression to the rate dimension of the scorecard used in the performance measure.
• InputExpressionName: string
  Title: Input Expression Name

  Maximum Length: 160

  The name for the input expression to the rate dimension of the scorecard used in the performance measure.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

  Maximum Length: 32

  The session login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PerformanceMeasureId: integer (int64)
  Title: Performance Measure ID

  The unique identifier for a performance measure record.
• PerformanceMeasureInputExpressionId: integer (int64)
  Title: Performance Measure Input Expression Id

  The unique identifier for the input expression to the rate dimension of the scorecard used in the performance measure.
• PerformanceMeasureRateDimensionalInputsDeleteFlag: boolean
  Read Only: true

  Default Value: false

  Inidcates whether a rate dimensional input can be deleted.
• RateDimName: integer
  Title: Dimension Name

  Read Only: true

  The name of the rate dimension. A scorecard can have one or more rate dimensions.
• RateDimSequence: integer (int64)
  Title: Rate Dimension Sequence

  The order of a rate dimension within a scorecard.
• SplitFlag: boolean
  Title: Apply split

  Maximum Length: 1

  Default Value: false

  Indicates whether the split option can apply to only one rate dimension input expression when splitting the rate across tiers. This informs which rate dimension input expression (rate dimension) to use. Possible values include FALSE and TRUE. The default value is FALSE.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who last updated this record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InputExpressionDescription":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The rate dimensional input expression description entered  while creating the expression.",
            "nullable":true,
            "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":"255",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SplitFlag":{
            "title":"Apply split",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the split option can apply to only one rate dimension input expression when splitting the rate across tiers. This informs which rate dimension input expression (rate dimension) to use. Possible values include FALSE and TRUE. The default value is FALSE.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "PerformanceMeasureRateDimensionalInputsDeleteFlag":{
            "type":"boolean",
            "description":"Inidcates whether a rate dimensional input can be deleted.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "PerformanceMeasureId":{
            "title":"Performance Measure ID",
            "type":"integer",
            "description":"The unique identifier for a performance measure record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AccumulateFlag":{
            "title":"Accumulate",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates which rate dimension input expression (rate dimension) does running total apply to, when using running total for a scorecard with multiple dimensions. Possible values include FALSE and TRUE. The default value is FALSE.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "PerformanceMeasureInputExpressionId":{
            "title":"Performance Measure Input Expression Id",
            "type":"integer",
            "description":"The unique identifier for the input expression to the rate dimension of the scorecard used in the performance measure.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RateDimName":{
            "title":"Dimension Name",
            "type":"integer",
            "description":"The name of the rate dimension. A scorecard can have one or more rate dimensions.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InputExpressionName":{
            "title":"Input Expression Name",
            "maxLength":"160",
            "type":"string",
            "description":"The name for the input expression to the rate dimension of the scorecard used in the performance measure.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "InputExpressionId":{
            "title":"Input Expression ID",
            "type":"integer",
            "description":"The unique identifier for the input expression record for a business unit. This represents the input expression to the rate dimension of the scorecard used in the performance measure.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RateDimSequence":{
            "title":"Rate Dimension Sequence",
            "type":"integer",
            "description":"The order of a rate dimension within a scorecard.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "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 of the user who last updated the record.",
            "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

ExpressionUsagesVO

Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionUsagesLOV

The list of values containing the names for the input expressions of the rate dimension of the scorecard used in the performance measure.

The following properties are defined on the LOV link relation:

• Source Attribute: InputExpressionName; Target Attribute: ExpressionName
• Display Attribute: ExpressionName, Description

RateDimensionsVO

Operation: /fscmRestApi/resources/11.13.18.05/rateDimensions

The list of values containing the names of the rate dimensions. A scorecard can have one or more rate dimensions.

The following properties are defined on the LOV link relation:

• Source Attribute: RateDimName; Target Attribute: RateDimSequence
• Display Attribute: RateDimensionName

Back to Top

Examples

The following example shows how to get a rate dimensional input expression 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/incentiveCompensationPerformanceMeasures/300100090511017/child/performanceMeasureRateDimensionalInputs/300100090511045

Example of Response Body

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

{
  "PerformanceMeasureInputExpressionId": 300100090511045,
  "PerformanceMeasureId": 300100090511017,
  "InputExpressionId": 100000015115055,
  "RateDimSequence": 1,
  "AccumulateFlag": false,
  "SplitFlag": true,
  "InputExpressionName": null,
  "InputExpressionDescription": null,
  "RateDimName": 1,
  "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
  "CreationDate": "2017-06-08T11:37:20.012-07:00",
  "LastUpdateDate": "2017-06-08T23:13:50.895-07:00",
  "LastUpdateLogin": "517891504F9C08F9E0532DD6F00A1DF5",
  "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
  "PerformanceMeasureRateDimensionalInputsDeleteFlag": false,
  "links": [
    ...
  ]
}

Back to Top