Jump to

• Request
• Response

Update a scorecard

patch

/fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureScorecards/{PerformanceMeasureScorecardId}

Request

Path Parameters

• PerformanceMeasureId(required): integer(int64)
  The unique identifier for the performance measure.
• PerformanceMeasureScorecardId(required): integer(int64)
  The unique identifier of a scorecard within a 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

• EndDate: string (date)
  Title: End Date

  The date when the scorecard becomes inactive for the performance measure. The format is yyyy-mm-dd.
• StartDate: string (date)
  Title: Start Date

  The date when the scorecard becomes active for the performance measure. The format is yyyy-mm-dd.

{
    "type":"object",
    "properties":{
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the scorecard becomes inactive for the performance measure. The format is yyyy-mm-dd.",
            "format":"date",
            "nullable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the scorecard becomes active for the performance measure. 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-performanceMeasureScorecards-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 scorecard becomes inactive for the performance measure. 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.
• PerformanceMeasureId: integer (int64)
  Title: Performance Measure ID

  The name of the performance measure.
• PerformanceMeasureName: string
  Title: Performance Measure Name

  Read Only: true

  Maximum Length: 80

  The name of a performance measure.
• PerformanceMeasureScorecardId: integer (int64)
  The unique identifier of a scorecard within a performance measure.
• ScorecardDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 1000

  The description of the scorecard entered by the user while creating the scorecard.
• ScorecardId: integer (int64)
  Title: Scorecard ID

  The name of a scorecard.
• ScorecardName: string
  Title: Scorecard Name

  Maximum Length: 80

  The name of the scorecard. A scorecard is used to establish attainment rates or fixed amounts for different performance levels.
• StartDate: string (date)
  Title: Start Date

  The date when the scorecard becomes active for the performance measure. 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
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the scorecard becomes inactive for the performance measure. 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
        },
        "PerformanceMeasureId":{
            "title":"Performance Measure ID",
            "type":"integer",
            "description":"The name of the performance measure.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PerformanceMeasureName":{
            "title":"Performance Measure Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of a performance measure.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PerformanceMeasureScorecardId":{
            "type":"integer",
            "description":"The unique identifier of a scorecard within a performance measure.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ScorecardDescription":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the scorecard entered by the user while creating the scorecard.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScorecardId":{
            "title":"Scorecard ID",
            "type":"integer",
            "description":"The name of a scorecard.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ScorecardName":{
            "title":"Scorecard Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of the scorecard. A scorecard is used to establish attainment rates or fixed amounts for different performance levels.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the scorecard becomes active for the performance measure. 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."
        }
    }
}

Links

ScorecardVO

Operation: /fscmRestApi/resources/11.13.18.05/rateTables

The list of values containing the names of the scorecards. A scorecard is used to establish attainment rates or fixed amounts for different performance levels.

The following properties are defined on the LOV link relation:

• Source Attribute: ScorecardName; Target Attribute: Name
• Display Attribute: Name, Description, NumberDim

Back to Top