Jump to

• Request
• Response
• Examples

Update a credit factor

patch

/fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureCreditCategories/{PerformanceMeasureCreditCategoryId}/child/performanceMeasureCreditFactors/{PerformanceMeasureCreditFactorId}

Request

Path Parameters

• PerformanceMeasureCreditCategoryId(required): integer(int64)
  The unique identifier representing the credit category for the performance measure.
• PerformanceMeasureCreditFactorId(required): integer(int64)
  The unique identifier of the credit factors for the performance measure.
• PerformanceMeasureId(required): integer(int64)
  The unique identifier for the performance measure.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CreditFactor: number
  Title: Credit Factor

  Default Value: 100

  The percentage of uplift applied to transaction credits that is specified at the credit category level, for a period of time. Helps to boost the attainment for a period of time, for certain credit categories. The default value is 100.
• EarningFactor: number
  Title: Earning Factor

  Default Value: 100

  The percentage of uplift applied to earnings that is specified at the credit category level, for a period of time. Helps to boost the earnings for a period of time, for certain credit categories. Default value is 100.
• EndDate: string (date)
  Title: End Date

  The date when the credit factor and earning factor provided for a credit category within a performance measure become inactive. The format is yyyy-mm-dd.
• PerformanceMeasureCreditCategoryId: integer (int64)
  The unique identifier of the credit category for the performance measure.
• StartDate: string (date)
  Title: Start Date

  The date when the credit factor and earning factor provided for a credit category within a performance measure become active. The format is yyyy-mm-dd.

{
    "type":"object",
    "properties":{
        "CreditFactor":{
            "title":"Credit Factor",
            "type":"number",
            "description":"The percentage of uplift applied to transaction credits that is specified at the credit category level, for a period of time. Helps to boost the attainment for a period of time, for certain credit categories. The default value is 100.",
            "nullable":false,
            "default":100
        },
        "EarningFactor":{
            "title":"Earning Factor",
            "type":"number",
            "description":"The percentage of uplift applied to earnings that is specified at the credit category level, for a period of time. Helps to boost the earnings for a period of time, for certain credit categories. Default value is 100.",
            "nullable":false,
            "default":100
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the credit factor and earning factor provided for a credit category within a performance measure become inactive.  The format is yyyy-mm-dd.",
            "format":"date",
            "nullable":true
        },
        "PerformanceMeasureCreditCategoryId":{
            "type":"integer",
            "description":"The unique identifier of the credit category for the performance measure.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the credit factor and earning factor provided for a credit category within a performance measure become active. The format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false
        }
    }
}

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-performanceMeasureCreditCategories-performanceMeasureCreditFactors-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.
• CreditFactor: number
  Title: Credit Factor

  Default Value: 100

  The percentage of uplift applied to transaction credits that is specified at the credit category level, for a period of time. Helps to boost the attainment for a period of time, for certain credit categories. The default value is 100.
• EarningFactor: number
  Title: Earning Factor

  Default Value: 100

  The percentage of uplift applied to earnings that is specified at the credit category level, for a period of time. Helps to boost the earnings for a period of time, for certain credit categories. Default value is 100.
• EndDate: string (date)
  Title: End Date

  The date when the credit factor and earning factor provided for a credit category within a performance measure become inactive. The format is yyyy-mm-dd.
• 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.
• PerformanceMeasureCreditCategoryId: integer (int64)
  The unique identifier of the credit category for the performance measure.
• PerformanceMeasureCreditFactorId: integer (int64)
  The unique identifier of the credit factors for the performance measure.
• StartDate: string (date)
  Title: Start Date

  The date when the credit factor and earning factor provided for a credit category within a performance measure become active. The format is yyyy-mm-dd.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created 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
        },
        "CreditFactor":{
            "title":"Credit Factor",
            "type":"number",
            "description":"The percentage of uplift applied to transaction credits that is specified at the credit category level, for a period of time. Helps to boost the attainment for a period of time, for certain credit categories. The default value is 100.",
            "nullable":false,
            "default":100,
            "x-queryable":true
        },
        "EarningFactor":{
            "title":"Earning Factor",
            "type":"number",
            "description":"The percentage of uplift applied to earnings that is specified at the credit category level, for a period of time. Helps to boost the earnings for a period of time, for certain credit categories. Default value is 100.",
            "nullable":false,
            "default":100,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the credit factor and earning factor provided for a credit category within a performance measure become inactive.  The format is yyyy-mm-dd.",
            "format":"date",
            "nullable":true,
            "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
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PerformanceMeasureCreditCategoryId":{
            "type":"integer",
            "description":"The unique identifier of the credit category for the performance measure.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PerformanceMeasureCreditFactorId":{
            "type":"integer",
            "description":"The unique identifier of the credit factors for the performance measure.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the credit factor and earning factor provided for a credit category within a performance measure become active. The format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false,
            "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

Examples

The following example shows how to update a credit factor by submitting a PATCH request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/300100090511017/child/performanceMeasureCreditCategories/300100090511047/child/performanceMeasureCreditFactors/300100090511048

Example of Request Body

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

{
"StartDate": "2016-05-01",
"EndDate": "2016-10-30"
}

Example of Response Body

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

{
  "PerformanceMeasureCreditFactorId": 300100090511048,
  "PerformanceMeasureCreditCategoryId": 300100090511047,
  "CreditFactor": 100,
  "EarningFactor": 100,
  "StartDate": "2016-05-01",
  "EndDate": "2016-10-30",
  "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
  "CreationDate": "2017-06-08T11:45:55-07:00",
  "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
  "LastUpdateDate": "2017-06-08T11:47:57-07:00",
  "LastUpdateLogin": "516E508C5BC4377FE0532DD6F00A0214",
  "links": [
    ...
  ]
}

Back to Top