PeopleSoft Search Framework API

openapi: 3.1.0
info:
  title: PeopleSoft Search Framework API
  description: Search indexing and query capabilities powered by OpenSearch (previously Elasticsearch) for full-text search, analytics dashboards, and PeopleSoft Insights.
  version: 1.0.0
  contact:
    name: Oracle Support
    email: [email protected]
    url: https://support.oracle.com
  license:
    name: Proprietary
    url: https://www.oracle.com/contracts/
servers:
- url: https://{hostname}:{port}/psft/api/search/v1
  description: PeopleSoft Instance
  variables:
    hostname:
      description: PeopleSoft server hostname
      default: localhost
    port:
      description: PeopleSoft server port
      default: '8000'
externalDocs:
  description: PeopleSoft Search Framework Documentation
  url: https://docs.oracle.com/cd/E52319_01/infoportal/search.html
tags:
- name: Search
  description: Search and indexing operations
paths:
  /search:
    get:
      summary: PeopleSoft Search Content
      description: Execute a full-text search across PeopleSoft indexed content.
      operationId: searchContent
      tags:
      - Search
      security:
      - basicAuth: []
      parameters:
      - name: q
        in: query
        required: true
        description: Search query string
        schema:
          type: string
        example: example_value
      - name: category
        in: query
        description: Search category to filter results
        schema:
          type: string
        example: example_value
      - name: maxResults
        in: query
        description: Maximum number of results to return
        schema:
          type: integer
        example: 42
      responses:
        '200':
          description: Search results
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    type: array
                    items:
                      type: object
                  totalCount:
                    type: integer
        '401':
          description: Unauthorized
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /index:
    post:
      summary: PeopleSoft Trigger Index Build
      description: Trigger a search index build or incremental update.
      operationId: triggerIndexBuild
      tags:
      - Search
      security:
      - basicAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                indexName:
                  type: string
                  description: Name of the search index
                buildType:
                  type: string
                  enum:
                  - full
                  - incremental
                  description: Type of index build
      responses:
        '202':
          description: Index build initiated
        '401':
          description: Unauthorized
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic