• About the REST APIs
• All REST Endpoints

Get Started

• Introduction
• What's New in the Oracle Prime API
• REST Style Architecture
• Status Codes
• Using the Oracle Prime API
• Projection Support
• Sample Java Code that Invokes the API
• Troubleshooting the Oracle Prime API
• cURL Overview
• Using cURL
• Authentication and Authorization

Tasks

• Action
  • Close a project current period item.
  • Create a Project Baseline.
  • Creates a Capital Plan Snapshot.
  • Creates a Project Snapshot.
  • Returns the job status for the specified job Id.
  • Set current baseline.
  • Status of a Project baseline.
  • The scheduler API schedules the project and returns the job id. The Job id can be used to find out the job status.
• Activity
  • Creates activities.
  • Creates an activity.
  • Deletes the activities for the specified activity IDs.
  • Deletes the activity for the specified activity ID.
  • Finds and returns all child activities in the hierarchy of given Activity ID.
  • Returns activities specified by the assigned code value.
  • Returns activities specified by the assigned configured fields value.
  • Returns the activities for specified wbsId.
  • Returns the activity for the specified activity ID.
  • Returns the Activity specified by the Activity Code.
  • Returns the Activity specified by the Activity Code.
  • Updates activities for the specified activity IDs.
  • Updates the activity for the specified activity ID.
• Activity Risk
  • Creates activity risks.
  • Creates an activity risk.
  • Deletes the activity risk for the specified activity risk ID.
  • Deletes the activity risks for the specified activity risk IDs.
  • Returns the activity risk for the specified activity ID.
  • Returns the activity risk for the specified activity risk ID.
  • Updates activity risks for the specified activity risk IDs.
  • Updates the activity risk for the specified activity risk ID.
• Assignment
  • Creates a Assignment.
  • Creates Assignments.
  • Deletes the assignment for the specified assignment ID.
  • Deletes the assignments for the specified assignment IDs.
  • Returns assignments specified by the assigned configured fields values.
  • Returns the assignment for the specified Assignment ID.
  • Returns the assignment specified by the activity Id and assignment code.
  • Returns the assignment specified by the assignment code.
  • Returns the assignments specified by the Activity ID.
  • Updates assignments for the specified Assignment IDs.
  • Updates the assignment for the specified Assignment ID.
• Calendar
  • Creates a calendar.
  • Creates calendars.
  • Deletes the calendar for the specified calendar ID.
  • Deletes the calendars for the specified calendar IDs.
  • Returns all calendars associated with a workspace.
  • Returns the calendar exceptions for the specified calendar ID.
  • Returns the calendar for the specified calendar ID.
  • Returns the calendar specified by the calendar code.
  • Updates calendars for the specified calendar IDs.
  • Updates the calendar for the specified calendar ID.
• Capital Plan
  • Creates a CapitalPlan.
  • Creates a CapitalPlan.
  • Deletes the CapitalPlan for the specified CapitalPlan ID.
  • Deletes the CapitalPlans for the specified CapitalPlans IDs.
  • Returns the CapitalPlan for the specified CapitalPlan ID.
  • Returns the CapitalPlan for the specified Portfolio ID.
  • Returns the CapitalPlan for the specified Workspace ID.
  • Returns the CapitalPlan specified by the CapitalPlan name.
  • Returns the capitalPlans specified by the assigned Configured field value.
  • Updates the CapitalPlan for the specified CapitalPlan ID.
  • Updates the CapitalPlans for the specified CapitalPlan IDs.
• Capital Portfolio
  • Creates a Capital Portfolio.
  • Creates Capital Portfolios.
  • Deletes the Capital Portfolio for the specified Capital Portfolio ID.
  • Deletes the Capital Portfolio for the specified Capital Portfolio ID.
  • Returns the Capital Portfolio for the specified Capital Portfolio ID.
  • Returns the Capital Portfolio specified by the Capital Portfolio Name.
  • Updates the Capital Portfolio for the specified Capital Portfolio ID.
  • Updates the Capital Portfolios for the specified Capital Portfolios IDs.
