Jump to

• Request
• Response

Get a simulation measure result

get

/fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}/child/MeasureResults/{MeasureResultId}

Request

Path Parameters

• MeasureResultId(required): integer(int64)
  The identifier of the simulation measure result.
• SimulationId(required): integer(int64)
  The unique identifier of the calculation simulation.

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: string
  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: string
  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 : incentiveCompensationCalculationSimulations-MeasureResults-item-response

Type: object

Show Source

• CalculationCurrency: string
  Read Only: true

  Maximum Length: 15

  The calculation currency code.
• CommissionValue: number
  Read Only: true

  The rate of the rate table.
• CompensationPlanId: integer (int64)
  Read Only: true

  The unique identifier of the compensation plan for which the measure results are calculated.
• CompensationPlanName: string
  Title: Name

  Read Only: true

  Maximum Length: 80

  The name of the compensation plan for which the measure results are calculated.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the measure result record.
• CreatedDuring: string
  Read Only: true

  Maximum Length: 30

  The phase during which this record was created. The possible values are Rollup, Eligibility, Calculation.
• CreationDate: string (date-time)
  Read Only: true

  The date when the measure result record was created.
• CreditAmount: number
  Read Only: true

  The credit amount in calculation currency.
• CreditedParticipantId: integer (int64)
  Read Only: true

  The unique identifier of the participant who receives credit for the transaction.
• CreditedParticipantName: string
  Title: Participant Name

  Read Only: true

  Maximum Length: 360

  The name of the participant who receives credit for the transaction.
• CreditFactor: number
  Read Only: true

  The credit factor applied to a credit category associated with the performance measure.
• CreditId: integer (int64)
  Read Only: true

  The unique identifier of the credited transaction.
• EarningFactor: number
  Read Only: true

  The earning factor associated with the performance measure.
• EarningTypeId: integer (int64)
  Read Only: true

  The identifier of the earning type.
• EligibleCatId: integer (int64)
  Read Only: true

  The transaction credit category populated during classification.
• ErrorReason: string
  Read Only: true

  Maximum Length: 150

  The reason for error during calculation.
• EventFactorValue: number
  Read Only: true

  The event factor for a transaction type applied to a credit category associated with the performance measure.
• FormulaId: integer (int64)
  Read Only: true

  The unique identifier of the performance measure for which the measure results are calculated.
• FormulaWeight: number
  Read Only: true

  The weight of the performance measure within the plan component.
• InputAchieved: number
  Read Only: true

  The amount passed to the rate table based on the input expression defined in the performance measure.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• MeasureResultId: integer (int64)
  Read Only: true

  The identifier of the simulation measure result.
• ObjectStatus: string
  Read Only: true

  Maximum Length: 30

  The current status of the measure results record, such as calculated, calculation error, eligible, or reversed.
• ObjectStatusMeaning: string
  Read Only: true

  Maximum Length: 80

  The display label for the process status lookup code.
• OrgId: integer (int64)
  Read Only: true

  The unique identifier of the business unit associated with the measure result record.
• OutputAchieved: number
  Read Only: true

  The amount calculated by the output expression of the performance measure.
• PerformanceMeasureName: string
  Title: Name

  Read Only: true

  Maximum Length: 80

  The name of the performance measure for which the measure results are calculated.
• PlanComponentId: integer (int64)
  Read Only: true

  The unique identifier of the plan component for which the measure results are calculated.
• PlanComponentName: string
  Title: Name

  Read Only: true

  Maximum Length: 80

  The name of the plan component for which the measure results are calculated.
• SimulationDeleteFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the measure result was deleted during calculation simulation processing.
• SimulationId: integer (int64)
  Read Only: true

  The identifier of the simulation to which this simulation measure result belongs.
• SimulationResultType: string
  Read Only: true

  Maximum Length: 30

  Indicates whether a measure result comes from the simulation execution or from the existing calculated measure result.
• SourceEventDate: string (date)
  Read Only: true

  The date of the simulation transaction.
• SourceEventPeriodId: integer (int64)
  Read Only: true

  The period identifier for the source event date.
• SourceTrxNumber: string
  Read Only: true

  Maximum Length: 30

  The transaction number which identifies the transaction.
• SrpCompensationPlanId: integer (int64)
  Read Only: true

  The unique identifier of the participant compensation plan assignment record.
