Oracle Fusion Cloud Applications Planning API

openapi: 3.1.0
info:
  title: Oracle Fusion Cloud Applications Oracle Fusion Common Features REST Absences Planning 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: Planning
  description: Planning application data and metadata operations
paths:
  /HyperionPlanning/rest/v3/applications/{applicationName}/plantypes/{planType}/exportdataslice:
    post:
      operationId: exportDataSlice
      summary: Oracle Fusion Cloud Applications Export a data slice
      description: Export planning data for a specified slice defined by dimension member selections, point-of-view, and filters.
      tags:
      - Planning
      parameters:
      - name: applicationName
        in: path
        required: true
        schema:
          type: string
      - name: planType
        in: path
        required: true
        description: Plan type name
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataSliceRequest'
      responses:
        '200':
          description: Data slice exported
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataSliceResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /HyperionPlanning/rest/v3/applications/{applicationName}/plantypes/{planType}/importdataslice:
    post:
      operationId: importDataSlice
      summary: Oracle Fusion Cloud Applications Import a data slice
      description: Import planning data into a specified plan type using dimension member intersections and values.
      tags:
      - Planning
      parameters:
      - name: applicationName
        in: path
        required: true
        schema:
          type: string
      - name: planType
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataSliceImport'
      responses:
        '200':
          description: Data slice imported
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  details:
                    type: string
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    DataSliceResponse:
      type: object
      properties:
        rows:
          type: array
          items:
            type: object
            properties:
              headers:
                type: array
                items:
                  type: string
              data:
                type: array
                items:
                  type: number
          description: Data rows with headers and values
        status:
          type: integer
    DataSliceImport:
      type: object
      properties:
        aggregateEssbaseData:
          type: boolean
          description: Whether to aggregate data
        cellNotesOption:
          type: string
          description: Cell notes handling option
        dateFormat:
          type: string
          description: Date format for the import
        dataGrid:
          type: object
          properties:
            pov:
              type: array
              items:
                type: string
            columns:
              type: array
              items:
                type: array
                items:
                  type: string
            rows:
              type: array
              items:
                type: object
                properties:
                  headers:
                    type: array
                    items:
                      type: string
                  data:
                    type: array
                    items:
                      type: number
    DataSliceRequest:
      type: object
      properties:
        exportPlanningData:
          type: boolean
          description: Whether to export planning data
          default: true
        gridDefinition:
          type: object
          properties:
            suppressMissingBlocks:
              type: boolean
            suppressMissingRows:
              type: boolean
            pov:
              type: object
              description: Point-of-view dimension selections
            columns:
              type: array
              items:
                type: object
              description: Column dimension members
            rows:
              type: array
              items:
                type: object
              description: Row dimension members
  responses:
    BadRequest:
      description: Invalid request parameters or payload
    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