Oracle EBS Human Resources API — Employee Management

naftiko: 1.0.0-alpha2
info:
  label: Oracle EBS Human Resources API — Employee Management
  description: 'Oracle EBS Human Resources API — Employee Management. 5 operations. Lead operation: Retrieve Employee Assignments.
    Self-contained Naftiko capability covering one Oracle E Business Suite business surface.'
  tags:
  - Oracle E Business Suite
  - Employee Management
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ORACLE_E_BUSINESS_SUITE_API_KEY: ORACLE_E_BUSINESS_SUITE_API_KEY
capability:
  consumes:
  - type: http
    namespace: human-resources-employee-management
    baseUri: https://{instance}.oracle.com/webservices/rest
    description: Oracle EBS Human Resources API — Employee Management business capability. Self-contained, no shared references.
    resources:
    - name: hr-assignments
      path: /hr/assignments
      operations:
      - name: getassignments
        method: GET
        description: Retrieve Employee Assignments
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: assignmentId
          in: query
          type: integer
          description: Assignment identifier
        - name: personId
          in: query
          type: integer
          description: Person identifier
        - name: organizationId
          in: query
          type: integer
          description: HR organization identifier
        - name: effectiveDate
          in: query
          type: string
          description: Effective date (YYYY-MM-DD)
    - name: hr-employees
      path: /hr/employees
      operations:
      - name: getemployees
        method: GET
        description: Retrieve Employee Records
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: personId
          in: query
          type: integer
          description: Person identifier
        - name: employeeNumber
          in: query
          type: string
          description: Employee number
        - name: fullName
          in: query
          type: string
          description: Full name (supports wildcards)
        - name: businessGroupId
          in: query
          type: integer
          description: Business group identifier
        - name: effectiveDate
          in: query
          type: string
          description: Effective date for date-tracked records (YYYY-MM-DD)
      - name: createemployee
        method: POST
        description: Create an Employee Record
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: hr-employees-personId
      path: /hr/employees/{personId}
      operations:
      - name: getemployeebyid
        method: GET
        description: Retrieve an Employee by Person Id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: personId
          in: path
          type: integer
          required: true
        - name: effectiveDate
          in: query
          type: string
          description: Effective date for date-tracked records (YYYY-MM-DD)
      - name: updateemployee
        method: PUT
        description: Update an Employee Record
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: personId
          in: path
          type: integer
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: apikey
      key: accessToken
      value: '{{env.ORACLE_E_BUSINESS_SUITE_API_KEY}}'
      placement: cookie
  exposes:
  - type: rest
    namespace: human-resources-employee-management-rest
    port: 8080
    description: REST adapter for Oracle EBS Human Resources API — Employee Management. One Spectral-compliant resource per
      consumed operation, prefixed with /v1.
    resources:
    - path: /v1/hr/assignments
      name: hr-assignments
      description: REST surface for hr-assignments.
      operations:
      - method: GET
        name: getassignments
        description: Retrieve Employee Assignments
        call: human-resources-employee-management.getassignments
        with:
          assignmentId: rest.assignmentId
          personId: rest.personId
          organizationId: rest.organizationId
          effectiveDate: rest.effectiveDate
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/hr/employees
      name: hr-employees
      description: REST surface for hr-employees.
      operations:
      - method: GET
        name: getemployees
        description: Retrieve Employee Records
        call: human-resources-employee-management.getemployees
        with:
          personId: rest.personId
          employeeNumber: rest.employeeNumber
          fullName: rest.fullName
          businessGroupId: rest.businessGroupId
          effectiveDate: rest.effectiveDate
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createemployee
        description: Create an Employee Record
        call: human-resources-employee-management.createemployee
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/hr/employees/{personid}
      name: hr-employees-personid
      description: REST surface for hr-employees-personId.
      operations:
      - method: GET
        name: getemployeebyid
        description: Retrieve an Employee by Person Id
        call: human-resources-employee-management.getemployeebyid
        with:
          personId: rest.personId
          effectiveDate: rest.effectiveDate
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateemployee
        description: Update an Employee Record
        call: human-resources-employee-management.updateemployee
        with:
          personId: rest.personId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: human-resources-employee-management-mcp
    port: 9090
    transport: http
    description: MCP adapter for Oracle EBS Human Resources API — Employee Management. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: retrieve-employee-assignments
      description: Retrieve Employee Assignments
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: human-resources-employee-management.getassignments
      with:
        assignmentId: tools.assignmentId
        personId: tools.personId
        organizationId: tools.organizationId
        effectiveDate: tools.effectiveDate
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-employee-records
      description: Retrieve Employee Records
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: human-resources-employee-management.getemployees
      with:
        personId: tools.personId
        employeeNumber: tools.employeeNumber
        fullName: tools.fullName
        businessGroupId: tools.businessGroupId
        effectiveDate: tools.effectiveDate
      outputParameters:
      - type: object
        mapping: $.
    - name: create-employee-record
      description: Create an Employee Record
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: human-resources-employee-management.createemployee
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-employee-person-id
      description: Retrieve an Employee by Person Id
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: human-resources-employee-management.getemployeebyid
      with:
        personId: tools.personId
        effectiveDate: tools.effectiveDate
      outputParameters:
      - type: object
        mapping: $.
    - name: update-employee-record
      description: Update an Employee Record
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: human-resources-employee-management.updateemployee
      with:
        personId: tools.personId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.