UKG Pro Workforce Management API — Scheduling

naftiko: 1.0.0-alpha2
info:
  label: UKG Pro Workforce Management API — Scheduling
  description: 'UKG Pro Workforce Management API — Scheduling. 2 operations. Lead operation: UKG Pro WFM Get Employee Shifts.
    Self-contained Naftiko capability covering one Ukg business surface.'
  tags:
  - Ukg
  - Scheduling
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    UKG_API_KEY: UKG_API_KEY
capability:
  consumes:
  - type: http
    namespace: pro-wfm-scheduling
    baseUri: https://api.ultipro.com/workforce/v1
    description: UKG Pro Workforce Management API — Scheduling business capability. Self-contained, no shared references.
    resources:
    - name: v1-employees-employeeId-shifts
      path: /v1/employees/{employeeId}/shifts
      operations:
      - name: getemployeeshifts
        method: GET
        description: UKG Pro WFM Get Employee Shifts
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: employeeId
          in: path
          type: string
          description: Employee identifier
          required: true
        - name: startDate
          in: query
          type: string
          description: Start date
        - name: endDate
          in: query
          type: string
          description: End date
    - name: v1-schedules
      path: /v1/schedules
      operations:
      - name: listschedules
        method: GET
        description: UKG Pro WFM List Schedules
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: query
          type: string
          description: Location to retrieve schedules for
        - name: startDate
          in: query
          type: string
          description: Start date for schedule retrieval
          required: true
        - name: endDate
          in: query
          type: string
          description: End date for schedule retrieval
          required: true
    authentication:
      type: bearer
      token: '{{env.UKG_API_KEY}}'
  exposes:
  - type: rest
    namespace: pro-wfm-scheduling-rest
    port: 8080
    description: REST adapter for UKG Pro Workforce Management API — Scheduling. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/v1/employees/{employeeid}/shifts
      name: v1-employees-employeeid-shifts
      description: REST surface for v1-employees-employeeId-shifts.
      operations:
      - method: GET
        name: getemployeeshifts
        description: UKG Pro WFM Get Employee Shifts
        call: pro-wfm-scheduling.getemployeeshifts
        with:
          employeeId: rest.employeeId
          startDate: rest.startDate
          endDate: rest.endDate
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/schedules
      name: v1-schedules
      description: REST surface for v1-schedules.
      operations:
      - method: GET
        name: listschedules
        description: UKG Pro WFM List Schedules
        call: pro-wfm-scheduling.listschedules
        with:
          locationId: rest.locationId
          startDate: rest.startDate
          endDate: rest.endDate
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: pro-wfm-scheduling-mcp
    port: 9090
    transport: http
    description: MCP adapter for UKG Pro Workforce Management API — Scheduling. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: ukg-pro-wfm-get-employee
      description: UKG Pro WFM Get Employee Shifts
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: pro-wfm-scheduling.getemployeeshifts
      with:
        employeeId: tools.employeeId
        startDate: tools.startDate
        endDate: tools.endDate
      outputParameters:
      - type: object
        mapping: $.
    - name: ukg-pro-wfm-list-schedules
      description: UKG Pro WFM List Schedules
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: pro-wfm-scheduling.listschedules
      with:
        locationId: tools.locationId
        startDate: tools.startDate
        endDate: tools.endDate
      outputParameters:
      - type: object
        mapping: $.