openapi: 3.1.0
info:
  title: PeopleSoft HCM API
  description: Human Capital Management APIs for employee data, benefits, payroll,
    workforce administration, and talent management.
  version: 1.0.0
  contact:
    name: Oracle Support
    email: support@oracle.com
    url: https://support.oracle.com
  license:
    name: Proprietary
    url: https://www.oracle.com/contracts/
servers:
- url: https://{hostname}:{port}/psft/api/hcm/v1
  description: PeopleSoft Instance
  variables:
    hostname:
      description: PeopleSoft server hostname
      default: localhost
    port:
      description: PeopleSoft server port
      default: '8000'
externalDocs:
  description: PeopleSoft HCM Documentation
  url: https://docs.oracle.com/en/applications/peoplesoft/human-capital-management/index.html
tags:
- name: Employees
  description: Employee data operations
- name: Benefits
  description: Benefits administration operations
- name: Payroll
  description: Payroll operations
paths:
  /employees:
    get:
      summary: PeopleSoft List Employees
      description: Retrieve a list of employee records.
      operationId: listEmployees
      tags:
      - Employees
      security:
      - basicAuth: []
      parameters:
      - name: department
        in: query
        description: Filter by department
        schema:
          type: string
        example: example_value
      - name: status
        in: query
        description: Filter by employment status
        schema:
          type: string
          enum:
          - active
          - inactive
          - terminated
          - leave
        example: active
      responses:
        '200':
          description: Successful response with employee list
          content:
            application/json:
              schema:
                type: object
                properties:
                  employees:
                    type: array
                    items:
                      type: object
        '401':
          description: Unauthorized
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /employees/{employeeId}:
    get:
      summary: PeopleSoft Get Employee
      description: Retrieve details for a specific employee.
      operationId: getEmployee
      tags:
      - Employees
      security:
      - basicAuth: []
      parameters:
      - name: employeeId
        in: path
        required: true
        description: The employee identifier
        schema:
          type: string
        example: PS123456
      responses:
        '200':
          description: Employee details
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized
        '404':
          description: Employee not found
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /benefits/enrollments:
    get:
      summary: PeopleSoft List Benefit Enrollments
      description: Retrieve benefit enrollment records.
      operationId: listBenefitEnrollments
      tags:
      - Benefits
      security:
      - basicAuth: []
      responses:
        '200':
          description: Successful response with enrollments
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /payroll/runs:
    get:
      summary: PeopleSoft List Payroll Runs
      description: Retrieve payroll run history and status.
      operationId: listPayrollRuns
      tags:
      - Payroll
      security:
      - basicAuth: []
      responses:
        '200':
          description: Successful response with payroll runs
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
  schemas:
    Employee:
      type: object
      description: PeopleSoft HCM employee personal data record.
      properties:
        EMPLID:
          type: string
          description: Employee ID.
          example: EMP001234
        NAME:
          type: string
          description: Employee full name.
          example: Jane Smith
        FIRST_NAME:
          type: string
          description: First name.
          example: Jane
        LAST_NAME:
          type: string
          description: Last name.
          example: Smith
        DEPTID:
          type: string
          description: Department ID.
          example: '10200'
        JOBCODE:
          type: string
          description: Job code.
          example: MGR001
        POSITION_NBR:
          type: string
          description: Position number.
          example: '00012345'
        LOCATION:
          type: string
          description: Work location code.
          example: HQ001
        COMPANY:
          type: string
          description: Company code.
          example: CCB
        BUSINESS_UNIT:
          type: string
          description: Business unit.
          example: US001
        EMPL_STATUS:
          type: string
          description: Employment status.
          enum:
          - A
          - D
          - L
          - P
          - R
          - S
          - T
          - U
          - W
          - X
          example: A
        HR_STATUS:
          type: string
          description: HR status.
          enum:
          - A
          - I
          - D
          example: A
        REG_TEMP:
          type: string
          description: Regular or temporary.
          enum:
          - R
          - T
          example: R
        FULL_PART_TIME:
          type: string
          description: Full or part time.
          enum:
          - F
          - P
          example: F
        HIRE_DT:
          type: string
          format: date
          description: Hire date.
          example: '2020-01-15'
        TERMINATION_DT:
          type: string
          format: date
          description: Termination date.
        ANNUAL_RT:
          type: number
          description: Annual salary rate.
          example: 85000.0
        CURRENCY_CD:
          type: string
          description: Currency code.
          example: USD
        EMAIL_ADDR:
          type: string
          format: email
          description: Email address.
          example: jane.smith@example.com
        PHONE:
          type: string
          description: Phone number.
          example: 555-0123
        ADDRESS1:
          type: string
          description: Street address.
          example: 123 Main St
        CITY:
          type: string
          description: City.
          example: San Francisco
        STATE:
          type: string
          description: State code.
          example: CA
        POSTAL:
          type: string
          description: Postal code.
          example: '94105'
        COUNTRY:
          type: string
          description: Country code.
          example: USA
        SUPERVISOR_ID:
          type: string
          description: Supervisor employee ID.
          example: EMP000567
    Position:
      type: object
      description: PeopleSoft HCM position data.
      properties:
        POSITION_NBR:
          type: string
          description: Position number.
          example: '00012345'
        DESCR:
          type: string
          description: Position description.
          example: Senior Software Engineer
        DEPTID:
          type: string
          description: Department ID.
          example: '10200'
        JOBCODE:
          type: string
          description: Job code.
          example: MGR001
        LOCATION:
          type: string
          description: Location code.
          example: HQ001
        REPORTS_TO:
          type: string
          description: Reports-to position.
          example: '00012340'
        MAX_HEAD_COUNT:
          type: integer
          description: Maximum headcount.
          example: 1
        POSN_STATUS:
          type: string
          description: Position status.
          enum:
          - A
          - I
          - F
          example: A
        EFFDT:
          type: string
          format: date
          description: Effective date.
          example: '2024-01-01'