Jump to

• Request
• Response

Update a rate table

patch

/fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentIncentiveFormulas/{IncentiveFormulaId}/child/planComponentRateTables/{PlanComponentRateTableId}

Request

Path Parameters

• IncentiveFormulaId(required): integer(int64)
  The unique identifier for the incentive formula record. There can be only one incentive formula for one plan component.
• PlanComponentRateTableId(required): integer(int64)
  The unique identifier of the rate table associated to the plan component.
• planComponentsUniqID(required): string
  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>

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• EndDate: string (date)
  Title: End Date

  The date when the rate table becomes inactive for the plan component. The format is yyyy-mm-dd.
• StartDate: string (date)
  Title: Start Date

  The date when the rate table becomes active for the plan component. The format is yyyy-mm-dd.

{
    "type":"object",
    "properties":{
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the rate table becomes active for the plan component. The format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the rate table becomes inactive for the plan component. The format is yyyy-mm-dd.",
            "format":"date",
            "nullable":true
        }
    }
}

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 : planComponents-planComponentIncentiveFormulas-planComponentRateTables-item-response

Type: object

Show Source

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

  The date when the rate table becomes inactive for the plan component. The format is yyyy-mm-dd.
• IncentiveFormulaId: integer (int64)
  Title: Incentive Formula ID

  The unique identifier for the incentive formula record. There can be only one incentive formula for one plan component.
• 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 the 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.
• PlanComponentId: integer
  Read Only: true

  The unique identifier for the plan component record within a business unit.
• PlanComponentName: string
  Title: Plan Component Name

  Read Only: true

  The name of a plan component, which defines the earnings of a participant based on their performance.
• PlanComponentRateTableId: integer (int64)
  The unique identifier of the rate table associated to the plan component.
• RateTableDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 1000

  The description of the rate table.
• RateTableId: integer (int64)
  Title: Rate Table ID

  The unique identifier of the rate table.
• RateTableName: string
  Title: Rate Table Name

  Maximum Length: 80

  The name of a rate table. A rate table is used to establish compensation percentage rates or fixed amounts for different performance levels.
• StartDate: string (date)
  Title: Start Date

  The date when the rate table becomes active for the plan component. The format is yyyy-mm-dd.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "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
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RateTableDescription":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the rate table.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IncentiveFormulaId":{
            "title":"Incentive Formula ID",
            "type":"integer",
            "description":"The unique identifier for the incentive formula record. There can be only one incentive formula for one plan component.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PlanComponentId":{
            "type":"integer",
            "description":"The unique identifier for the plan component record within a business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the rate table becomes inactive for the plan component. The format is yyyy-mm-dd.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the rate table becomes active for the plan component. The format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "RateTableName":{
            "title":"Rate Table Name",
            "maxLength":"80",
            "type":"string",
            "description":"The name of a rate table. A rate table is used to establish compensation percentage rates or fixed amounts for different performance levels.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PlanComponentRateTableId":{
            "type":"integer",
            "description":"The unique identifier of the rate table associated to the plan component.",
            "format":"int64",
            "nullable":false,
            "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"
            }
        },
        "PlanComponentName":{
            "title":"Plan Component Name",
            "type":"string",
            "description":"The name of a plan component, which defines the earnings of a participant based on their performance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateTableId":{
            "title":"Rate Table ID",
            "type":"integer",
            "description":"The unique identifier of the rate table.",
            "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

RateTableVO

Operation: /fscmRestApi/resources/11.13.18.05/rateTables

The rate table resource is used to create, update or delete a rate table. It can also be used to display all details of rate tables. The plan component rate table determines the compensation rate for the earnings calculations. The performance measure scorecard is used to establish attainment rates or fixed amounts for different performance levels.

Back to Top