openapi: 3.2.0
info:
  title: compensation Scorecards API
  description: The Compensation service enables applications to extend Workday's HCM Compensation features.
  version: v3
  x-workday-confidence-level: Production
  x-workday-internal-source: xo
  x-workday-internal-routing: Public
  x-workday-internal-protected-usage-enabled: false
  x-workday-internal-service-container-id: 2d8b79dba7251000105e1cc54b0a13e1
servers:
- url: https://<tenantHostname>/compensation/v3
tags:
- name: scorecards
  description: Provides the ability to set up and retrieve Scores on Scorecard Results.
paths:
  /scorecards:
    get:
      tags:
      - scorecards
      summary: Retrieves Compensation Scorecard information
      description: 'Retrieves Compensation Scorecard information including the scorecardName, scorecardDescription, inactive status, defaultScorecardGoals, scorecardProfiles containing profileScorecardGoals as of the effective date. The default effective date is the request date.


        Secured By Domain: Set Up: Merit and Bonus


        Scope: Advanced Compensation'
      parameters:
      - name: effectiveDate
        in: query
        description: Effective date the scorecard task takes effect.
        schema:
          type: string
          format: date
      - name: limit
        in: query
        description: The maximum number of objects in a single response. The default is 20. The maximum is 100.
        schema:
          type: integer
          format: int64
      - name: offset
        in: query
        description: 'The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.'
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Successful response. A successful response can return no matched data.
          content:
            application/json:
              schema:
                type: object
                properties:
                  total:
                    type: integer
                    format: int32
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/scorecard_e8cffc5e0fe810000b26ce3a5d2200f4'
        '400':
          description: Invalid request. (https://community.workday.com/rest/error-messages)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE'
        '401':
          description: 'Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE'
        '403':
          description: User has insufficient permissions. (https://community.workday.com/rest/error-messages)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE'
        '404':
          description: Resource not found. (https://community.workday.com/rest/error-messages)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE'
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ERROR_MODEL_REFERENCE'
      x-workday-internal-try-enabled: 'true'
      x-workday-operation-id: e8cffc5e0fe810000ac04722d79c00f2
      x-workday-secured-by-domains:
      - 'Set Up: Merit and Bonus'
      operationId: getScorecards
      x-operation-id-source: derived
    post:
      tags:
      - scorecards
      summary: Creates a Compensation Scorecard
      description: 'Creates a new Compensation Scorecard.


        In the request body, specify these required fields: scorecardName, effectiveDate, and defaultScorecardGoals[ {goalName, goalWeight} ].

        If you specify the optional scorecardProfiles[], you must specify the eligibilityRule{id} and at least 1 goal in profileScorecardGoals[ {goalName, goalWeight} ].


        Secured By Domain: Set Up: Merit and Bonus


        Scope: Advanced Compensation'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createScorecard_e783e109d05a100008666e71ee9200c1'
      responses:
        '201':
          description: Resource created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createScorecard_e783e109d05a100008666e71ee9200c1'
        '400':
          description: 'Invalid request. (https://community.workday.com/rest/error-messages)


            A Default Scorecard \~Goal\~ is missing


            A \~Goal\~ is missing for a Scorecard Profile.


            Scorecard Name entered has already been used.


            The sum of the \~goal\~ weightings must equal 100%.


            There are duplicate eligibility rules on this request.


            \~Goal\~ Weights must be greater than 0.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE'
        '401':
          description: 'Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE'
        '403':
          description: User has insufficient permissions. (https://community.workday.com/rest/error-messages)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE'
        '404':
          description: Resource not found. (https://community.workday.com/rest/error-messages)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE'
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ERROR_MODEL_REFERENCE'
      x-workday-internal-try-enabled: 'false'
      x-workday-operation-id: e783e109d05a10000778a8412a8900b4
      x-workday-secured-by-domains:
      - 'Set Up: Merit and Bonus'
      operationId: postScorecards
      x-operation-id-source: derived
  /scorecards/{ID}:
    get:
      tags:
      - scorecards
      summary: Retrieves Compensation Scorecard information
      description: 'Retrieves Compensation Scorecard information including the scorecardName, scorecardDescription, inactive status, defaultScorecardGoals, scorecardProfiles containing profileScorecardGoals as of the effective date. The default effective date is the request date.


        Secured By Domain: Set Up: Merit and Bonus


        Scope: Advanced Compensation'
      parameters:
      - name: ID
        in: path
        description: 'The Workday ID of the resource.


          Accepts:

          - **Workday ID**: Workday ID (32-character lowercase hexadecimal string).

          - **Reference ID**: Workday reference ID (Type=Value). Valid types: Performance_Scorecard_ID'
        required: true
        schema:
          $ref: '#/components/schemas/ResourceIdPathValue_scorecards'
        examples:
          wid:
            summary: Specific resource WID
            value: a3f5b554007d20e98360015c5e6daf6
          referenceId:
            summary: Reference ID
            value: Performance_Scorecard_ID=21002
      responses:
        '200':
          description: Successful response. A successful response can return no matched data.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scorecard_e8cffc5e0fe810000b26ce3a5d2200f4'
        '400':
          description: Invalid request. (https://community.workday.com/rest/error-messages)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE'
        '401':
          description: 'Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE'
        '403':
          description: User has insufficient permissions. (https://community.workday.com/rest/error-messages)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE'
        '404':
          description: Resource not found. (https://community.workday.com/rest/error-messages)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE'
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ERROR_MODEL_REFERENCE'
      x-workday-internal-try-enabled: 'true'
      x-workday-operation-id: e8cffc5e0fe810000ac04722d79c00f2
      x-workday-secured-by-domains:
      - 'Set Up: Merit and Bonus'
      operationId: getScorecardsByID
      x-operation-id-source: derived
    put:
      tags:
      - scorecards
      summary: Updates a Compensation Scorecard
      description: 'Replaces an existing Compensation Scorecard as of the specified effectiveDate.

        Call GET /scorecards/{ID} to initially populate the request body with the existing data. You can then update the scorecardName, scorecardDescription, and inactive fields. You can also add, update, and delete the existing data in defaultScorecardGoals[], scorecardProfiles[], and profileScorecardGoals[].


        Secured By Domain: Set Up: Merit and Bonus


        Scope: Advanced Compensation'
      parameters:
      - name: ID
        in: path
        description: 'The Workday ID of the resource.


          Accepts:

          - **Workday ID**: Workday ID (32-character lowercase hexadecimal string).

          - **Reference ID**: Workday reference ID (Type=Value). Valid types: Performance_Scorecard_ID'
        required: true
        schema:
          $ref: '#/components/schemas/ResourceIdPathValue_scorecards'
        examples:
          wid:
            summary: Specific resource WID
            value: a3f5b554007d20e98360015c5e6daf6
          referenceId:
            summary: Reference ID
            value: Performance_Scorecard_ID=21002
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/editScorecards_6316bca5e030100008492348577100af'
      responses:
        '200':
          description: Successful response. A successful response can return no matched data. Updating resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/editScorecards_6316bca5e030100008492348577100af'
        '400':
          description: 'Invalid request. (https://community.workday.com/rest/error-messages)


            A Default Scorecard \~Goal\~ is missing


            A Scorecard Profile doesn''t exist as of the Effective Date. Remove or replace the invalid Scorecard Profile or change the Effective Date.


            A Scorecard Profile is already in use on another Scorecard. Select a Scorecard Profile that''s not already in use.


            A \~Goal\~ doesn''t exist as of the Effective Date. Remove or replace the invalid \~Goal\~ or change the Effective Date.


            A \~Goal\~ is invalid. Enter a valid \~Goal\~.


            A \~Goal\~ is missing for a Scorecard Profile.


            Enter an Effective Date that is on or after the first Effective Date of the scorecard: [effectiveDate].


            Scorecard Name entered has already been used.


            The sum of the \~goal\~ weightings must equal 100%.


            There are duplicate eligibility rules on this request.


            You can''t edit the compensation scorecard [scorecard] for the Effective Date [date] because the latest dated performance results associated with the scorecard is the date [latest date]. Enter an Effective Date for editing the scorecard that is after the following date: [latest date]


            You entered duplicate Scorecard Profiles. Replace or remove the duplicates.


            You entered duplicate \~Goals\~. Replace or remove the duplicates.


            \~Goal\~ Weights must be greater than 0.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE'
        '401':
          description: 'Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE'
        '403':
          description: User has insufficient permissions. (https://community.workday.com/rest/error-messages)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE'
        '404':
          description: Resource not found. (https://community.workday.com/rest/error-messages)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE'
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ERROR_MODEL_REFERENCE'
      x-workday-internal-try-enabled: 'false'
      x-workday-operation-id: 6316bca5e0301000085106abcb1100b3
      x-workday-secured-by-domains:
      - 'Set Up: Merit and Bonus'
      operationId: putScorecardsByID
      x-operation-id-source: derived
    delete:
      tags:
      - scorecards
      summary: Deletes a Compensation Scorecard with the specified ID
      description: 'Deletes Compensation Scorecards.


        Secured By Domain: Set Up: Merit and Bonus


        Scope: Advanced Compensation'
      parameters:
      - name: ID
        in: path
        description: 'The Workday ID of the resource.


          Accepts:

          - **Workday ID**: Workday ID (32-character lowercase hexadecimal string).

          - **Reference ID**: Workday reference ID (Type=Value). Valid types: Performance_Scorecard_ID'
        required: true
        schema:
          $ref: '#/components/schemas/ResourceIdPathValue_scorecards'
        examples:
          wid:
            summary: Specific resource WID
            value: a3f5b554007d20e98360015c5e6daf6
          referenceId:
            summary: Reference ID
            value: Performance_Scorecard_ID=21002
      responses:
        '200':
          description: Successful response. A successful response can return no matched data. Deleting resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MULTIPLE_INSTANCE_MODEL_REFERENCE'
        '400':
          description: 'Invalid request. (https://community.workday.com/rest/error-messages)


            The Compensation Scorecard cannot be deleted because it is in use.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE'
        '401':
          description: 'Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE'
        '403':
          description: User has insufficient permissions. (https://community.workday.com/rest/error-messages)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE'
        '404':
          description: Resource not found. (https://community.workday.com/rest/error-messages)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE'
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ERROR_MODEL_REFERENCE'
      x-workday-internal-try-enabled: 'false'
      x-workday-operation-id: c76caeba972910000e71587ba79700b3
      x-workday-secured-by-domains:
      - 'Set Up: Merit and Bonus'
      operationId: deleteScorecardsByID
      x-operation-id-source: derived
components:
  schemas:
    WorkdayReferenceId_scorecards:
      pattern: ^(Performance_Scorecard_ID)=\S+$
      type: string
      description: 'Workday reference ID (Type=Value). Valid types: Performance_Scorecard_ID'
      example: Performance_Scorecard_ID=21002
    scorecardGoals_739602a83e141000065bcbec559400c4:
      allOf:
      - required:
        - goalName
        - goalWeight
        type: object
        properties:
          goalWeight:
            type: number
            description: Replaces the weight of the Compensation Scorecard \~Goal\~ as of the specified effectiveDate.  [Weight should be entered as 0.9 for a goalWeight of 90%]
            format: double
            example: 999999.9999
            x-workday-type: Numeric
          goalName:
            type: string
            description: Replaces the name of the Compensation Scorecard Goal as of the specified effectiveDate.
            example: Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.
            x-workday-type: Text
          goalDescription:
            type: string
            description: Replaces the description of the Compensation Scorecard Goal as of the specified effectiveDate.  Deletes the description if a description exists as of the specified effectiveDate and this field is not included in the PUT.
            example: Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.
            x-workday-type: Text
          id:
            type: string
            description: The id for Performance Criteria
    eligibilityRule_e8cffc5e0fe8100019d298288b26011c:
      description: The name of the Compensation Eligibility Rule assigned to the Compensation Scorecard Profile.
      allOf:
      - $ref: '#/components/schemas/INSTANCE_MODEL_REFERENCE'
      - type: object
    profileScorecardGoals_e8cffc5e0fe8100019d298117ae00119:
      allOf:
      - $ref: '#/components/schemas/scorecardGoalSummary_e8cffc5e0fe8100015e8c9f2a2a30110'
      - type: object
        properties:
          id:
            type: string
            description: The id for Performance Criteria
    defaultScorecardGoals_e783e109d05a100008666ebe55a100c4:
      allOf:
      - $ref: '#/components/schemas/createGoals_e783e109d05a10000add0e9d914f1817'
      - type: object
        properties:
          id:
            type: string
            description: The id for Performance Criteria
    eligibilityRule_e783e109d05a10000aa2f66be77e17e2:
      description: The name of the Compensation Eligibility Rule assigned to the Compensation Scorecard Profile.
      allOf:
      - $ref: '#/components/schemas/INSTANCE_MODEL_REFERENCE'
      - type: object
    scorecard_e8cffc5e0fe810000b26ce3a5d2200f4:
      allOf:
      - type: object
        properties:
          scorecardProfiles:
            type: array
            description: The profiles for the Compensation Scorecard.
            items:
              $ref: '#/components/schemas/scorecardProfiles_5ec11e698afe10000c93771015820144'
            x-workday-type: Multi-instance
          scorecardName:
            type: string
            description: The name of the Compensation Scorecard.
            example: Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.
            x-workday-type: Text
          effectiveDate:
            type: string
            description: The Effective Date of the Compensation Scorecard in format YYYY-MM-DD.
            format: date
            x-workday-type: Date
          inactive:
            type: boolean
            description: Indicates whether the Scorecard is inactive using a value of true/false.
            example: true
            x-workday-type: Boolean
          scorecardDescription:
            type: string
            description: The description of the Compensation Scorecard.
            example: Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.
            x-workday-type: Text
          defaultScorecardGoals:
            type: array
            description: The goals for the Compensation Scorecard.
            items:
              $ref: '#/components/schemas/defaultScorecardGoals_5ec11e698afe10000c0792b20d370140'
            x-workday-type: Multi-instance
          id:
            type: string
            description: Workday Id or Reference Id of the instance.
    scorecardProfile_e8cffc5e0fe8100019d2980406830118:
      allOf:
      - type: object
        properties:
          eligibilityRule:
            $ref: '#/components/schemas/eligibilityRule_e8cffc5e0fe8100019d298288b26011c'
          profileScorecardGoals:
            type: array
            description: The goals for the Compensation Scorecard.
            items:
              $ref: '#/components/schemas/profileScorecardGoals_e8cffc5e0fe8100019d298117ae00119'
            x-workday-type: Multi-instance
          id:
            type: string
            description: The id for Scorecard Profile
    defaultScorecardGoals_fcedbf0ab58c10000983d0b90d360134:
      allOf:
      - $ref: '#/components/schemas/scorecardGoals_739602a83e141000065bcbec559400c4'
      - type: object
        properties:
          id:
            type: string
            description: The id for Performance Criteria
    ERROR_MODEL_REFERENCE:
      required:
      - error
      type: object
      properties:
        error:
          type: string
          description: A description of the error
        code:
          type: string
          description: The code that corresponds to the error message. Use the error code to drive programmatic error-handling behavior. Don't use error message strings for this purpose because they are subject to change
        field:
          type: string
          description: The field related to the error
        path:
          type: string
          description: The path of the field related to the error
        severity:
          type: string
          description: Severity of the validation (e.g. Critical, Warning).
        internalMessage:
          type: string
          description: Internal message providing additional context for the validation (e.g. representation content validation details).
    defaultScorecardGoals_5ec11e698afe10000c0792b20d370140:
      allOf:
      - $ref: '#/components/schemas/scorecardGoalSummary_e8cffc5e0fe8100015e8c9f2a2a30110'
      - type: object
        properties:
          id:
            type: string
            description: The id for Performance Criteria
    profileScorecardGoals_e783e109d05a10000aa2f664cef617e1:
      allOf:
      - $ref: '#/components/schemas/createGoals_e783e109d05a10000add0e9d914f1817'
      - type: object
        properties:
          id:
            type: string
            description: The id for Performance Criteria
    ResourceIdPathValue_scorecards:
      oneOf:
      - $ref: '#/components/schemas/WorkdayId'
      - $ref: '#/components/schemas/WorkdayReferenceId_scorecards'
    MULTIPLE_INSTANCE_MODEL_REFERENCE:
      type: object
      properties:
        total:
          type: integer
          format: int32
        data:
          type: array
          items:
            $ref: '#/components/schemas/INSTANCE_MODEL_REFERENCE'
    INSTANCE_MODEL_REFERENCE:
      required:
      - id
      type: object
      properties:
        id:
          pattern: ^(([0-9a-f]{32})|(\S+=\S+))$
          type: string
          description: Workday Id or Reference Id of the instance.
        descriptor:
          type: string
          description: The display name of the instance
          readOnly: true
        href:
          type: string
          description: A link to the instance
          readOnly: true
    WorkdayId:
      pattern: ^[0-9a-f]{32}$
      type: string
      description: Workday ID (32-character lowercase hexadecimal string).
      example: a3f5b554007d20e98360015c5e6daf6
    scorecardProfiles_ab761d753f94100006db1f4fab80018c:
      allOf:
      - required:
        - eligibilityRule
        - profileScorecardGoals
        type: object
        properties:
          profileScorecardGoals:
            type: array
            description: Replaces the array of Profile Scorecard Goal fields as of the specified effectiveDate.  Creates a new array if one does not exist.  Deletes the array if one exists as of the specified effectiveDate and the scorecardProfiles array is not included in the PUT.
            items:
              $ref: '#/components/schemas/profileScorecardGoals_ab761d753f94100006db1fc25c4a018d'
            x-workday-type: Multi-instance
          eligibilityRule:
            $ref: '#/components/schemas/eligibilityRule_ab761d753f941000087efd5da96b01b0'
          id:
            type: string
            description: The id for Scorecard Profile
    profileScorecardGoals_ab761d753f94100006db1fc25c4a018d:
      allOf:
      - $ref: '#/components/schemas/scorecardGoals_739602a83e141000065bcbec559400c4'
      - type: object
        properties:
          id:
            type: string
            description: The id for Performance Criteria
    createGoals_e783e109d05a10000add0e9d914f1817:
      allOf:
      - required:
        - goalName
        - goalWeight
        type: object
        properties:
          goalWeight:
            type: number
            description: The weight given to the Compensation Scorecard Goal. [90% will be displayed as 0.9]
            format: double
            example: 999999.9999
            x-workday-type: Numeric
          goalName:
            type: string
            description: The name of the Compensation Scorecard Goal.
            example: Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.
            x-workday-type: Text
          goalDescription:
            type: string
            description: The description of the Compensation Scorecard Goal
            example: Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.
            x-workday-type: Text
          id:
            type: string
            description: The id for Performance Criteria
    scorecardProfiles_e783e109d05a100008666e9829b100c2:
      allOf:
      - $ref: '#/components/schemas/createScorecardProfiles_e783e109d05a10000aa2f64beebf17df'
      - type: object
        properties:
          id:
            type: string
            description: The id for Scorecard Profile
    scorecardProfiles_5ec11e698afe10000c93771015820144:
      allOf:
      - $ref: '#/components/schemas/scorecardProfile_e8cffc5e0fe8100019d2980406830118'
      - type: object
        properties:
          id:
            type: string
            description: The id for Scorecard Profile
    editScorecards_6316bca5e030100008492348577100af:
      allOf:
      - required:
        - defaultScorecardGoals
        - effectiveDate
        - scorecardName
        type: object
        properties:
          scorecardProfiles:
            type: array
            description: Replaces the array of Profile Scorecard Goals and Eligibility Rules as of the specified effectiveDate.  Creates a new array if one does not exist.  Deletes the array if one exists as of the specified effectiveDate and the array is not included in the PUT.
            items:
              $ref: '#/components/schemas/scorecardProfiles_ab761d753f94100006dd7a5a55e50192'
            x-workday-type: Multi-instance
          defaultScorecardGoals:
            type: array
            description: Replaces the array of Default Scorecard Goal fields as of the specified effectiveDate.
            items:
              $ref: '#/components/schemas/defaultScorecardGoals_fcedbf0ab58c10000983d0b90d360134'
            x-workday-type: Multi-instance
          scorecardName:
            type: string
            description: Replaces the name of the Compensation Scorecard as of the specified effectiveDate.
            example: Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.
            x-workday-type: Text
          inactive:
            type: boolean
            description: 'Replaces the inactive status of the Compensation Scorecard as of the specified effectiveDate.  Default value: false.'
            example: true
            x-workday-type: Boolean
          effectiveDate:
            type: string
            description: 'The Effective Date of the updates to the Compensation Scorecard.  Date must be entered in format: YYYY-MM-DD.'
            format: date
            x-workday-type: Date
          scorecardDescription:
            type: string
            description: Replaces the description of the Compensation Scorecard as of the specified effectiveDate.  Deletes the description if a description exists as of the specified effectiveDate and this field is not included in the PUT.
            example: Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.
            x-workday-type: Text
          id:
            type: string
            description: Workday Id or Reference Id of the instance.
    createScorecardProfiles_e783e109d05a10000aa2f64beebf17df:
      allOf:
      - required:
        - eligibilityRule
        - profileScorecardGoals
        type: object
        properties:
          eligibilityRule:
            $ref: '#/components/schemas/eligibilityRule_e783e109d05a10000aa2f66be77e17e2'
          profileScorecardGoals:
            type: array
            description: The \~goals\~ for the Compensation Scorecard.
            items:
              $ref: '#/components/schemas/profileScorecardGoals_e783e109d05a10000aa2f664cef617e1'
            x-workday-type: Multi-instance
          id:
            type: string
            description: The id for Scorecard Profile
    scorecardGoalSummary_e8cffc5e0fe8100015e8c9f2a2a30110:
      allOf:
      - type: object
        properties:
          goalWeight:
            type: number
            description: The weight given to the Compensation Scorecard \~Goal\~. [90% will be displayed as 0.9]
            format: double
            example: 999999.9999
            x-workday-type: Numeric
          goalDescription:
            type: string
            description: The description of the Compensation Scorecard \~Goal\~.
            example: Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.
            x-workday-type: Text
          goalName:
            type: string
            description: The name of the Compensation Scorecard \~Goal\~.
            example: Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.
            x-workday-type: Text
          id:
            type: string
            description: The id for Performance Criteria
    scorecardProfiles_ab761d753f94100006dd7a5a55e50192:
      allOf:
      - $ref: '#/components/schemas/scorecardProfiles_ab761d753f94100006db1f4fab80018c'
      - type: object
        properties:
          id:
            type: string
            description: The id for Scorecard Profile
    eligibilityRule_ab761d753f941000087efd5da96b01b0:
      description: Replaces the Eligibility Rule object as of the specified effectiveDate.
      allOf:
      - $ref: '#/components/schemas/INSTANCE_MODEL_REFERENCE'
      - type: object
    createScorecard_e783e109d05a100008666e71ee9200c1:
      allOf:
      - required:
        - defaultScorecardGoals
        - effectiveDate
        - scorecardName
        type: object
        properties:
          defaultScorecardGoals:
            type: array
            description: The \~goals\~ for the Compensation Scorecard.
            items:
              $ref: '#/components/schemas/defaultScorecardGoals_e783e109d05a100008666ebe55a100c4'
            x-workday-type: Multi-instance
          scorecardName:
            type: string
            description: The name of the Compensation Scorecard.
            example: Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.
            x-workday-type: Text
          inactive:
            type: boolean
            description: Indicates whether the Scorecard is inactive using a value of true/false.
            example: true
            x-workday-type: Boolean
          scorecardProfiles:
            type: array
            description: The profiles for the Compensation Scorecard.
            items:
              $ref: '#/components/schemas/scorecardProfiles_e783e109d05a100008666e9829b100c2'
            x-workday-type: Multi-instance
          scorecardDescription:
            type: string
            description: The description of the Compensation Scorecard.
            example: Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.
            x-workday-type: Text
          effectiveDate:
            type: string
            description: The Effective Date of the Compensation Scorecard in format YYYY-MM-DD
            format: date
            x-workday-type: Date
          id:
            type: string
            description: Workday Id or Reference Id of the instance.
    VALIDATION_ERROR_MODEL_REFERENCE:
      allOf:
      - required:
        - error
        type: object
        properties:
          error:
            type: string
            description: A description of the error
          errors:
            type: array
            description: An array of validation errors
            items:
              $ref: '#/components/schemas/ERROR_MODEL_REFERENCE'
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: https://<tenantAuthorizationHostname>
          scopes: {}