PeopleSoft Employees API

openapi: 3.1.0
info:
  title: PeopleSoft Application Services Framework Accounts Payable Employees API
  description: Modern REST API layer introduced in PeopleTools 8.59 that produces fully compliant OpenAPI/Swagger specifications, supports proper HTTP status codes, uniform URLs, and JSON payloads for integration with Oracle Integration Cloud, mobile apps, and microservices.
  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/asf/v1
  description: PeopleSoft Instance
  variables:
    hostname:
      description: PeopleSoft server hostname
      default: localhost
    port:
      description: PeopleSoft server port
      default: '8000'
tags:
- name: Employees
  description: Employee data 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
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://{hostname}:{port}/psft/oauth/authorize
          tokenUrl: https://{hostname}:{port}/psft/oauth/token
          scopes: {}
externalDocs:
  description: Application Services Framework Documentation
  url: https://docs.oracle.com/cd/E52319_01/infoportal/asf.html