Oracle Fusion Cloud Applications Assignments API

openapi: 3.1.0
info:
  title: Oracle Fusion Cloud Applications Oracle Fusion Common Features REST Absences Assignments 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: Assignments
  description: Manage work assignments and employment details
paths:
  /hcmRestApi/resources/11.13.18.05/assignmentsInfo:
    get:
      operationId: listAssignments
      summary: Oracle Fusion Cloud Applications List assignments
      description: Retrieve work assignment records including position, job, department, location, and manager information for workers.
      tags:
      - Assignments
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/q'
      - $ref: '#/components/parameters/finder'
      responses:
        '200':
          description: Assignments retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Assignment'
                  count:
                    type: integer
                  hasMore:
                    type: boolean
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    Assignment:
      type: object
      properties:
        AssignmentId:
          type: integer
          description: Assignment identifier
        AssignmentNumber:
          type: string
          description: Assignment number
        AssignmentName:
          type: string
          description: Assignment name
        PersonNumber:
          type: string
          description: Associated person number
        BusinessUnitName:
          type: string
          description: Business unit
        DepartmentName:
          type: string
          description: Department
        JobName:
          type: string
          description: Job title
        PositionName:
          type: string
          description: Position
        GradeName:
          type: string
          description: Grade
        LocationName:
          type: string
          description: Work location
        ManagerPersonNumber:
          type: string
          description: Manager person number
        ManagerDisplayName:
          type: string
          description: Manager name
        AssignmentStatus:
          type: string
          description: Status of the assignment
          enum:
          - Active
          - Suspended
          - Inactive
        EffectiveStartDate:
          type: string
          format: date
          description: Effective start date
        EffectiveEndDate:
          type: string
          format: date
          description: Effective end date
        WorkerType:
          type: string
          description: Worker type (Employee or Contingent Worker)
  parameters:
    q:
      name: q
      in: query
      required: false
      description: Filter expression using Oracle REST query syntax
      schema:
        type: string
    offset:
      name: offset
      in: query
      required: false
      description: Number of items to skip
      schema:
        type: integer
        default: 0
    fields:
      name: fields
      in: query
      required: false
      description: Comma-separated list of fields to return
      schema:
        type: string
    limit:
      name: limit
      in: query
      required: false
      description: Maximum number of items to return (default 25, max 500)
      schema:
        type: integer
        default: 25
        maximum: 500
    finder:
      name: finder
      in: query
      required: false
      description: Named finder in format FinderName;param1=value1
      schema:
        type: string
  responses:
    Unauthorized:
      description: Authentication credentials are missing or invalid
  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