Oracle Fusion Cloud Applications Persons API

openapi: 3.1.0
info:
  title: Oracle Fusion Cloud Applications Oracle Fusion Common Features REST Absences Persons API
  description: REST APIs for Oracle Fusion Cloud Applications Common features, providing access to shared services such as attachments, flexfields, lookup types, roles, users, security, scheduled processes, announcements, and approval workflows used across all Fusion Cloud application pillars.
  version: 11.13.18.05
  contact:
    name: Oracle Support
    url: https://support.oracle.com
    email: support@oracle.com
  license:
    name: Oracle Cloud Services Agreement
    url: https://www.oracle.com/corporate/contracts/cloud-services/
  termsOfService: https://www.oracle.com/corporate/contracts/cloud-services/
servers:
- url: https://{instance}.oraclecloud.com
  description: Oracle Fusion Cloud Instance
  variables:
    instance:
      default: servername
      description: Your Oracle Cloud instance identifier
security:
- bearerAuth: []
tags:
- name: Persons
  description: Manage person records
paths:
  /fscmRestApi/resources/11.13.18.05/persons:
    get:
      operationId: listPersons
      summary: Oracle Fusion Cloud Applications List persons
      description: Retrieve person records used across Fusion Cloud applications.
      tags:
      - Persons
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/q'
      responses:
        '200':
          description: Persons retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Person'
                  count:
                    type: integer
                  hasMore:
                    type: boolean
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createPerson
      summary: Oracle Fusion Cloud Applications Create a person
      description: Create a new person record.
      tags:
      - Persons
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PersonCreate'
      responses:
        '201':
          description: Person created
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /fscmRestApi/resources/11.13.18.05/persons/{Personid}:
    get:
      operationId: getPerson
      summary: Oracle Fusion Cloud Applications Get a person
      description: Retrieve a specific person record by identifier.
      tags:
      - Persons
      parameters:
      - name: Personid
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Person details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Person'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    patch:
      operationId: updatePerson
      summary: Oracle Fusion Cloud Applications Update a person
      description: Update an existing person record.
      tags:
      - Persons
      parameters:
      - name: Personid
        in: path
        required: true
        schema:
          type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PersonCreate'
      responses:
        '200':
          description: Person updated
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      operationId: deletePerson
      summary: Oracle Fusion Cloud Applications Delete a person
      description: Delete an existing person record.
      tags:
      - Persons
      parameters:
      - name: Personid
        in: path
        required: true
        schema:
          type: integer
      responses:
        '204':
          description: Person deleted
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    PersonCreate:
      type: object
      required:
      - FirstName
      - LastName
      properties:
        FirstName:
          type: string
        LastName:
          type: string
        Email:
          type: string
          format: email
        PhoneNumber:
          type: string
    Person:
      type: object
      properties:
        Personid:
          type: integer
          description: Person identifier
        FirstName:
          type: string
          description: First name
        LastName:
          type: string
          description: Last name
        DisplayName:
          type: string
          description: Display name
        Email:
          type: string
          format: email
          description: Email address
        PhoneNumber:
          type: string
          description: Phone number
        CreationDate:
          type: string
          format: date-time
  responses:
    NotFound:
      description: The requested resource was not found
    BadRequest:
      description: Invalid request parameters or payload
    Unauthorized:
      description: Authentication credentials are missing or invalid
  parameters:
    q:
      name: q
      in: query
      required: false
      schema:
        type: string
    offset:
      name: offset
      in: query
      required: false
      schema:
        type: integer
        default: 0
    fields:
      name: fields
      in: query
      required: false
      schema:
        type: string
    limit:
      name: limit
      in: query
      required: false
      schema:
        type: integer
        default: 25
        maximum: 500
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    basicAuth:
      type: http
      scheme: basic
externalDocs:
  description: Oracle Fusion Cloud Applications Common Features REST API Documentation
  url: https://docs.oracle.com/en/cloud/saas/applications-common/26a/farca/index.html