• CBS
  • Creates a project CBS code.
  • Creates a workspace CBS code.
  • Creates the project costing source for the specific project.
  • Deletes the project CBS code for the specified workspace CBS ID.
  • Deletes the workspace CBS code for the specified workspace CBS ID.
  • Returns all CBS codes for the specified workspace ID or project ID.
  • Returns all CBS codes for the specified workspace ID or project ID.
  • Returns the project costing source for the specific project.
  • Returns the workspace/project CBS for the specified workspace CBS ID and type.
  • Updates the project CBS code for the specified project CBS ID.
  • Updates the project costing source for the specific project.
  • Updates the workspace CBS code for the specified workspace CBS ID.
• Code Value
  • Creates a code value.
  • Creates a code values.
  • Deletes the code value for the specified code value ID.
  • Deletes the code values for the specified code value IDs.
  • Finds and returns all child codeValues in the hierarchy of given CodeValue ID.
  • Returns the code value for specified CodeType Id and Workspace Id.
  • Returns the code value for the specified code value ID.
  • Returns the code values specified by the code type ID and value code.
  • Returns the code values specified by the code type ID.
  • Returns the code values specified by the code type name.
  • Updates the code value for the specified code value ID.
  • Updates the code values for the specified code values.
• CodeType
  • Creates a code type.
  • Creates a code types.
  • Creates Workspace CodeType.
  • Deletes the code type for the specified code type ID.
  • Deletes the code types for the specified code type IDs.
  • Finds and returns Code types based on ID of Workspace.
  • Finds and returns Code Types by Object type.
  • Returns the code type for the specified code type ID.
  • Updates the code type for the specified code type ID.
  • Updates the code types for the specified code types.
• Configured Fields
  • Creates a configured field.
  • Returns the configured field for the specified configured field ID.
  • Returns the configured field for the specified workspace ID.
  • Updates the configured field for the specified configured field ID.
• Cost Category
  • ??codeType_find_by_costCategoryType??
  • Creates a Cost Category.
  • Creates Cost Categories.
  • Deletes the Cost Categories for the specified Cost Category IDs.
  • Deletes the Cost Category for the specified Cost Category ID.
  • Returns Cost Categories for specified Workspace ID.
  • Returns the Cost Category for the specified cost category ID.
  • Returns the Cost Category for the specified cost category name.
  • Updates the Cost Categories for the specified Cost Category IDs.
  • Updates the Cost Category for the specified Cost Category ID.
• Currency
  • Creates a new currency.
  • Deletes the currency for the specified currency ID.
  • Returns list of currencies for the specified Workspace ID.
  • Returns the currency for the specified currency ID.
  • Returns the currency specified by the currency code.
  • Returns the currency specified by the currency name.
  • Updates the currency for the specified currency ID.
• Exchange Rate
  • Creates an exchange rate.
  • Returns the exchange rates for the specified currency ID.
  • Returns the exchange rates for the specified exchange rate ID.
• Holiday
  • Creates a new Holiday.
  • Creates Holidays.
  • Delete holidays for the specified holiday IDs.
  • Deletes an existing holiday identified by its Holiday ID.
  • Finds and returns a holiday identified by its Holiday ID.
  • Finds and returns a holiday identified by its holiday name.
  • Finds and returns holiday list identified by its Holiday Group ID.
  • Updates an existing holiday, identified by its Holiday ID.
  • Updates holidays for the specified holiday IDs.
• Holiday Group
  • Create Holiday Lists.
  • Creates a new Holiday List.
  • Delete holiday Lists for the specified Holiday GroupIDs.
  • Deletes an existing holiday list identified by its Holiday ListID.
  • Finds and returns a holiday group identified by its holiday group name.
  • Finds and returns a Holiday List identified by its Holiday ListID.
  • Update holiday Lists for the specified holiday groupIDs.
  • Updates an existing holiday list, identified by its Holiday ListID.
• Location
  • Creates a location.
  • Deletes the location specified by the location ID.
  • Deletes the locations specified by the location IDs.
  • Returns the location specified by the location code.
  • Returns the location specified by the location ID.
  • Returns the location specified by the location name.
  • Returns the location specified by the workspace ID.
  • Updates the location for the specified location ID.
• PBS
  • Creates a PBS.
  • Deletes the PBS children for the specified parent PBS ID.
  • Deletes the PBS for the specified PBS ID.
  • Finds and returns all child pbs in the hierarchy of given pbs ID.
  • Returns the PBS children for the specified PBS ID.
  • Returns the PBS for the specified PBS code.
  • Returns the PBS for the specified PBS code.
  • Returns the PBS for the specified PBS ID.
  • Returns the PBS for the specified PBS name.
  • Returns the PBS for the specified project ID.
  • Updates an existing PBS, identified by its PBS ID.
