Workday Integration Workday Compensation API — Scorecards

naftiko: 1.0.0-alpha2
info:
  label: Workday Integration Workday Compensation API — Scorecards
  description: 'Workday Integration Workday Compensation API — Scorecards. 9 operations. Lead operation: Workday Integration
    Retrieve scorecard results. Self-contained Naftiko capability covering one Workday Integration business surface.'
  tags:
  - Workday Integration
  - Scorecards
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WORKDAY_INTEGRATION_API_KEY: WORKDAY_INTEGRATION_API_KEY
capability:
  consumes:
  - type: http
    namespace: compensation-scorecards
    baseUri: https://{baseUrl}/ccx/api/compensation/v1/{tenant}
    description: Workday Integration Workday Compensation API — Scorecards business capability. Self-contained, no shared
      references.
    resources:
    - name: scorecardResults
      path: /scorecardResults
      operations:
      - name: getscorecardresults
        method: GET
        description: Workday Integration Retrieve scorecard results
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createscorecardresult
        method: POST
        description: Workday Integration Create a new scorecard result
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: scorecardResults-ID
      path: /scorecardResults/{ID}
      operations:
      - name: getscorecardresultbyid
        method: GET
        description: Workday Integration Retrieve a specific scorecard result
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletescorecardresult
        method: DELETE
        description: Workday Integration Delete a scorecard result
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: scorecards
      path: /scorecards
      operations:
      - name: getcompensationscorecards
        method: GET
        description: Workday Integration Retrieve compensation scorecards
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: effectiveDate
          in: query
          type: string
          description: Filter by effective date
      - name: createcompensationscorecard
        method: POST
        description: Workday Integration Create a compensation scorecard
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: scorecards-ID
      path: /scorecards/{ID}
      operations:
      - name: getcompensationscorecardbyid
        method: GET
        description: Workday Integration Retrieve a specific compensation scorecard
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatecompensationscorecard
        method: PUT
        description: Workday Integration Update a compensation scorecard
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletecompensationscorecard
        method: DELETE
        description: Workday Integration Delete a compensation scorecard
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.WORKDAY_INTEGRATION_API_KEY}}'
  exposes:
  - type: rest
    namespace: compensation-scorecards-rest
    port: 8080
    description: REST adapter for Workday Integration Workday Compensation API — Scorecards. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/scorecardresults
      name: scorecardresults
      description: REST surface for scorecardResults.
      operations:
      - method: GET
        name: getscorecardresults
        description: Workday Integration Retrieve scorecard results
        call: compensation-scorecards.getscorecardresults
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createscorecardresult
        description: Workday Integration Create a new scorecard result
        call: compensation-scorecards.createscorecardresult
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/scorecardresults/{id}
      name: scorecardresults-id
      description: REST surface for scorecardResults-ID.
      operations:
      - method: GET
        name: getscorecardresultbyid
        description: Workday Integration Retrieve a specific scorecard result
        call: compensation-scorecards.getscorecardresultbyid
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletescorecardresult
        description: Workday Integration Delete a scorecard result
        call: compensation-scorecards.deletescorecardresult
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/scorecards
      name: scorecards
      description: REST surface for scorecards.
      operations:
      - method: GET
        name: getcompensationscorecards
        description: Workday Integration Retrieve compensation scorecards
        call: compensation-scorecards.getcompensationscorecards
        with:
          effectiveDate: rest.effectiveDate
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createcompensationscorecard
        description: Workday Integration Create a compensation scorecard
        call: compensation-scorecards.createcompensationscorecard
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/scorecards/{id}
      name: scorecards-id
      description: REST surface for scorecards-ID.
      operations:
      - method: GET
        name: getcompensationscorecardbyid
        description: Workday Integration Retrieve a specific compensation scorecard
        call: compensation-scorecards.getcompensationscorecardbyid
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatecompensationscorecard
        description: Workday Integration Update a compensation scorecard
        call: compensation-scorecards.updatecompensationscorecard
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecompensationscorecard
        description: Workday Integration Delete a compensation scorecard
        call: compensation-scorecards.deletecompensationscorecard
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: compensation-scorecards-mcp
    port: 9090
    transport: http
    description: MCP adapter for Workday Integration Workday Compensation API — Scorecards. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: workday-integration-retrieve-scorecard-results
      description: Workday Integration Retrieve scorecard results
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: compensation-scorecards.getscorecardresults
      outputParameters:
      - type: object
        mapping: $.
    - name: workday-integration-create-new-scorecard
      description: Workday Integration Create a new scorecard result
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: compensation-scorecards.createscorecardresult
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: workday-integration-retrieve-specific-scorecard
      description: Workday Integration Retrieve a specific scorecard result
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: compensation-scorecards.getscorecardresultbyid
      outputParameters:
      - type: object
        mapping: $.
    - name: workday-integration-delete-scorecard-result
      description: Workday Integration Delete a scorecard result
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: compensation-scorecards.deletescorecardresult
      outputParameters:
      - type: object
        mapping: $.
    - name: workday-integration-retrieve-compensation-scorecards
      description: Workday Integration Retrieve compensation scorecards
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: compensation-scorecards.getcompensationscorecards
      with:
        effectiveDate: tools.effectiveDate
      outputParameters:
      - type: object
        mapping: $.
    - name: workday-integration-create-compensation-scorecard
      description: Workday Integration Create a compensation scorecard
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: compensation-scorecards.createcompensationscorecard
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: workday-integration-retrieve-specific-compensation
      description: Workday Integration Retrieve a specific compensation scorecard
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: compensation-scorecards.getcompensationscorecardbyid
      outputParameters:
      - type: object
        mapping: $.
    - name: workday-integration-update-compensation-scorecard
      description: Workday Integration Update a compensation scorecard
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: compensation-scorecards.updatecompensationscorecard
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: workday-integration-delete-compensation-scorecard
      description: Workday Integration Delete a compensation scorecard
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: compensation-scorecards.deletecompensationscorecard
      outputParameters:
      - type: object
        mapping: $.