• TierSplits: integer (int64)
  Read Only: true

  The tier of the rate table.
• TransactionAmount: number
  Read Only: true

  The transaction amount in calculation currency.
• TransactionId: integer (int64)
  Read Only: true

  The unique identifier for the transaction.
• TransactionType: string
  Read Only: true

  Maximum Length: 30

  The type of the transaction. This value indicates the source of the transaction, such as order, invoice, or credit memo. Review the available lookup codes for the lookup type CN_TP_TRANSACTION_TYPE using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• TransactionTypeMeaning: string
  Read Only: true

  Maximum Length: 80

  The display label for the Transaction Type lookup code.

{
    "type":"object",
    "properties":{
        "CalculationCurrency":{
            "maxLength":15,
            "type":"string",
            "description":"The calculation currency code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CommissionValue":{
            "type":"number",
            "description":"The rate of the rate table.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CompensationPlanId":{
            "type":"integer",
            "description":"The unique identifier of the compensation plan for which the measure results are calculated.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CompensationPlanName":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of the compensation plan for which the measure results are calculated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the measure result record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedDuring":{
            "maxLength":30,
            "type":"string",
            "description":"The phase during which this record was created. The possible values are Rollup, Eligibility, Calculation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the measure result record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditAmount":{
            "type":"number",
            "description":"The credit amount in calculation currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditFactor":{
            "type":"number",
            "description":"The credit factor applied to a credit category associated with the performance measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditId":{
            "type":"integer",
            "description":"The unique identifier of the credited transaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreditedParticipantId":{
            "type":"integer",
            "description":"The unique identifier of the participant who receives credit for the transaction.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreditedParticipantName":{
            "title":"Participant Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the participant who receives credit for the transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EarningFactor":{
            "type":"number",
            "description":"The earning factor associated with the performance measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EarningTypeId":{
            "type":"integer",
            "description":"The identifier of the earning type.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EligibleCatId":{
            "type":"integer",
            "description":"The transaction credit category populated during classification.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ErrorReason":{
            "maxLength":150,
            "type":"string",
            "description":"The reason for error during calculation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventFactorValue":{
            "type":"number",
            "description":"The event factor for a transaction type applied to a credit category associated with the performance measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FormulaId":{
            "type":"integer",
            "description":"The unique identifier of the performance measure for which the measure results are calculated.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FormulaWeight":{
            "type":"number",
            "description":"The weight of the performance measure within the plan component.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InputAchieved":{
            "type":"number",
            "description":"The amount passed to the rate table based on the input expression defined in the performance measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MeasureResultId":{
            "type":"integer",
            "description":"The identifier of the simulation measure result.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The current status of the measure results record, such as calculated, calculation error, eligible, or reversed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectStatusMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The display label for the process status lookup code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrgId":{
            "type":"integer",
            "description":"The unique identifier of the business unit associated with the measure result record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OutputAchieved":{
            "type":"number",
            "description":"The amount calculated by the output expression of the performance measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PerformanceMeasureName":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of the performance measure for which the measure results are calculated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanComponentId":{
            "type":"integer",
            "description":"The unique identifier of the plan component for which the measure results are calculated.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanComponentName":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of the plan component for which the measure results are calculated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SimulationDeleteFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the measure result was deleted during calculation simulation processing.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SimulationId":{
            "type":"integer",
            "description":"The identifier of the simulation to which this simulation measure result belongs.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SimulationResultType":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether a measure result comes from the simulation execution or from the existing calculated measure result.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceEventDate":{
            "type":"string",
            "description":"The date of the simulation transaction.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceEventPeriodId":{
            "type":"integer",
            "description":"The period identifier for the source event date.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceTrxNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The transaction number which identifies the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SrpCompensationPlanId":{
            "type":"integer",
            "description":"The unique identifier of the participant compensation plan assignment record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TierSplits":{
            "type":"integer",
            "description":"The tier of the rate table.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionAmount":{
            "type":"number",
            "description":"The transaction amount in calculation currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"The unique identifier for the transaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of the transaction. This value indicates the source of the transaction, such as order, invoice, or credit memo. Review the available lookup codes for the lookup type CN_TP_TRANSACTION_TYPE using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The display label for the Transaction Type lookup code.",
            "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"
            }
        }
    }
}

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

Back to Top