• Project
  • Creates a project.
  • Creates projects.
  • Deletes the project for the specified project ID.
  • Deletes the projects for the specified project IDs.
  • Returns the project for the specified project ID.
  • Returns the project specified by the project code.
  • Returns the project specified by the project name.
  • Returns the project specified by the workspace ID.
  • Returns the projects specified by the assigned code value.
  • Returns the projects specified by the assigned Configured field value.
  • Updates the project for the specified project ID.
  • Updates the projects for the specified project IDs.
• Project Budget
  • Creates a Project Budget.
  • Creates Project Budgets.
  • Deletes the Project budget for the ProjectId provided.
  • Deletes the Project budgets for the ProjectIds provided.
  • Returns the Project budget for the ProjectId provided.
  • Updates Project Budgets.
  • Updates the Project Budget for the ProjectId provided.
• Project Budget Change
  • Creates a Project Budget Change.
  • Creates Project Budget Changes.
  • Deletes the Project budget change for the ID provided.
  • Deletes the Project budget changes for the IDs provided.
  • Returns the Project budget changes for the code provided.
  • Returns the Project budget changes for the Id provided.
  • Updates Project Budget Changes.
  • Updates the Project Budget Change for the Id provided.
• Project Budget Transfer
  • Creates a Project Budget Transfer.
  • Creates Project Budget Transfers.
  • Deletes the Project budget Transfer for the ID provided.
  • Deletes the Project budget Transfers for the IDs provided.
  • Returns the Project budget Transfers for the code provided.
  • Returns the Project budget Transfers for the ID provided.
  • Updates Project Budget Transfers.
  • Updates the Project Budget Transfer for the Id provided.
• Project Risk
  • ??project_resource_find_ProjectRisks_By_UdfValue??
  • ??risk_resource_find_by_name??
  • Creates Project Risk.
  • Creates Project Risks.
  • Deletes the Project Risk specified by the Project Risk ID.
  • Deletes the Project Risks specified by the Project Risk IDs.
  • Returns Project Risk by Risk.
  • Returns Project risk for specific Project and Risk.
  • Returns Project Risk for specified Project ID and Risk Code.
  • Returns Project Risks of specified Project ID.
  • Returns Risk Mitigation for specified Project Risk ID.
  • Returns the Project Risk for specified Project Risk ID.
  • Update Project Risk.
  • Updates Project Risks for specified Project Risk IDs.
• ProjectActuals
  • Creates a ProjectActuals.
  • Creates ProjectActuals.
  • Returns the ProjectActuals for the specified project ID.
  • Returns the ProjectActuals for the specified ProjectActuals ID.
  • Returns the projectActuals specified by the assigned Configured field value.
  • Returns the ProjectActuals specified by the ProjectActuals Code.
  • Updates ProjectActuals.
  • Updates the ProjectActuals for the specified ProjectActuals ID.
• ProjectActualsLineItems
  • Creates a ProjectActuals line items.
  • Creates ProjectActuals line items.
  • Deletes the ProjectActuals line items specified by the ProjectActuals line items ID.
  • Deletes the ProjectActuals line items specified by the ProjectActuals line items IDs.
  • Returns the Project Actuals line items for the specified ProjectActuals ID.
  • Returns the ProjectActuals line items specified by the ProjectActuals line items Code.
  • Updates ProjectActuals line items.
  • Updates the ProjectActuals line items for the specified ProjectActuals line items ID.
• ProjectDependency
  • Creates a Project Dependencies.
  • Creates a Project Dependency.
  • Deletes the Project Dependencies specified by the Project Dependency IDs.
  • Deletes the Project Dependency specified by the Project Dependency ID.
  • Returns the Project Dependencies for the specified Dependency project ID.
  • Returns the Project Dependencies for the specified Supported project ID.
  • Returns the Project Dependency for the specified ProjectDependency ID.
  • Updates the Project Dependencies for the specified Project Dependency IDs.
  • Updates the Project Dependency for the specified Project Dependency ID.
• Relationship
  • Creates activity relationships.
  • Creates an activity relationship.
  • Deletes the activity relationship for the specified relationship ID.
  • Deletes the activity relationships for the specified relationship IDs.
  • Returns all relationships of the given activity ID.
  • Returns the activity relationship for the specified relationship ID.
  • Updates activity relationships for the specified relationship IDs.
  • Updates the activity relationship for the specified relationship ID.
