Oracle Primavera WBS API

Work Breakdown Structure management

OpenAPI Specification

oracle-primavera-wbs-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Oracle Primavera P6 EPPM REST Activities WBS API
  description: Oracle Primavera P6 EPPM REST API provides programmatic access to enterprise project portfolio management data including WBS structures, activity schedules, resource assignments, critical path analysis, and portfolio dashboards. Available for both cloud and on-premises deployments.
  version: 26.0.0
  contact:
    name: Oracle Support
    url: https://support.oracle.com
  license:
    name: Oracle Technology Network License
    url: https://www.oracle.com/legal/terms/
servers:
- url: https://{host}/p6ws/rest/v1
  description: P6 EPPM REST API
  variables:
    host:
      default: primavera.example.com
      description: P6 EPPM server hostname
security:
- basicAuth: []
- oauth2: []
tags:
- name: WBS
  description: Work Breakdown Structure management
paths:
  /wbss:
    get:
      operationId: listWBS
      summary: List WBS elements
      description: Returns Work Breakdown Structure elements for projects.
      tags:
      - WBS
      parameters:
      - name: Fields
        in: query
        schema:
          type: string
          example: ObjectId,Code,Name,ProjectObjectId,ParentObjectId,SequenceNumber
      - name: Filter
        in: query
        schema:
          type: string
      - name: offset
        in: query
        schema:
          type: integer
          default: 0
      - name: limit
        in: query
        schema:
          type: integer
          default: 100
      responses:
        '200':
          description: List of WBS elements
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/WBSElement'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    WBSElement:
      type: object
      description: A Work Breakdown Structure element
      properties:
        ObjectId:
          type: integer
        Code:
          type: string
        Name:
          type: string
        ProjectObjectId:
          type: integer
        ParentObjectId:
          type: integer
          nullable: true
        SequenceNumber:
          type: integer
        StatusCode:
          type: string
          enum:
          - Active
          - Inactive
        OBSObjectId:
          type: integer
    Error:
      type: object
      properties:
        ErrorCode:
          type: integer
        ErrorMessage:
          type: string
  responses:
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication with P6 username and password
    oauth2:
      type: oauth2
      description: Oracle Identity Cloud Service OAuth2
      flows:
        authorizationCode:
          authorizationUrl: https://identity.oraclecloud.com/oauth2/v1/authorize
          tokenUrl: https://identity.oraclecloud.com/oauth2/v1/token
          scopes:
            read: Read access to P6 data
            write: Write access to P6 data