• Resource
  • Creates a resource or role.
  • Creates a resources or roles.
  • Deletes the resource or role for the specified resource ID.
  • Deletes the resources or roles for the specified resource IDs.
  • Finds and returns all child resources/roles in the hierarchy of given Resource ID.
  • Returns resources specified by the assigned code value.
  • Returns the resource for the specified resource class.
  • Returns the resource for the specified resource code and type (labor, nonlabor, or material).
  • Returns the resource or role for the specified resource ID.
  • Returns the resources and roles for the given ProjectId.
  • Returns the resources and roles for the given WorkspaceId.
  • Updates the resource or role for the specified resource ID.
  • Updates the resources or roles for the specified resource IDs.
• Resource Demand
  • Creates a Resource Demand.
  • Creates Resource Demands.
  • Deletes the Resource Demand for the specified Resource Demand ID.
  • Deletes the Resource Demands for the specified Resource Demand IDs.
  • Returns the Resource Demand for the specified Resource Demand ID.
  • Updates the Resource Demand for the specified Resource Demand ID.
  • Updates the Resource Demands for the specified Resource Demand IDs.
• Resource Role Assignment
  • ??resourceRoleAssignment_resource_batch_delete??
  • Creates a Resource-Role Assignment.
  • Creates Resource-Role Assignments.
  • Deletes the Resource-Role Assignment for the ResourceRoleAssignmentId provided.
  • Returns the Resource-Role Assignment for the ResourceRoleAssignmentId provided.
  • Returns the Resource-Role Assignment satisfying the Primary flag specified.
  • Updates Resource-Role Assignments.
  • Updates the Resource-Role Assignment for the ResourceRoleAssignmentId provided.
• Resource Work Rate
  • Creates a maximum work units per time period.
  • Creates a maximum work units per time periods.
  • Deletes the maximum work units per time period for the specified resource work rate ID.
  • Deletes the maximum work units per time period for the specified resource work rate IDs.
  • Returns the maximum work units per time period for the specified resource ID.
  • Returns the maximum work units per time period for the specified resource work rate ID.
  • Updates the maximum work units per time period for the specified resource work rate ID.
  • Updates the maximum work units per time period for the specified resource work rate IDs.
• Risk Category
  • Creates Risk Category.
  • Deletes the Risk Category for specified Risk Category ID.
  • Returns Risk Category for specified Risk Category Name.
  • Returns the Risk Category for specified Risk Category ID.
  • Updates Risk Category.
• Risk Impact
  • Creates a risk impact.
  • Creates risk impacts.
  • Deletes the risk impact for the specified risk impact ID.
  • Deletes the risk impacts for the specified risk impact IDs.
  • Return Risk Impacts that belongs to Project Risk ID, Risk Score Type ID, Risk Score Threshold ID.
  • Returns the risk impact for the specified risk impact ID.
  • Updates the risk impact for the specified risk impact ID.
  • Updates the risk impacts for the specified risk impact IDs.
• Risk Matrix
  • Creates a risk matrix.
  • Creates risk matrices.
  • Deletes the risk matrices for the specified risk matrix IDs.
  • Deletes the risk matrix for the specified risk matrix ID.
  • Returns the risk matrices for the specified Workspace ID.
  • Returns the risk matrix for the specified risk matrix ID.
  • Returns the risk matrix specified by the risk matrix code.
  • Returns the risk matrix specified by the risk matrix name.
  • Returns the workspace risk matrix template with the given name.
  • Updates the risk matrices for the specified risk matrix IDs.
  • Updates the risk matrix for the specified risk matrix ID.
• Risk Score Type
  • Creates a Risk Threshold.
  • Creates Risk Thresholds.
  • Deletes the Risk Threshold for the specified Risk Threshold ID.
  • Returns all Risk Score Types for specified Workspace ID.
  • Returns Risk Thresholds identified by Risk Score Type ID.
  • Returns Risk Thresholds identified by Risk Threshold Code and Risk Score Type ID.
  • Returns the Risk Threshold for the specified Risk Threshold code.
  • Returns the Risk Threshold for the specified Risk Threshold ID.
  • Returns the Risk Threshold for the specified Risk Threshold name and projectId.
  • Returns the Risk Threshold for the specified Risk Threshold name.
  • Updates a Risk Threshold.
  • Updates Risk Thresholds.
• RiskMitigation
  • Creates a Risk Mitigation.
  • Creates Risk Mitigations.
  • Deletes the Risk Mitigation specified by the Risk mitigation ID.
  • Deletes the Risk Mitigations specified by the Risk Mitigation IDs.
  • Returns the Risk Mitigation for the specified project ID.
  • Returns the Risk Mitigation specified by the Risk Mitigation Code.
  • Updates the Risk Mitigation for the specified Risk Mitigation ID.
  • Updates the Risk Mitigations for the specified Risk Mitigation IDs.
• Scope Item
  • Creates a scope item.
  • Deletes the scope item for the specified scope item ID.
  • Returns scope items specified by the assigned code value.
  • Returns scope items specified by the assigned configured field value.
  • Returns the scope item for the specified PBS ID.
  • Returns the scope item for the specified scope item code.
  • Returns the scope item for the specified scope item code.
  • Returns the scope item for the specified scope item ID.
  • Returns the scope item for the specified scope item name.
  • Returns the scope items for the specified project.
  • Updates the scope item for the specified scope item ID.
• Scope Item Assignment
  • Creates a scope item assignment.
  • Deletes the scope item assignment for the specified scope item assignment ID.
  • Returns scope item assignments specified by the assigned code value.
  • Returns scope item assignments specified by the assigned configured field value.
  • Returns the scope item assignment for the specified scope item assignment code.
  • Returns the scope item assignment for the specified scope item assignment ID.
  • Returns the scope item assignments for the specified project.
  • Returns the scope item assignments for the specified Scope ID.
  • Returns the scope item assignments for the specified work package ID.
  • Updates the scope item assignment for the specified scope item assignment ID.
• Segment
  • Creates a project segment.
  • Creates a project segment.
  • Creates a workspace segment.
  • Returns the workspace segment for the specified workspace segment ID.
  • Returns the workspace segments for the specified workspace or project ID.
  • Returns the workspace segments for the specified workspace or project ID.
  • Updates the workspace segment for the specified workspace segment ID.
• Units Of Measure
  • Creates a Units of Measure.
  • Creates Units of Measures.
  • Deletes the Units of Measure for the specified Units of Measure ID.
  • Deletes the Units of Measures for the specified Units of Measure IDs.
  • Returns the Units of Measure for the specified units of Measure code.
  • Returns the Units of Measure for the specified units of Measure ID.
  • Returns the Units of Measure for the specified units of Measure name.
  • Returns the Units of Measures for the specified Workspace ID.
  • Updates the Units of Measure for the specified Units of Measure ID.
  • Updates the Units of Measures for the specified Units of Measure IDs.
• WBS
  • Creates a WBS.
  • Deletes the WBS children specified by the WBS parent ID.
  • Deletes the WBS for the specified WBS ID.
  • Finds and returns all child wbs in the hierarchy of given Wbs ID.
  • Returns list of wbs specifies by assigned code value.
  • Returns list of wbs specifies by assigned configured field value.
  • Returns the WBS children.
  • Returns the WBS for the specified project.
  • Returns the WBS for the specified WBS code,parent WBS code and project Id.
  • Returns the WBS for the specified WBS code.
  • Returns the WBS for the specified WBS ID.
  • Returns the WBS for the specified WBS name.
  • Updates the WBS for the specified WBS ID.
• Work Package
  • Creates a work package.
  • Deletes the work package for the specified work package ID.
  • Returns the work package for the specified project ID and work package code.
  • Returns the work package for the specified project ID and work package name.
  • Returns the work package for the specified work package ID.
  • Returns the work packages for the specified project ID.
  • Returns work packages specified by assigned code value.
  • Returns work packages specified by assigned configured field value.
  • Updates the work package for the specified work package ID.
• Workspace
  • Creates a workspace.
  • Creates workspaces.
  • Deletes the workspace for the specified workspace ID.
  • Deletes the workspace for the specified workspace IDs.
  • Finds and returns all child workspaces in the hierarchy of given Workspace ID.
  • Finds and returns direct child workspaces of given Workspace ID.
  • Returns all workspaces. This includes parent and child record.
  • Returns the root workspace.
  • Returns the workspace for the specified workspace code.
  • Returns the workspace for the specified workspace ID.
  • Updates the workspace for the specified workspace ID.
  • Updates the workspaces for the specified workspace IDs.