All REST Endpoints

Action
The Action service enables you to schedule jobs, work with project baselines and snapshots, and manage project period items. A job represents a background process within the application. Prime includes several background services that may initiate jobs, such as scheduler, leveler, risk analysis, and measures. Completed scheduling, leveling, and measure jobs generate job logs that include additional details about the service.
Apply Activity Uncertainty
Method: post
Path: /primeapi/restapi/action/applyActivityUncertainity/run
Close a Project Current Period Item
Method: post
Path: /primeapi/restapi/action/periodCloseout
Create a Budget Plan Snapshot
Method: post
Path: /primeapi/restapi/action/capitalPlanSnapshot
Create a Project Baseline
Method: post
Path: /primeapi/restapi/action/createBaseline
Create a Project Snapshot
Method: post
Path: /primeapi/restapi/action/projectSnapshot
Delete a Budget Plan Snapshot
Method: delete
Path: /primeapi/restapi/action/capitalPlan/snapshot/{id}
Delete a Project Snapshot
Method: delete
Path: /primeapi/restapi/action/project/snapshot/{id}
Download a Report
Method: get
Path: /primeapi/restapi/action/reportResult/{jobId}
Perform Project Resource Leveling
Method: post
Path: /primeapi/restapi/action/level
Run a Report
Method: post
Path: /primeapi/restapi/action/report/run
Schedule a Project
Method: post
Path: /primeapi/restapi/action/scheduleProject
Schedule Measure Computation
Method: post
Path: /primeapi/restapi/action/computeMeasure
Schedule Measure Computation
Method: post
Path: /primeapi/restapi/action/computeStrategyMeasure
Schedule Risk Analysis
Method: post
Path: /primeapi/restapi/action/runRiskAnalysis
Set a Current Baseline
Method: put
Path: /primeapi/restapi/action/setCurrentBaseline
View Job Status
Method: get
Path: /primeapi/restapi/action/jobStatus/{jobId}
View Job Status and Job Log
Method: get
Path: /primeapi/restapi/action/jobStatusWithLog/{jobId}
View Project Baseline Status
Method: get
Path: /primeapi/restapi/action/baselineStatus/{id}
View Snapshots by Budget Plan ID
Method: get
Path: /primeapi/restapi/action/snapshot/capitalPlan/{id}
View Snapshots by Project ID
Method: get
Path: /primeapi/restapi/action/snapshot/project/{id}
Activity
Use the Activity service to create, view, update, and delete activities. Activities represent units of work that must be completed to accomplish your project objectives. Activities typically have durations, resource or role requirements, and logical relationships with other project activities.
Batch Create Activities
Method: post
Path: /primeapi/restapi/activity/batch
Batch Delete Activities
Method: delete
Path: /primeapi/restapi/activity/batch
Batch Update Activities
Method: put
Path: /primeapi/restapi/activity/batch
Create an Activity
Method: post
Path: /primeapi/restapi/activity
Delete an Activity
Method: delete
Path: /primeapi/restapi/activity/{id}
Update an Activity
Method: put
Path: /primeapi/restapi/activity
View Activities by Configured Field
Method: get
Path: /primeapi/restapi/activity/project/{id}/configuredField/{viewColumnName}/{value}
View Activities by Project
Method: get
Path: /primeapi/restapi/activity/project/{id}
View Activities by Project, Code Type, and Code Value
Method: get
Path: /primeapi/restapi/activity/project/{id}/codeType/{typeId}/codeValue/{code}
View Activities by WBS
Method: get
Path: /primeapi/restapi/activity/wbsId/{id}
View Activity Configured Fields
Method: get
Path: /primeapi/restapi/activity/{id}/configuredFields
View all activities by parent code.
Method: get
Path: /primeapi/restapi/activity/byParent?workspaceCode={workspaceCode}&projectCode={projectCode}
View all Child Activities of an Activity
Method: get
Path: /primeapi/restapi/activity/{id}/childrenHierarchy
View an Activity
Method: get
Path: /primeapi/restapi/activity/{id}
View an activity by code
Method: get
Path: /primeapi/restapi/activity/byItemCode?workspaceCode={workspaceCode}&projectCode={projectCode}&activityCode={activityCode}
View an Activity by Code
Method: get
Path: /primeapi/restapi/activity/code/{code}
View an Activity by Project and Activity Code
Method: get
Path: /primeapi/restapi/activity/project/{id}/code/{code}
Activity Aggregate
Use the Activity Aggregate service to view activity groupings. Activity aggregates sum the activity data of activities that meet certain criteria. Use activity aggregates to access a general overview of activity data for a particular project, work package, or portfolio.
View a WBS Activity Aggregate by Project
Method: get
Path: /primeapi/restapi/activityAggregate/wbs/projects?id={id}
View a Work Package Activity Aggregate by Portfolio
Method: get
Path: /primeapi/restapi/activityAggregate/workPackage/portfolio?id={id}
View a Work Package Activity Aggregate by Projects
Method: get
Path: /primeapi/restapi/activityAggregate/workPackage/project?id={id}
View an Activity Aggregate
Method: get
Path: /primeapi/restapi/activityAggregate/{id}
View an Activity Aggregate by Project
Method: get
Path: /primeapi/restapi/activityAggregate/projects?id={id}
Activity Favorite
Use the Activity Favorite service to create, view, update, and delete activity favorites. Activities represent units of work that must be completed to accomplish your project objectives. Activities typically have durations, resource or role requirements, and logical relationships with other project activities. Mark objects as favorites in order to access them within the Favorites section of apps and Browse popovers.
Batch Create Activity Favorites
Method: post
Path: /primeapi/restapi/activityFavorite/batch
Batch Delete Activity Favorites
Method: delete
Path: /primeapi/restapi/activityFavorite/batch
Create an Activity Favorite
Method: post
Path: /primeapi/restapi/activityFavorite
Delete an Activity Favorite
Method: delete
Path: /primeapi/restapi/activityFavorite/{id}
View Activity Favorites by User
Method: get
Path: /primeapi/restapi/activityFavorite/userId/{userId}
View Activity Favorites by User and Activity
Method: get
Path: /primeapi/restapi/activityFavorite/userId/{userId}/activityId/{activityId}
View an Activity Favorite
Method: get
Path: /primeapi/restapi/activityFavorite/{id}
Activity Risk
Use the Activity risk service to create, view, update, and delete activity risks. Activity Risks indicate whether risks from the project risk register will impact a project activity and potentially cause schedule delays. Activity risks represent the assignment of a risk to an activity, and are also used during the risk analysis process to simulate the impact of project risks on activities.
Batch Create Activity Risks
Method: post
Path: /primeapi/restapi/activityRisk/batch
Batch Delete Activity Risks
Method: delete
Path: /primeapi/restapi/activityRisk/batch
Batch Update Activity Risks
Method: put
Path: /primeapi/restapi/activityRisk/batch
Create an Activity Risk
Method: post
Path: /primeapi/restapi/activityRisk
Delete an Activity Risk
Method: delete
Path: /primeapi/restapi/activityRisk/{id}
Update an Activity Risk
Method: put
Path: /primeapi/restapi/activityRisk
View an Activity Risk
Method: get
Path: /primeapi/restapi/activityRisk/{id}
View an Activity Risk by Activity
Method: get
Path: /primeapi/restapi/activityRisk/activity/{activityId}
Application User Group
Use the Application User Group service to create, view, update, and delete user groups.
Batch Create User Groups
Method: post
Path: /primeapi/restapi/applicationUserGroup/batch
Batch Update User Groups
Method: put
Path: /primeapi/restapi/applicationUserGroup/batch
Create a User Group
Method: post
Path: /primeapi/restapi/applicationUserGroup
Update a User Group
Method: put
Path: /primeapi/restapi/applicationUserGroup
View a User Group
Method: get
Path: /primeapi/restapi/applicationUserGroup/{id}
View a User Group by Name
Method: get
Path: /primeapi/restapi/applicationUserGroup/name/{name}
Assignment
The Assignment service enables you to create, view, update, and delete assignments. Assignments represent the allocation of project or workspace resources to project activities.
Batch Create Assignments
Method: post
Path: /primeapi/restapi/assignment/batch
Batch Create Assignments
Method: post
Path: /primeapi/restapi/assignment/gateway/batch
Batch Delete Assignments
Method: delete
Path: /primeapi/restapi/assignment/batch
Batch Update Assignments
Method: put
Path: /primeapi/restapi/assignment/batch
Batch Update Assignments
Method: put
Path: /primeapi/restapi/assignment/gateway/batch
Create an Assignment
Method: post
Path: /primeapi/restapi/assignment
Delete an Assignment
Method: delete
Path: /primeapi/restapi/assignment/{id}
Update an Assignment
Method: put
Path: /primeapi/restapi/assignment
View an Assignment
Method: get
Path: /primeapi/restapi/assignment/{id}
View an Assignment by Resource
Method: get
Path: /primeapi/restapi/assignment/resource/{id}
View an Assignment by Resource Code
Method: get
Path: /primeapi/restapi/assignment/resource/code/{code}
View Assignment by Activity and Code
Method: get
Path: /primeapi/restapi/assignment/activity/{id}/code/{code}
View Assignment by Code
Method: get
Path: /primeapi/restapi/assignment/code/{code}
View Assignment Configured Fields
Method: get
Path: /primeapi/restapi/assignment/{id}/configuredFields
View Assignments by Activity
Method: get
Path: /primeapi/restapi/assignment/activityId/{id}
View Assignments by Configured Field Values
Method: get
Path: /primeapi/restapi/assignment/project/{id}/configuredField/{viewColumnName}/{value}
Assignment Favorite
The Assignment Favorite service enables you to mark or unmark assignments as favorites. Assignments represent the allocation of project or workspace resources to project activities. Mark objects as favorites in order to access them within the Favorites section of apps and Browse popovers.
Batch Create Assignment Favorites
Method: post
Path: /primeapi/restapi/assignmentFavorite/batch
Batch Delete Assignment Favorites
Method: delete
Path: /primeapi/restapi/assignmentFavorite/batch
Create an Assignment Favorite
Method: post
Path: /primeapi/restapi/assignmentFavorite
Delete an Assignment Favorite
Method: delete
Path: /primeapi/restapi/assignmentFavorite/{id}
View all Assignment Favorites Assigned to a User
Method: get
Path: /primeapi/restapi/assignmentFavorite/userId/{userId}
View an Assignment Favorite
Method: get
Path: /primeapi/restapi/assignmentFavorite/{id}
View an Assignment Favorite by User and Assignment
Method: get
Path: /primeapi/restapi/assignmentFavorite/userId/{userId}/assignmentId/{assignmentId}
Budget Change
The Budget Change service enables you to create, view, update, and delete budget change requests. Budget change requests represent potential modifications to project budgets. Update Keys : 'budgetChangeId'
Batch Create Budget Changes
Method: post
Path: /primeapi/restapi/budgetChange/batch
Batch Delete Budget Changes
Method: delete
Path: /primeapi/restapi/budgetChange/batch
Batch Delete Budget Transactions
Method: delete
Path: /primeapi/restapi/budgetChange/transactions/batch
Batch Update Budget Changes
Method: put
Path: /primeapi/restapi/budgetChange/batch
Change Budget Change Status
Method: put
Path: /primeapi/restapi/budgetChange/{id}/changeBudgetChangeStatus
Create a Budget Change
Method: post
Path: /primeapi/restapi/budgetChange
Delete a Budget Change
Method: delete
Path: /primeapi/restapi/budgetChange/{id}
Delete a Budget Transaction
Method: delete
Path: /primeapi/restapi/budgetChange/transaction/{id}
Update a Budget Change
Method: put
Path: /primeapi/restapi/budgetChange
View a Budget Change
Method: get
Path: /primeapi/restapi/budgetChange/{id}
View a Budget Change by Asssigned Configured Fields
Method: get
Path: /primeapi/restapi/budgetChange/project/{id}/configuredField/{viewColumnName}/{value}
View a Budget Change by Asssigned Configured Fields
Method: get
Path: /primeapi/restapi/budgetChange/projectBudget/{id}/configuredField/{viewColumnName}/{value}
View a budget change by code
Method: get
Path: /primeapi/restapi/budgetChange/byItemCode?workspaceCode={workspaceCode}&projectCode={projectCode}&budgetChangeCode={budgetChangeCode}
View a Budget Change by Code and Project
Method: get
Path: /primeapi/restapi/budgetChange/project/{id}/code/{code}
View a Budget Change by Code and Project Budget
Method: get
Path: /primeapi/restapi/budgetChange/projectBudget/{id}/code/{code}
View all budget changes by parent code
Method: get
Path: /primeapi/restapi/budgetChange/byParent?workspaceCode={workspaceCode}&projectCode={projectCode}
View Budget Change Configured Fields
Method: get
Path: /primeapi/restapi/budgetChange/{id}/configuredFields
View Budget Changes by Project
Method: get
Path: /primeapi/restapi/budgetChange/project/{id}
View Budget Changes by Project Budget
Method: get
Path: /primeapi/restapi/budgetChange/projectBudget/{id}
View Budget Transactions by Budget Change
Method: get
Path: /primeapi/restapi/budgetChange/{id}/transactions
View Status Transition History Record by Budget Change
Method: get
Path: /primeapi/restapi/budgetChange/{id}/statusTransitionHistory
View Status Transition History Record by ProjectbudgetChange_resource_find_all_budgetChanges_by_parent.summary=View all budget changes by parent code
Method: get
Path: /primeapi/restapi/budgetChange/project/{id}/statusTransitionHistory
Budget Item
Use the Budget Item service to create, view, update, and delete budget items. Budget items represent costs associated with labor or other project expenses. Update Keys : 'budgetItemId'
Batch Create Budget Items
Method: post
Path: /primeapi/restapi/budgetItem/batch
Batch Delete Budget Items
Method: delete
Path: /primeapi/restapi/budgetItem/batch
Batch Integrate Budget Items with an External Data Source
Method: post
Path: /primeapi/restapi/budgetItem/syncBatch
Batch Update Budget Items
Method: put
Path: /primeapi/restapi/budgetItem/batch
Create a Budget Item
Method: post
Path: /primeapi/restapi/budgetItem
Delete a Budget Item
Method: delete
Path: /primeapi/restapi/budgetItem/{id}
Integrate a Budget Item with an External Data Source
Method: post
Path: /primeapi/restapi/budgetItem/sync
Update a Budget Item
Method: put
Path: /primeapi/restapi/budgetItem
View a Budget Item by Assigned Configured Field
Method: get
Path: /primeapi/restapi/budgetItem/project/{id}/configuredField/{viewColumnName}/{value}
View a Budget Item by Assigned Configured Field
Method: get
Path: /primeapi/restapi/budgetItem/projectBudget/{id}/configuredField/{viewColumnName}/{value}
View a budget item by code
Method: get
Path: /primeapi/restapi/budgetItem/byItemCode?workspaceCode={workspaceCode}&projectCode={projectCode}&budgetItemCode={budgetItemCode}
View a Budget Item by Name
Method: get
Path: /primeapi/restapi/budgetItem/name/{name}
View all budget items by parent code
Method: get
Path: /primeapi/restapi/budgetItem/byParent?workspaceCode={workspaceCode}&projectCode={projectCode}
View Budget Item by Code and Project
Method: get
Path: /primeapi/restapi/budgetItem/project/{id}/code/{code}
View Budget Item by Code and Project Budget
Method: get
Path: /primeapi/restapi/budgetItem/projectBudget/{id}/code/{code}
View Budget Item Configured Fields
Method: get
Path: /primeapi/restapi/budgetItem/{id}/configuredFields
View Budget Items by Project
Method: get
Path: /primeapi/restapi/budgetItem/project/{id}
View Budget Items by Project Budget
Method: get
Path: /primeapi/restapi/budgetItem/projectBudget/{id}
View Budget Transaction by Assigned Configured Field
Method: get
Path: /primeapi/restapi/budgetItem/{id}/transactions/configuredField/{viewColumnName}/{value}
View Budget Transactions by Budget Item
Method: get
Path: /primeapi/restapi/budgetItem/{id}/transactions
View Integrated Budget Items
Method: get
Path: /primeapi/restapi/budgetItem/externallySourced
View the Configured Fields by Budget Transaction
Method: get
Path: /primeapi/restapi/budgetItem/transaction/{id}/configuredFields
Budget Transfer
Use the Budget Transfer service to create, view, update, delete, and status budget transfers. Budget transfers represent adjustments to budget line item costs, and capture costs that were moved from one line item to another. Update Keys : 'budgetTransferId'
Batch Create Budget Transfers
Method: post
Path: /primeapi/restapi/budgetTransfer/batch
Batch Delete Budget Transactions
Method: delete
Path: /primeapi/restapi/budgetTransfer/transactions/batch
Batch Delete Budget Transfers
Method: delete
Path: /primeapi/restapi/budgetTransfer/batch
Batch Update Budget Transfers
Method: put
Path: /primeapi/restapi/budgetTransfer/batch
Change a Budget Transfer Status
Method: put
Path: /primeapi/restapi/budgetTransfer/{id}/changeBudgetTransferStatus
Create a Budget Transfer
Method: post
Path: /primeapi/restapi/budgetTransfer
Delete a Budget Transaction
Method: delete
Path: /primeapi/restapi/budgetTransfer/transaction/{id}
Delete a Budget Transfer
Method: delete
Path: /primeapi/restapi/budgetTransfer/{id}
Update a Budget Transfer
Method: put
Path: /primeapi/restapi/budgetTransfer
View a Budget Transfer
Method: get
Path: /primeapi/restapi/budgetTransfer/{id}
View a budget transfer by code
Method: get
Path: /primeapi/restapi/budgetTransfer/byItemCode?workspaceCode={workspaceCode}&projectCode={projectCode}&budgetTransferCode={budgetTransferCode}
View a Budget Transfer by Code and Project
Method: get
Path: /primeapi/restapi/budgetTransfer/project/{id}/code/{code}
View a Status Transition History Record by Budget Transfer
Method: get
Path: /primeapi/restapi/budgetTransfer/{id}/statusTransitionHistory
View a Status Transition History Record by Project
Method: get
Path: /primeapi/restapi/budgetTransfer/project/{id}/statusTransitionHistory
View all budget transfers by parent code
Method: get
Path: /primeapi/restapi/budgetTransfer/byParent?workspaceCode={workspaceCode}&projectCode={projectCode}
View Budget Transactions by Budget Transfer
Method: get
Path: /primeapi/restapi/budgetTransfer/{id}/transactions
View Budget Transfer by Assigned Configured Field
Method: get
Path: /primeapi/restapi/budgetTransfer/project/{id}/configuredField/{viewColumnName}/{value}
View Budget Transfer by Assigned Configured Field
Method: get
Path: /primeapi/restapi/budgetTransfer/projectBudget/{id}/configuredField/{viewColumnName}/{value}
View Budget Transfer by Code and Project Budget
Method: get
Path: /primeapi/restapi/budgetTransfer/projectBudget/{id}/code/{code}
View Budget Transfer Configured Fields
Method: get
Path: /primeapi/restapi/budgetTransfer/{id}/configuredFields
View Budget Transfers by Project
Method: get
Path: /primeapi/restapi/budgetTransfer/project/{id}
View Budget Transfers by Project Budget
Method: get
Path: /primeapi/restapi/budgetTransfer/projectBudget/{id}
CBS
Use the CBS service enables you to create, view, update, or delete cost breakdown structure codes for a workspace or project. A CBS is used to track, manage, and report costs related to a project. CBS codes enable you to define and track custom cost data within project or workspace CBS. Update Keys : 'costItemId'
Batch Integrate CBSs with an External Data Source
Method: post
Path: /primeapi/restapi/cbs/project/syncBatch
Create a Project CBS Code
Method: post
Path: /primeapi/restapi/cbs/project/{id}
Create a Project Costing Source
Method: post
Path: /primeapi/restapi/cbs/project/{id}/projectCostingSource
Create a Workspace CBS Code
Method: post
Path: /primeapi/restapi/cbs/workspace/{id}
Delete a Project CBS Code by Workspace CBS ID
Method: delete
Path: /primeapi/restapi/cbs/project/{id}
Delete a Workspace CBS Code by Workspace CBS ID
Method: delete
Path: /primeapi/restapi/cbs/workspace/{id}
Integrate a CBS with an External Data Source
Method: post
Path: /primeapi/restapi/cbs/project/sync
Push Down all Workspace CBS Code to Project
Method: put
Path: /primeapi/restapi/cbs/import/workspace/{workspaceCode}/project/{projectCode}
Push Down all Workspace CBS Code to Project
Method: put
Path: /primeapi/restapi/cbs/moveAll/workspace/{workspaceCode}/project/{projectCode}
Reset all Project Cost Sheet Code.
Method: delete
Path: /primeapi/restapi/cbs/resetCostSheet/workspace/{workspaceCode}/project/{projectCode}
Update a Project CBS Code by CBS
Method: put
Path: /primeapi/restapi/cbs/project
Update a Project Costing Source
Method: put
Path: /primeapi/restapi/cbs/project/{id}/projectCostingSource
Update a Workspace CBS Code
Method: put
Path: /primeapi/restapi/cbs/workspace
View a CBS by ID and Type
Method: get
Path: /primeapi/restapi/cbs/{id}?type={type}
View a CBS Sheet Code by Project and CBS Code
Method: get
Path: /primeapi/restapi/cbs/project/{id}/code/{cbsCode}
View a CBS Sheet Total Cost Row by Project
Method: get
Path: /primeapi/restapi/cbs/project/{id}/totalCost
View a project CBS by code
Method: get
Path: /primeapi/restapi/cbs/project/byItemCode?workspaceCode={workspaceCode}&projectCode={projectCode}&cbsCode={cbsCode}
View a Project Costing Source
Method: get
Path: /primeapi/restapi/cbs/project/{id}/projectCostingSource
View a workspace CBS by code
Method: get
Path: /primeapi/restapi/cbs/workspace/byItemCode?workspaceCode={workspaceCode}&cbsCode={cbsCode}
View a Workspace Total Item by ID and Template Type
Method: get
Path: /primeapi/restapi/cbs/aggregate/reference/{id}?templateType={templateType}
View all CBS Codes Assigned to a Workspace or Project
Method: get
Path: /primeapi/restapi/cbs/project/{id}
View all CBS Codes Assigned to a Workspace or Project
Method: get
Path: /primeapi/restapi/cbs/workspace/{id}
View all project CBSs by parent code
Method: get
Path: /primeapi/restapi/cbs/project/byParent?workspaceCode={workspaceCode}&projectCode={projectCode}
View all workspace CBSs by parent code
Method: get
Path: /primeapi/restapi/cbs/workspace/byParent?workspaceCode={workspaceCode}
View Integrated CBSs
Method: get
Path: /primeapi/restapi/cbs/project/externallySourced
Calendar
Use the Calendar service to create, view, update, and delete calendars. Calendars define the workdays, work hours, holidays, and exceptions available to projects, resources, and roles.
Assign or Promote a Calendar
Method: post
Path: /primeapi/restapi/calendar/replicateObjectInWorkspaces/calendar/{calendarId}/workspace/{workspaceId}
Batch Create Calendars
Method: post
Path: /primeapi/restapi/calendar/batch
Batch Delete Calendars
Method: delete
Path: /primeapi/restapi/calendar/batch
Batch Update Calendars
Method: put
Path: /primeapi/restapi/calendar/batch
Create a Calendar
Method: post
Path: /primeapi/restapi/calendar
Delete a Calendar
Method: delete
Path: /primeapi/restapi/calendar/{id}
Update a Calendar
Method: put
Path: /primeapi/restapi/calendar
View a Calendar
Method: get
Path: /primeapi/restapi/calendar/{id}
View a calendar by code
Method: get
Path: /primeapi/restapi/calendar/byItemCode?workspaceCode={workspaceCode}&calendarCode={calendarCode}
View a Calendar by Code
Method: get
Path: /primeapi/restapi/calendar/code/{code}
View a Calendar by Code
Method: get
Path: /primeapi/restapi/calendar/workspace/{workspaceId}/code/{code}
View all calendars by parent
Method: get
Path: /primeapi/restapi/calendar/byParent?workspaceCode={workspaceCode}
View Calendar Exceptions
Method: get
Path: /primeapi/restapi/calendar/exception/{id}
View Calendars by Workspace
Method: get
Path: /primeapi/restapi/calendar/workspace/{id}
View Default Workspace Calendar
Method: get
Path: /primeapi/restapi/calendar/defaultCalendar/workspace/{id}
Capital Portfolio Member
Use the Capital Portfolio Member service to create, view, and delete capital portfolio members. Capital portfolio members are references to projects or portfolios contained in a capital portfolio.
Batch Create Capital Portfolio Members
Method: post
Path: /primeapi/restapi/capitalPortfolioMember/batch
Create a Capital Portfolio Member
Method: post
Path: /primeapi/restapi/capitalPortfolioMember
View a Capital Portfolio Member
Method: get
Path: /primeapi/restapi/capitalPortfolioMember/portfolio/{portfolioId}
View a Capital Portfolio Member
Method: get
Path: /primeapi/restapi/capitalPortfolioMember/{id}
Change Estimate
Use the Change Estimate service to view, create, update, and delete change estimates. Update Keys : 'changeEventId, itemCode' or 'changeEstimateId' or 'workspaceCode, projectCode, changeEventCode, itemCode'
Batch Create Change Estimates
Method: post
Path: /primeapi/restapi/changeEstimate/batch
Batch Delete Change Estimates
Method: delete
Path: /primeapi/restapi/changeEstimate/batch
Batch Update Change Estimates
Method: put
Path: /primeapi/restapi/changeEstimate/batch
Create a Change Estimate
Method: post
Path: /primeapi/restapi/changeEstimate
Delete a Change Estimate
Method: delete
Path: /primeapi/restapi/changeEstimate/{id}
Update a Change Estimate
Method: put
Path: /primeapi/restapi/changeEstimate
View a Change Estimate
Method: get
Path: /primeapi/restapi/changeEstimate/{id}
View a Change Estimate by Parent
Method: get
Path: /primeapi/restapi/changeEstimate/byParent?worksaceCode={worksaceCode}&projectCode={projectCode}&changeEventCode={changeEventCode}
View a Change Estimate by Parent and Code
Method: get
Path: /primeapi/restapi/changeEstimate/byItemCode?worksaceCode={worksaceCode}&projectCode={projectCode}&changeEventCode={changeEventCode}&changeEstimateCode={changeEstimateCode}
Change Event
Use the Change Event service to create, update, view, and delete change events. Update Keys : 'projectId, itemCode' or 'changeEventId' or 'workspaceCode, projectCode, itemCode'
Batch Create Change Events
Method: post
Path: /primeapi/restapi/changeEvent/batch
Batch Delete Change Events
Method: delete
Path: /primeapi/restapi/changeEvent/batch
Batch Update Change Events
Method: put
Path: /primeapi/restapi/changeEvent/batch
Create a Change Event
Method: post
Path: /primeapi/restapi/changeEvent
Delete a Change Event
Method: delete
Path: /primeapi/restapi/changeEvent/{id}
Update a Change Event
Method: put
Path: /primeapi/restapi/changeEvent
View a Change Event
Method: get
Path: /primeapi/restapi/changeEvent/{id}
View a Change Event by Parent
Method: get
Path: /primeapi/restapi/changeEvent/byParent?worksaceCode={worksaceCode}&projectCode={projectCode}
View a Change Event by Parent and Code
Method: get
Path: /primeapi/restapi/changeEvent/byItemCode?worksaceCode={worksaceCode}&projectCode={projectCode}&changeEventCode={changeEventCode}
Change Order
Use the Change Order service you to create, view, update, and delete change orders. Change orders are documented changes that have been made to contracts and commitments. Update Keys : 'projectId, itemCode, type' or 'changeOrderId' or 'workspaceCode, projectCode, itemCode, type'
Batch Create Change Orders
Method: post
Path: /primeapi/restapi/changeOrder/batch
Batch Delete Change Orders
Method: delete
Path: /primeapi/restapi/changeOrder/batch
Batch Integrate Change Orders with an External Data Source
Method: post
Path: /primeapi/restapi/changeOrder/syncBatch
Batch Update Change Orders
Method: put
Path: /primeapi/restapi/changeOrder/batch
Collect Change Orders
Method: put
Path: /primeapi/restapi/changeOrder/collect/workspace/{worksaceCode}/project/{projectCode}/associatedContract/{associatedContractCode}/code/{contractChangeOrderCode}
Create a Change Order
Method: post
Path: /primeapi/restapi/changeOrder
Delete a Change Order
Method: delete
Path: /primeapi/restapi/changeOrder/{id}
Integrate a Change Order with an External Data Source
Method: post
Path: /primeapi/restapi/changeOrder/sync
Uncollect Change Orders
Method: put
Path: /primeapi/restapi/changeOrder/uncollect/workspace/{workspaceCode}/project/{projectCode}/associatedContract/{associatedContractCode}/code/{contractChangeOrderCode}
Update a Change Order
Method: put
Path: /primeapi/restapi/changeOrder
View a Change Order
Method: get
Path: /primeapi/restapi/changeOrder/{id}
View Change Orders by Parent
Method: get
Path: /primeapi/restapi/changeOrder/workspace/{worksaceCode}/project/{projectCode}/associatedAgreement/{associatedAgreementCode}/type/{agreementType}
View Change Orders by Parent and Code
Method: get
Path: /primeapi/restapi/changeOrder/workspace/{worksaceCode}/project/{projectCode}/associatedAgreement/{associatedAgreementCode}/type/{agreementType}/code/{changeOrderCode}
View Collected Change Orders
Method: get
Path: /primeapi/restapi/changeOrder/collected/workspace/{worksaceCode}/project/{projectCode}/associatedContract/{associatedContractCode}/contractChangeOrder/{contractChangeOrderCode}
View Integrated Change Orders
Method: get
Path: /primeapi/restapi/changeOrder/externallySourced
View Uncollected Change Orders
Method: get
Path: /primeapi/restapi/changeOrder/uncollected/workspace/{worksaceCode}/project/{projectCode}
Change Order Line Item
Use the Change Order Line Item service to create, view, update, and delete change order line items. Change orders are documented changes that have been made to contracts or commitments. A line item represents billable work associated with a cost. Update Keys : 'projectId, changeOrder.itemCode, itemCode' or 'lineItemId' or 'workspaceCode, projectCode, itemCode, type'
Batch Create Change Order Line Items
Method: post
Path: /primeapi/restapi/changeOrderLineItem/batch
Batch Delete Change Order Line Items
Method: delete
Path: /primeapi/restapi/changeOrderLineItem/batch
Batch Integrate Change Order Line Items with an External Data Source
Method: post
Path: /primeapi/restapi/changeOrderLineItem/syncBatch
Batch Update Change Order Line Items
Method: put
Path: /primeapi/restapi/changeOrderLineItem/batch
Create a Change Order Line Item
Method: post
Path: /primeapi/restapi/changeOrderLineItem
Delete a Change Order Line Item
Method: delete
Path: /primeapi/restapi/changeOrderLineItem/{id}
Integrate a Change Order Line Item with an External Data Source
Method: post
Path: /primeapi/restapi/changeOrderLineItem/sync
Update a Change Order Line Item
Method: put
Path: /primeapi/restapi/changeOrderLineItem
View Change Order Line Items
Method: get
Path: /primeapi/restapi/changeOrderLineItem/{id}
View Change Order Line Items by Parent
Method: get
Path: /primeapi/restapi/changeOrderLineItem/workspace/{worksaceCode}/project/{projectCode}/changeOrder/{changeOrderCode}/associatedAgreement/{associatedAgreementCode}/type/{agreementType}
View Change Order Line Items by Parent and Code
Method: get
Path: /primeapi/restapi/changeOrderLineItem/workspace/{worksaceCode}/project/{projectCode}/changeOrder/{changeOrderCode}/associatedAgreement/{associatedAgreementCode}/type/{agreementType}/code/{lineItemCode}
View Integrated Change Order Line Items
Method: get
Path: /primeapi/restapi/changeOrderLineItem/externallySourced
Change Order SOV
Use the Change Order SOV service to create, view, update, and delete change order schedule of values (SOV). A change order SOV represents the schedule of values of the aggrement, a contract or commitment, the change order is associated with. Update Keys : 'sovId'
Batch Create Change Order SOVs
Method: post
Path: /primeapi/restapi/changeOrderSOV/batch
Batch Delete Change Order SOVs
Method: delete
Path: /primeapi/restapi/changeOrderSOV/batch
Batch Updated Change Order SOVs
Method: put
Path: /primeapi/restapi/changeOrderSOV/batch
Create a Change Order SOV
Method: post
Path: /primeapi/restapi/changeOrderSOV
Delete a Change Order SOV
Method: delete
Path: /primeapi/restapi/changeOrderSOV/{id}
Update a Change Order SOV
Method: put
Path: /primeapi/restapi/changeOrderSOV
View a Change Order SOV
Method: get
Path: /primeapi/restapi/changeOrderSOV/{id}
View a Change Order SOV by Parent
Method: get
Path: /primeapi/restapi/changeOrderSOV/workspace/{worksaceCode}/project/{projectCode}/changeOrder/{changeOrderCode}/associatedAgreement/{associatedAgreementCode}/type/{agreementType}/lineItem/{lineItemCode}
View a Change Order SOV by Parent and Code
Method: get
Path: /primeapi/restapi/changeOrderSOV/workspace/{worksaceCode}/project/{projectCode}/changeOrder/{changeOrderCode}/associatedAgreement/{associatedAgreementCode}/type/{agreementType}/lineItem/{lineItemCode}/code/{changeOrderSOVCode}
Change Request
Use the Change Requests service to create, view, update, and delete change requests. Change requests track changes to work packages and scope assignements after an original project baseline is set.
Batch Create Change Requests
Method: post
Path: /primeapi/restapi/changeRequest/batch
Batch Update Change Requests
Method: put
Path: /primeapi/restapi/changeRequest/batch
Create a Change Request
Method: post
Path: /primeapi/restapi/changeRequest
Update a Change Request
Method: put
Path: /primeapi/restapi/changeRequest
View a Change Request
Method: get
Path: /primeapi/restapi/changeRequest/{id}
Code Value
Use the Code Value service to create, view, update, and delete code values. Codes are user-defined data used to oraganize and filter objects. Codes are defined as combinations of types and values. For example, you can define a "Priority" code type that contains text values, and create a set of potential values for the type for use across projects.
Batch Create Code Values
Method: post
Path: /primeapi/restapi/codeValue/batch
Batch Delete Code Values
Method: delete
Path: /primeapi/restapi/codeValue/batch
Batch Update Code Values
Method: put
Path: /primeapi/restapi/codeValue/batch
Create a Code Value
Method: post
Path: /primeapi/restapi/codeValue
Delete a Code Value
Method: delete
Path: /primeapi/restapi/codeValue/{id}
Update a Code Value
Method: put
Path: /primeapi/restapi/codeValue
View a Code Value
Method: get
Path: /primeapi/restapi/codeValue/{id}
View All Child Code Values in a Code Value Hierarchy
Method: get
Path: /primeapi/restapi/codeValue/{id}/childrenHierarchy
View Code Value by Code Type and Workspace
Method: get
Path: /primeapi/restapi/codeValue/workspaceId/{workspaceId}/codeTypeId/{codeTypeId}
View Code Values by Code Type
Method: get
Path: /primeapi/restapi/codeValue/codeType/{id}
View Code Values by Code Type and Code
Method: get
Path: /primeapi/restapi/codeValue/code/{code}/codeType/{id}
View Code Values by Code Type Name
Method: get
Path: /primeapi/restapi/codeValue/codeType/name/{name}
CodeType
Use the Code Type service to create, view, update, and delete code types. Codes are user-defined data used to oraganize and filter objects. Codes are defined as combinations of types and values. For example, you can define a "Priority" code type that contains text values, and create a set of potential values for the type for use across projects.
Assign or Promote a Code Type
Method: post
Path: /primeapi/restapi/codeType/replicateObjectInWorkspaces/codeType/{codeTypeId}/workspace/{workspaceId}
Batch Create Code Types
Method: post
Path: /primeapi/restapi/codeType/batch
Batch Delete Code Types
Method: delete
Path: /primeapi/restapi/codeType/batch
Delete a Code Type
Method: delete
Path: /primeapi/restapi/codeType/{id}
Update Code Types
Method: put
Path: /primeapi/restapi/codeType/batch
View a Code Type
Method: get
Path: /primeapi/restapi/codeType/{id}
View a code type by code
Method: get
Path: /primeapi/restapi/codeType/byItemCode?workspaceCode={workspaceCode}&codeTypeCode={codeTypeCode}
View all code types by parent
Method: get
Path: /primeapi/restapi/codeType/byParent?workspaceCode={workspaceCode}
View Code Types by Associated Object
Method: get
Path: /primeapi/restapi/codeType?type={type}
View Code Types by Workspace
Method: get
Path: /primeapi/restapi/codeType/workspace/{id}
Commitment
Use the Commitment service to create, view, update, and delete commitments. Commitments represent argeements between your company and subcontractors to complete specified units of work. Update Keys : 'commitmentId'
Batch Create Commitments
Method: post
Path: /primeapi/restapi/commitment/batch
Batch Delete Commitments
Method: delete
Path: /primeapi/restapi/commitment/batch
Batch Integrate Commitments with an External Data Source
Method: post
Path: /primeapi/restapi/commitment/syncBatch
Batch Update Commitments
Method: put
Path: /primeapi/restapi/commitment/batch
Create a Commitment
Method: post
Path: /primeapi/restapi/commitment
Delete a Commitment
Method: delete
Path: /primeapi/restapi/commitment/{id}
Integrate a Commitment with an External Data Source
Method: post
Path: /primeapi/restapi/commitment/sync
Update a Commitment
Method: put
Path: /primeapi/restapi/commitment
View a Commitment
Method: get
Path: /primeapi/restapi/commitment/{id}
View a commitment by code
Method: get
Path: /primeapi/restapi/commitment/byItemCode?workspaceCode={workspaceCode}&projectCode={projectCode}&commitmentCode={commitmentCode}
View a Commitment by Item Code
Method: get
Path: /primeapi/restapi/commitment/code/{code}
View a Commitment by Item Code and Project
Method: get
Path: /primeapi/restapi/commitment/project/{projectId}/code/{code}
View all commitments by parent
Method: get
Path: /primeapi/restapi/commitment/byParent?workspaceCode={workspaceCode}&projectCode={projectCode}
View Commitments by Project
Method: get
Path: /primeapi/restapi/commitment/project/{id}
View Integrated Commitments
Method: get
Path: /primeapi/restapi/commitment/externallySourced
Commitment Line Item
Use the Commitment Line Item service to create, view, update, and delete commitment line items. Commitments represent agreements between your company and a subcontracters to complete specified units of work. A line item represents billable work associated with a cost. Update Keys : 'lineItemId'
Batch Create Commitment Line Items
Method: post
Path: /primeapi/restapi/commitmentLineItem/batch
Batch Delete Commitment Line Items
Method: delete
Path: /primeapi/restapi/commitmentLineItem/batch
Batch Integrate Commitment Line Items with an External Data Source
Method: post
Path: /primeapi/restapi/commitmentLineItem/syncBatch
Batch Update Commitment Line Items
Method: put
Path: /primeapi/restapi/commitmentLineItem/batch
Create a Commitment Line Item
Method: post
Path: /primeapi/restapi/commitmentLineItem
Delete a Commitment Line Item
Method: delete
Path: /primeapi/restapi/commitmentLineItem/{id}
Integrate a Commitment Line Item with an External Data Source
Method: post
Path: /primeapi/restapi/commitmentLineItem/sync
Update a Commitment Line Item
Method: put
Path: /primeapi/restapi/commitmentLineItem
View a Commitment Line Item
Method: get
Path: /primeapi/restapi/commitmentLineItem/{id}
View a Commitment Line Item by Commitment Line Item Code
Method: get
Path: /primeapi/restapi/commitmentLineItem/code/{code}
View a Commitment Line Item by Commitment Line Item Code and Commitment
Method: get
Path: /primeapi/restapi/commitmentLineItem/commitment/{commitmentId}/code/{code}
View Commitment Line Items by Commitment
Method: get
Path: /primeapi/restapi/commitmentLineItem/commitment/{commitmentId}
View Integrated Commitment Line Items
Method: get
Path: /primeapi/restapi/commitmentLineItem/externallySourced
Company
The Company service enables you to create, view, update, or delete companies. Multiple companies can work together using the same Prime environment. For example, if the owning company hires a design firm and a subcontractor to work on the same project, the owning company can add both of the other companies as partner companies. The owning company can also add users to the partner companies and give them access to workspaces, projects, and portfolios. Two types of companies are supported: Owning Company: Represents the company with ownership of the application instance. Owning companies cannot be deleted. Partner Company: A separate entity from the owning company that needs access to the application. Partner companies represent vendors, resellers, subcontractors, owners, suppliers, and other consultants.
Batch Integrate Companies with an External Data Source
Method: post
Path: /primeapi/restapi/company/syncBatch
Delete a Company
Method: delete
Path: /primeapi/restapi/company/{id}
Integrate a Company with an External Data Source
Method: post
Path: /primeapi/restapi/company/sync
View a Company
Method: get
Path: /primeapi/restapi/company/{id}
View a Company by Name
Method: get
Path: /primeapi/restapi/company/name/{name}
View all Companies
Method: get
Path: /primeapi/restapi/company/list
View Companies by Assigned Configured Field Value
Method: get
Path: /primeapi/restapi/company/configuredField/{viewColumnName}/{value}
View Companies by Tenant Owner
Method: get
Path: /primeapi/restapi/company/tenantOwner
View Company Configured Fields
Method: get
Path: /primeapi/restapi/company/{id}/configuredFields
View Integrated Companies
Method: get
Path: /primeapi/restapi/company/externallySourced
Configured Fields
The Configured Fields service enables you to send requests related to fields and codes configured for use in the application.
Assign or Promote a Configured Field
Method: post
Path: /primeapi/restapi/field/replicateObjectInWorkspaces/configuredField/{configuredFieldId}/workspace/{workspaceId}
Create a Configured Field
Method: post
Path: /primeapi/restapi/field?objectType={objectType}
View a Configured Field
Method: get
Path: /primeapi/restapi/field/{id}
View a Configured Field by Workspace
Method: get
Path: /primeapi/restapi/field/workspace/{id}
Contract
The contract service enables you to create, view, update, and delete contracts. Update Keys : 'contractId'
Batch Create Contracts
Method: post
Path: /primeapi/restapi/contract/batch
Batch Delete Contracts
Method: delete
Path: /primeapi/restapi/contract/batch
Batch Update Contracts
Method: put
Path: /primeapi/restapi/contract/batch
Create a Contract
Method: post
Path: /primeapi/restapi/contract
Delete a Contract
Method: delete
Path: /primeapi/restapi/contract/{id}
Update a Contract
Method: put
Path: /primeapi/restapi/contract
View a Contract
Method: get
Path: /primeapi/restapi/contract/{id}
View a Contract by Code
Method: get
Path: /primeapi/restapi/contract/code/{code}
View Contract Status Transition History
Method: get
Path: /primeapi/restapi/contract/{code}/project/{projectId}/history
View Contracts by Project
Method: get
Path: /primeapi/restapi/contract/project/{id}
Contract Line Item
The Contract Line Item service enables you to create, update, view, and delete contract line items. Update Keys : 'lineItemId'
Batch Create Contract Line Items
Method: post
Path: /primeapi/restapi/contractLineItem/batch
Batch Delete Contract Line Items
Method: delete
Path: /primeapi/restapi/contractLineItem/batch
Batch Update Contract Line Items
Method: put
Path: /primeapi/restapi/contractLineItem/batch
Create a Contract Line Item
Method: post
Path: /primeapi/restapi/contractLineItem
Delete a Contract Line Item
Method: delete
Path: /primeapi/restapi/contractLineItem/{id}
Delete Contract Line Items by Contract
Method: delete
Path: /primeapi/restapi/contractLineItem/contract/{id}
Update a Contract Line Item
Method: put
Path: /primeapi/restapi/contractLineItem
View a Contract Line Item
Method: get
Path: /primeapi/restapi/contractLineItem/{id}
View a Contract Line Item by Code
Method: get
Path: /primeapi/restapi/contractLineItem/code/{code}
View a Contract Line Item by Contract
Method: get
Path: /primeapi/restapi/contractLineItem/contract/{contractId}
Cost Category
Use the Cost Category service to create, view, update, and delete cost categories. Cost categories define types used to organize costs.
Assign or Promote a Cost Category
Method: post
Path: /primeapi/restapi/costCategory/replicateObjectInWorkspaces/costCategory/{costCategoryId}/workspace/{workspaceId}
Batch Create Cost Categories
Method: post
Path: /primeapi/restapi/costCategory/batch
Batch Delete Cost Categories
Method: delete
Path: /primeapi/restapi/costCategory/batch
Batch Update Cost Categories
Method: put
Path: /primeapi/restapi/costCategory/batch
Delete a Cost Category
Method: delete
Path: /primeapi/restapi/costCategory/{id}
View a Cost Category
Method: get
Path: /primeapi/restapi/costCategory/{id}
View a Cost Category by Name
Method: get
Path: /primeapi/restapi/costCategory/name/{name}
View a Cost Category by Name and Workspace
Method: get
Path: /primeapi/restapi/costCategory/workspace/{workspaceId}/name/{name}
View a Cost Category Row
Method: get
Path: /primeapi/restapi/costCategory/categoryRow/costCategory/{costCategoryId}
View a Cost Category Row by Cost Item
Method: get
Path: /primeapi/restapi/costCategory/categoryRow/costItem/{costItemId}
View a Cost Category Row by Cost Sheet
Method: get
Path: /primeapi/restapi/costCategory/categoryRow/costSheet/{costSheetId}
View Code Type by Cost Category Type
Method: get
Path: /primeapi/restapi/costCategory?type={type}
View Cost Categories by Workspace
Method: get
Path: /primeapi/restapi/costCategory/workspace/{id}
View Cost Category Rows by Cost Category Name and Project
Method: get
Path: /primeapi/restapi/costCategory/categoryRow/costCategory/{name}/project/{id}
Currency
The Currency service enables you to create, view, update, and delete currencies. Currencies track the costs of your projects using a specified monetary system. Currencies can be defined at the workspace or project level.
Assign or Promote a Currency
Method: post
Path: /primeapi/restapi/currency/replicateObjectInWorkspaces/currency/{currencyId}/workspace/{workspaceId}
Create a Currency
Method: post
Path: /primeapi/restapi/currency
Delete a Currency
Method: delete
Path: /primeapi/restapi/currency/{id}
Update a Currency
Method: put
Path: /primeapi/restapi/currency
View a Currency
Method: get
Path: /primeapi/restapi/currency/{id}
View a Currency by Code
Method: get
Path: /primeapi/restapi/currency/code/{code}
View a Currency by Name
Method: get
Path: /primeapi/restapi/currency/name/{name}
View a Currency Seed
Method: get
Path: /primeapi/restapi/currency/currencySeed
View Currencies by Workspace
Method: get
Path: /primeapi/restapi/currency/workspace/{id}
Curve
Use the Curve service to create, view, update, and delete curves. Curves specify how values such as scope assignment quantities and hours are spread across the duration of an activity.
Assign or Promote a Curve
Method: post
Path: /primeapi/restapi/curve/replicateObjectInWorkspaces/curve/{curveId}/workspace/{workspaceId}
Batch Create Curves
Method: post
Path: /primeapi/restapi/curve/batch
Batch Delete Curves
Method: delete
Path: /primeapi/restapi/curve/batch
Batch Update Curves
Method: put
Path: /primeapi/restapi/curve/batch
Create a Curve
Method: post
Path: /primeapi/restapi/curve
Delete a Curve
Method: delete
Path: /primeapi/restapi/curve/{id}
Update a Curve
Method: put
Path: /primeapi/restapi/curve
View a Curve
Method: get
Path: /primeapi/restapi/curve/{id}
View a Curve by Name
Method: get
Path: /primeapi/restapi/curve/name/{curveName}
View a Curve by Workspace
Method: get
Path: /primeapi/restapi/curve/workspace/{workspaceId}
View a Curve by Workspace and Name
Method: get
Path: /primeapi/restapi/curve/workspace/{workspaceId}/name/{curveName}
View a curve profile by name and workspace
Method: get
Path: /primeapi/restapi/curve/resolveCurve/workspace/{workspaceId}/curveName/{curveName}
Custom Log Item
The Custom Log service enables you to send requests related to custom logs. Update Keys : 'customLogTypeObjectId, itemCode' or 'customLogsItemId' or 'workspaceCode, projectCode, customLogTypeObjectName, itemCode' or 'projectId, customLogTypeObjectName, itemCode'
Batch Create Custom Log Items
Method: post
Path: /primeapi/restapi/customLogItem/batch
Batch Delete Custom Log Items
Method: delete
Path: /primeapi/restapi/customLogItem/batch
Batch Update Custom Log Items
Method: put
Path: /primeapi/restapi/customLogItem/batch
Create a Custom Log Item
Method: post
Path: /primeapi/restapi/customLogItem
Delete a Custom Log Item
Method: delete
Path: /primeapi/restapi/customLogItem/{id}
Update a Custom Log Item
Method: put
Path: /primeapi/restapi/customLogItem
View a Custom Log Item
Method: get
Path: /primeapi/restapi/customLogItem/{id}
View a Custom Log Item by Parent
Method: get
Path: /primeapi/restapi/customLogItem/workspace/{worksaceCode}/project/{projectCode}/customLogObject/{customLogObjectName}
View a Custom Log Item by Parent and Code
Method: get
Path: /primeapi/restapi/customLogItem/workspace/{worksaceCode}/project/{projectCode}/customLogObject/{customLogObjectName}/code/{customLogItemCode}
Custom Log Type Object
The Custom Log Object Type service enables you to send requests related to custom log object types. Update Keys : 'scope, scopeId, customLogTypeName' or 'customLogTypeObjectId' or 'workspaceCode, scope, scopeCode, customLogTypeName'
Batch Create Custom Log Type Objects
Method: post
Path: /primeapi/restapi/customLogTypeObject/batch
Batch Delete Custom Log Type Object Code Types
Method: delete
Path: /primeapi/restapi/customLogTypeObject/codeTypes/workspace/{workspaceCode}/project/{projectCode}/name/{customLogTypeObjectName}
Batch Delete Custom Log Type Object Configured Fields
Method: delete
Path: /primeapi/restapi/customLogTypeObject/udfs/workspace/{workspaceCode}/project/{projectCode}/name/{customLogTypeObjectName}
Batch Delete Custom Log Type Objects
Method: delete
Path: /primeapi/restapi/customLogTypeObject/batch
Batch Update Custom Log Type Objects
Method: put
Path: /primeapi/restapi/customLogTypeObject/batch
Create a Custom Log Type Object
Method: post
Path: /primeapi/restapi/customLogTypeObject
Delete a Custom Log Type Object
Method: delete
Path: /primeapi/restapi/customLogTypeObject/{id}
Update a Custom Log Type Object
Method: put
Path: /primeapi/restapi/customLogTypeObject
View a Custom Log Type Object
Method: get
Path: /primeapi/restapi/customLogTypeObject/{id}
View a Custom Log Type Object by Parent and Code
Method: get
Path: /primeapi/restapi/customLogTypeObject/workspace/{workspaceCode}/project/{projectCode}/name/{customLogObjectName}
View Custom Log Type Objects by Parent
Method: get
Path: /primeapi/restapi/customLogTypeObject/workspace/{workspaceCode}/project/{projectCode}
Document
Use the Document service to create, view, update, and delete documents. Documents are drawings, submittals, RFIs, or other files that support your organization's goals. Update Keys : 'id'
Batch Delete Files
Method: delete
Path: /primeapi/restapi/document/batch/files
Batch Delete Folders
Method: delete
Path: /primeapi/restapi/document/batch/folders
Check-in a Document
Method: post
Path: /primeapi/restapi/document/file/{id}/checkin
Check-out a Document
Method: get
Path: /primeapi/restapi/document/file/{id}/checkout
Copy a Template to a Folder
Method: post
Path: /primeapi/restapi/document/templateCopy/sourceTemplate/{id}/targetFolder/{targetId}
Create a Document
Method: post
Path: /primeapi/restapi/document/folder
Delete a File
Method: delete
Path: /primeapi/restapi/document/file/{id}
Delete a Folder
Method: delete
Path: /primeapi/restapi/document/folder/{id}
Download a File
Method: get
Path: /primeapi/restapi/document/file/{id}/download
Download a Specific Version of a File
Method: get
Path: /primeapi/restapi/document/file/{id}/version/{ver}/download
Link a document to another object
Method: get
Path: /primeapi/restapi/document/{docId}/scope/{type}/scopeId/{id}/linkDocument
Unlink a Document
Method: get
Path: /primeapi/restapi/document/{docId}/scope/{type}/scopeId/{id}/unlinkDocument
Update a File
Method: put
Path: /primeapi/restapi/document/file
Update a Folder
Method: put
Path: /primeapi/restapi/document/folder
Upload a Document
Method: post
Path: /primeapi/restapi/document/uploadFile/parent/{folderId}/fileName/{fileName}
View a Child Folder
Method: get
Path: /primeapi/restapi/document/folder/{id}/childFolders
View a Document by Path
Method: get
Path: /primeapi/restapi/document/workspace/{code}/{type}/search?path={path}
View a File
Method: get
Path: /primeapi/restapi/document/file/{id}
View a File by Folder
Method: get
Path: /primeapi/restapi/document/folder/{id}/files
View a Folder
Method: get
Path: /primeapi/restapi/document/folder/{id}
View a Folder by Name
Method: get
Path: /primeapi/restapi/document/{name}/folderTemplate/{id}
View all Children by Template
Method: get
Path: /primeapi/restapi/document/template/{id}/allChildren
View all Children of a Folder
Method: get
Path: /primeapi/restapi/document/folder/{id}/allChildren
View all Document References
Method: get
Path: /primeapi/restapi/document/file/{id}/references
View File Annotations
Method: get
Path: /primeapi/restapi/document/file/{id}/version/{ver}/annotations
View File Versions
Method: get
Path: /primeapi/restapi/document/file/{id}/version
View Files by Template
Method: get
Path: /primeapi/restapi/document/template/{id}/files
View Folders by Template
Method: get
Path: /primeapi/restapi/document/template/{id}/childFolders
View the Root Folder by Template
Method: get
Path: /primeapi/restapi/document/template/{id}/root
View the Root Folder of a Portfolio
Method: get
Path: /primeapi/restapi/document/portfolio/{id}/root
View the Root Folder of a Project
Method: get
Path: /primeapi/restapi/document/project/{id}/root
Document Folder Structure Template
Use the Document Folder Strucuture Template Service to create, view, update, or delete document folder strucutre templates.
Batch Create Document Folder Structure Templates
Method: post
Path: /primeapi/restapi/folderTemplate/batch
Batch Delete Document Folder Structure Templates
Method: delete
Path: /primeapi/restapi/folderTemplate/batch
Batch Update Document Folder Structure Templates
Method: put
Path: /primeapi/restapi/folderTemplate/batch
Create a Document Folder Structure Template
Method: post
Path: /primeapi/restapi/folderTemplate
Delete a Document Folder Structure Template
Method: delete
Path: /primeapi/restapi/folderTemplate/{id}
Update a Document Folder Structure Template
Method: put
Path: /primeapi/restapi/folderTemplate
View a Document Folder Strucutre Template
Method: get
Path: /primeapi/restapi/folderTemplate/{id}
View all Document Folder Structure Templates by Workspace
Method: get
Path: /primeapi/restapi/folderTemplate/workspace/{id}
View Document Folder Structure Templates by Name
Method: get
Path: /primeapi/restapi/folderTemplate/name/{name}
Exchange Rate
Use the Exchange Rate service to create, view, update, and delete exchange rates for a given currency. Exchange rates are conversion rates between different forms of currency.
Create an Exchange Rate
Method: post
Path: /primeapi/restapi/exchangeRate
View an Exchange Rate
Method: get
Path: /primeapi/restapi/exchangeRate/{id}
View Exchange Rates by Currency
Method: get
Path: /primeapi/restapi/exchangeRate/currency/{id}
Funds
Use the fund service to create, update, delete, and view funds.
Allocates a Workspace Fund to the Child Workspace.
Method: post
Path: /primeapi/restapi/funds/workspace/workspace/allocation
Allocates a Workspace Fund to the Portfolio.
Method: post
Path: /primeapi/restapi/funds/workspace/portfolio/allocation
Allocates a Workspace Fund to the Project.
Method: post
Path: /primeapi/restapi/funds/workspace/project/allocation
Create Portfolio Funds.
Method: post
Path: /primeapi/restapi/funds/portfolio/batch
Create Project Funds.
Method: post
Path: /primeapi/restapi/funds/project/batch
Create Workspace Funds.
Method: post
Path: /primeapi/restapi/funds/workspace/batch
Creates a Portfolio Fund.
Method: post
Path: /primeapi/restapi/funds/portfolio
Creates a Project Fund.
Method: post
Path: /primeapi/restapi/funds/project
Creates a Workspace Fund.
Method: post
Path: /primeapi/restapi/funds/workspace
Delete Funds.
Method: delete
Path: /primeapi/restapi/funds/batch
Deletes a Fund.
Method: delete
Path: /primeapi/restapi/funds/{id}
Return Fund Totals for the Specified Portfolio Code and Workspace Code.
Method: get
Path: /primeapi/restapi/funds/portfolio/fundtotal?workspaceCode={workspaceCode}&portfolioCode={portfolioCode}
Return Fund Totals for the Specified Workspace Code.
Method: get
Path: /primeapi/restapi/funds/workspace/fundtotal?workspaceCode={workspaceCode}
Return Funds for the Specified Portfolio Code and Workspace Code.
Method: get
Path: /primeapi/restapi/funds/portfolio/list?portfolioCode={portfolioCode}&workspaceCode={workspaceCode}
Return Funds for the Specified Project Code.
Method: get
Path: /primeapi/restapi/funds/project/list?projectCode={projectCode}
Return Funds for the Specified Workspace Code.
Method: get
Path: /primeapi/restapi/funds/workspace/list?workspaceCode={workspaceCode}
Returns the Fund for the Specified Project Code and Fund Code.
Method: get
Path: /primeapi/restapi/funds/project/byFundCode?projectCode={projectCode}&fundCode={fundCode}
Returns the Fund for the Specified Project Code and Fund Name.
Method: get
Path: /primeapi/restapi/funds/project/byFundName?projectCode={projectCode}&fundName={fundName}
Returns the Fund for the Specified Workspace Code and Fund Code.
Method: get
Path: /primeapi/restapi/funds/workspace/byFundCode?workspaceCode={workspaceCode}&fundCode={fundCode}
Returns the Fund for the Specified Workspace Code and Fund Name.
Method: get
Path: /primeapi/restapi/funds/workspace/byFundName?workspaceCode={workspaceCode}&fundName={fundName}
Update Portfolio Funds.
Method: put
Path: /primeapi/restapi/funds/portfolio/batch
Update Project Funds.
Method: put
Path: /primeapi/restapi/funds/project/batch
Update Workspace Funds.
Method: put
Path: /primeapi/restapi/funds/workspace/batch
Updates a Portfolio Fund.
Method: put
Path: /primeapi/restapi/funds/portfolio
Updates a Project Fund.
Method: put
Path: /primeapi/restapi/funds/project
Updates a Workspace Fund.
Method: put
Path: /primeapi/restapi/funds/workspace
View a Fund.
Method: get
Path: /primeapi/restapi/funds/{id}
Gateway App Instance
The Gateway App Instance service enables you to view, create, and update Gateway App Instances.
Create a Gateway App Instance
Method: post
Path: /primeapi/restapi/pims/appInstances
Delete a Gateway App Instance
Method: delete
Path: /primeapi/restapi/pims/appInstances/{id}
Test a Gateway Deployment Connection
Method: post
Path: /primeapi/restapi/pims/appInstances/testConnection
Update a Gateway App Instance
Method: put
Path: /primeapi/restapi/pims/appInstances/{id}
View a Gateway App Instance
Method: get
Path: /primeapi/restapi/pims/appInstances/{id}
View All Gateway App Instances
Method: get
Path: /primeapi/restapi/pims/appInstances/list?appId={appId}
View All Gateway Deployments
Method: get
Path: /primeapi/restapi/pims/appInstances/deployments
Gateway App Instance Configurations
The Gateway App Instance Configuration service enables you to view the current configuration settings of Gateway app instances.
View a Gateway App Instance Configuration
Method: get
Path: /primeapi/restapi/pims/appInstanceConfigurations/{id}
View All Gateway App Instance Configurations
Method: get
Path: /primeapi/restapi/pims/appInstanceConfigurations/list?appInstId={appInstId}
Gateway Flow Definition Apps
The Gateway Flow Definition service enables you to view the available business flow definitions for each Gateway integrated app.
View All Gateway Business Flow Definitions
Method: get
Path: /primeapi/restapi/pims/flowDefinitionApps/list?flowDefinitionId={flowDefinitionId}
Gateway Flow Field Map Templates
The Gateway Field Map Template service enables you to view field mappings between Gateway integrated applications.
View a Gateway Flow Field Mapping Template
Method: get
Path: /primeapi/restapi/pims/flowFieldMapTemplates/{id}
View All Gateway Flow Field Mapping Templates
Method: get
Path: /primeapi/restapi/pims/flowFieldMapTemplates/list?flowId={flowId}
Gateway Flow Instances
The Gateway Flow Instance service enables you to view Gateway flow instances.
View a Gateway Business Flow Instance
Method: get
Path: /primeapi/restapi/pims/flowInstances/{id}
View All Gateway Business Flow Instances
Method: get
Path: /primeapi/restapi/pims/flowInstances/list?flowId={flowId}&flowInstanceStatus={flowInstanceStatus}&isUser={isUser}&jobFilter={jobFilter}
View All of the Child Business Flow Instances of a Gateway Business Flow
Method: get
Path: /primeapi/restapi/pims/flowInstances/childrenOf/{id}
Gateway Flow Load Objects
The Gateway Flow Load service enables you to view flow loads for Gateway business flows.
View All Gateway Budiness Flow Loads
Method: get
Path: /primeapi/restapi/pims/flowLoadObjects/list?flowId={flowId}
Gateway Flow Parameters
PIMS flow parameters.
View a Gateway Flow Parameter
Method: get
Path: /primeapi/restapi/pims/flowParameters/{id}
View All Gateway Flow Parameters
Method: get
Path: /primeapi/restapi/pims/flowParameters/list?flowId={flowId}
Gateway Flow Step Instance Messages
The Gateway Flow Step Instances Messages service enables you to view and download the step messages of Gateway integration business flows.
Download Business Flow Step Details
Method: get
Path: /primeapi/restapi/pims/flowStepInstanceMessages/download/{id}
View Business Flow Step Messages
Method: get
Path: /primeapi/restapi/pims/flowStepInstanceMessages/{id}
Gateway Flow Step Instances
The Gateway Flow Step Instances service enables you to view and download the step details of Gateway integration business flows.
View All Business Flow Step Details
Method: get
Path: /primeapi/restapi/pims/flowStepInstances/list?flowInstanceId={flowInstanceId}
View Business Flow Step Details
Method: get
Path: /primeapi/restapi/pims/flowStepInstances/{id}
Gateway Flows
The Gateway Flow service enables you to create, view, update, and delete Gateway business flows.
Create a Gateway Business Flow
Method: post
Path: /primeapi/restapi/pims/flows
Delete a Gateway Business Flow
Method: delete
Path: /primeapi/restapi/pims/flows/{id}
Update a Gateway Business Flow
Method: put
Path: /primeapi/restapi/pims/flows/{id}
View a Gateway Business Flow
Method: get
Path: /primeapi/restapi/pims/flows/{id}
View all Gateway Business Flows
Method: get
Path: /primeapi/restapi/pims/flows/list?flowDefinitionId={flowDefinitionId}&isUser={isUser}
Gateway Parameter Values
PIMS parameter values.
Returns all parameterValue business objects.
Method: get
Path: /primeapi/restapi/pims/parameterValues/list?scheduleId={scheduleId}
Returns the parameterValue business object for the specified parameterValue ID.
Method: get
Path: /primeapi/restapi/pims/parameterValues/{id}
Returns the parameterValue businesss objects for the specified Job ID.
Method: get
Path: /primeapi/restapi/pims/parameterValues/byJobId?jobId={jobId}&paramName={paramName}
Gateway Services
Initiate a Gateway Job
Method: post
Path: /primeapi/restapi/pims/services/createJobProcess/{id}?review={review}&runOnChain={runOnChain}
Initiate a Gateway Job with a Parameter
Method: post
Path: /primeapi/restapi/pims/services/createJobProcessWithParameters/{id}
Gateway Synchronizations
PIMS synchronizations.
Create a Business Flow Schedule
Method: post
Path: /primeapi/restapi/pims/synchronizations
Delete a Business Flow Schedule
Method: delete
Path: /primeapi/restapi/pims/synchronizations/{id}
Update a Business Flow Schedule
Method: put
Path: /primeapi/restapi/pims/synchronizations/{id}
View a Business Flow Schedule
Method: get
Path: /primeapi/restapi/pims/synchronizations/{id}
View All Business Flow Schedules
Method: get
Path: /primeapi/restapi/pims/synchronizations/list?deploymentName={deploymentName}&flowDefinitiontype={flowDefinitiontype}
Holiday
Use the Holiday service to create, view, update, and delete holidays. Holidays represent times within a calendar on which work will not be scheduled.
Batch Create Holidays
Method: post
Path: /primeapi/restapi/holiday/batch
Batch Delete Holidays
Method: delete
Path: /primeapi/restapi/holiday/batch
Batch Update Holidays
Method: put
Path: /primeapi/restapi/holiday/batch
Create a Holiday
Method: post
Path: /primeapi/restapi/holiday
Delete a Holiday
Method: delete
Path: /primeapi/restapi/holiday/{id}
Update a Holiday
Method: put
Path: /primeapi/restapi/holiday
View a Holiday
Method: get
Path: /primeapi/restapi/holiday/{id}
View a Holiday by Name
Method: get
Path: /primeapi/restapi/holiday/name/{name}
View a Holiday List by Holiday Group
Method: get
Path: /primeapi/restapi/holiday/holidayListId/{id}
Holiday List
Use the Holiday List service to create, view, update, and delete holiday lists. Holiday lists are collections of public or company holidays.
Batch Create Holiday Lists
Method: post
Path: /primeapi/restapi/holidayList/batch
Batch Delete Holiday Lists
Method: delete
Path: /primeapi/restapi/holidayList/batch
Batch Update Holiday Lists
Method: put
Path: /primeapi/restapi/holidayList/batch
Create a Holiday List
Method: post
Path: /primeapi/restapi/holidayList
Delete a Holiday List
Method: delete
Path: /primeapi/restapi/holidayList/{id}
Update a Holiday List
Method: put
Path: /primeapi/restapi/holidayList
View a Holiday List
Method: get
Path: /primeapi/restapi/holidayList/{id}
View a Holiday List by Name
Method: get
Path: /primeapi/restapi/holidayList/name/{name}
Location
Use the Location service to create, view, update, and delete locations. A location is a geographical reference defined by a pair of coordinates, longitude and latitude.
Assign or Promote a Location
Method: post
Path: /primeapi/restapi/location/replicateObjectInWorkspaces/location/{locationId}/workspace/{workspaceId}
Batch Create Locations
Method: post
Path: /primeapi/restapi/location/batch
Batch Delete Locations
Method: delete
Path: /primeapi/restapi/location/batch
Batch Update Locations
Method: put
Path: /primeapi/restapi/location/batch
Create a Location
Method: post
Path: /primeapi/restapi/location
Delete a Location
Method: delete
Path: /primeapi/restapi/location/{id}
Update a Location
Method: put
Path: /primeapi/restapi/location
View a Location
Method: get
Path: /primeapi/restapi/location/{id}
View a Location by Code
Method: get
Path: /primeapi/restapi/location/code/{code}
View a Location by Code and Workspace
Method: get
Path: /primeapi/restapi/location/workspace/{workspaceId}/code/{code}
View a Location by Name
Method: get
Path: /primeapi/restapi/location/name/{name}
View a Location by Workspace
Method: get
Path: /primeapi/restapi/location/workspace/{id}
Measure
The Measure service enable you to create, update, view, and delete measures.
Assign or Promote a Measure
Method: post
Path: /primeapi/restapi/measure/replicateObjectInWorkspaces/measure/{measureId}/workspace/{workspaceId}
Batch Create Measures
Method: post
Path: /primeapi/restapi/measure/batch
Batch Delete Measures
Method: delete
Path: /primeapi/restapi/measure/batch
Batch Update Measures
Method: put
Path: /primeapi/restapi/measure/batch
Create a Measure
Method: post
Path: /primeapi/restapi/measure
Delete a Measure
Method: delete
Path: /primeapi/restapi/measure/{id}
Update a Measure
Method: put
Path: /primeapi/restapi/measure
View a Measure
Method: get
Path: /primeapi/restapi/measure/{id}
View a Measure by Workspace and Name
Method: get
Path: /primeapi/restapi/measure/workspace/{workspaceId}/measureName/{measureName}
MeasureThreshold
Use the Measure Threshold service to create, view, update, and delete measure thresholds.
Batch Create Measure Thresholds
Method: post
Path: /primeapi/restapi/measureThreshold/batch
Batch Delete Measure Thresholds
Method: delete
Path: /primeapi/restapi/measureThreshold/batch
Batch Update Measure Thresholds
Method: put
Path: /primeapi/restapi/measureThreshold/batch
Create a Measure Threshold
Method: post
Path: /primeapi/restapi/measureThreshold
Delete a Measure Threshold
Method: delete
Path: /primeapi/restapi/measureThreshold/{id}
Update a Measure Threshold
Method: put
Path: /primeapi/restapi/measureThreshold
View a Measure Threshold
Method: get
Path: /primeapi/restapi/measureThreshold/{id}
View a Measure Threshold by Measure
Method: get
Path: /primeapi/restapi/measureThreshold/measure/{measureId}
MonteCarlo Activity Delta
Use the Monte Carlo Activity Delta service to view Monte Carlo activity delta data.
View a Monte Carlo Activity Delta
Method: get
Path: /primeapi/restapi/monteCarloActivityDelta/{id}
View a Monte Carlo Activity Delta by Activity
Method: get
Path: /primeapi/restapi/monteCarloActivityDelta/activity/{activityId}
MonteCarlo Activity Deterministic Values
View Monte Carlo Activity Deterministic Values
Method: get
Path: /primeapi/restapi/monteCarloActivityDeterministicValues/{id}
View Monte Carlo Activity Deterministic Values by Activity and Scenario
Method: get
Path: /primeapi/restapi/monteCarloActivityDeterministicValues/activity/{activityId}/scenario/{scenario}
View Monte Carlo Activity Deterministic Values by Project and Scenario
Method: get
Path: /primeapi/restapi/monteCarloActivityDeterministicValues/project/{projectId}/scenario/{scenario}
MonteCarlo Activity Risk Result
Use the Monte Carlo Activity Risk Result service to send view Monte Carlo Activity Risk Result data.
View Monte Carlo Activity Risk Results
Method: get
Path: /primeapi/restapi/monteCarloActivityRiskResult/{id}
View Monte Carlo Activity Risk Results by Project Risk
Method: get
Path: /primeapi/restapi/monteCarloActivityRiskResult/projectRisk/{projectRiskId}
MonteCarlo Project Delta
Use the MonteCarlo Project Delta service to view MonteCarlo Project Delta data.
View a Monte Carlo Project Delta
Method: get
Path: /primeapi/restapi/monteCarloProjectDelta/{id}
View Monte Carlo Project Delta by Project and Scenario
Method: get
Path: /primeapi/restapi/monteCarloProjectDelta/project/{projectId}/deltaScenario/{scenario}
MonteCarlo Project Deterministic Values
Use the Monte Carlo Project Deterministic Values service to view Monte Carlo Project Deterministic Values.
View Monte Carlo Project Deterministic Values
Method: get
Path: /primeapi/restapi/monteCarloProjectDeterministicValues/{id}
View Monte Carlo Project Deterministic Values by Project and Scenario
Method: get
Path: /primeapi/restapi/monteCarloProjectDeterministicValues/project/{projectId}/scenario/{scenario}
MonteCarlo Project Result
Use the Monte Carlo Project Result service to view Monte Carlo Project Result data.
View a Monte Carlo Project Result
Method: get
Path: /primeapi/restapi/monteCarloProjectResult/{id}
View a Monte Carlo Project Result by Project and Scenario
Method: get
Path: /primeapi/restapi/monteCarloProjectResult/project/{projectId}/scenario/{scenario}
MonteCarlo Risk Result
Use the Monte Carlo Risk Result service to view Monte Carlo Risk Result data.
View a Monte Carlo Risk Result
Method: get
Path: /primeapi/restapi/monteCarloRiskResult/{id}
View a Monte Carlo Risk Result by Project and Scenario
Method: get
Path: /primeapi/restapi/monteCarloRiskResult/project/{projectId}/scenario/{scenario}
View a Monte Carlo Risk Result by Project Risk and Scenario
Method: get
Path: /primeapi/restapi/monteCarloRiskResult/projectRisk/{projectRiskId}/scenario/{scenario}
MonteCarlo Run Settings
Use the Monte Carlo Run Settings service to view Monte Carlo Run Settings.
View Monte Carlo Run Settings
Method: get
Path: /primeapi/restapi/monteCarloRunSettings/{id}
View Monte Carlo Run Settings by Project and Scenario
Method: get
Path: /primeapi/restapi/monteCarloRunSettings/project/{projectId}/scenario/{scenario}
MonteCarlo Settings
Use the Monte Carlo Settings service to create, view, and update Monte Carlo Settings.
Batch Update Monte Carlo Settings
Method: put
Path: /primeapi/restapi/monteCarloSettings/batch
Create Default Monte Carlo Settings for a Project
Method: post
Path: /primeapi/restapi/monteCarloSettings/createDefault/{projectId}
Update Monte Carlo Settings
Method: put
Path: /primeapi/restapi/monteCarloSettings
View Monte Carlo Settings
Method: get
Path: /primeapi/restapi/monteCarloSettings/{id}
View Monte Carlo Settings by Project
Method: get
Path: /primeapi/restapi/monteCarloSettings/project/{projectId}
Office
The Office service enables you to create, view, update, or delete offices.
Create an Office.
Method: post
Path: /primeapi/restapi/office
Create Offices.
Method: post
Path: /primeapi/restapi/office/batch
Delete an Office.
Method: delete
Path: /primeapi/restapi/office/{id}
Delete Offices.
Method: delete
Path: /primeapi/restapi/office/batch
Update an Office.
Method: put
Path: /primeapi/restapi/office
Update Offices.
Method: put
Path: /primeapi/restapi/office/batch
View an Office.
Method: get
Path: /primeapi/restapi/office/{id}
View Offices for specified company.
Method: get
Path: /primeapi/restapi/office/company/{name}/{postalCode}/{countryCode}
View Offices for specified name.
Method: get
Path: /primeapi/restapi/office/name/{officeName}
PBS
Use the PBS service to create, view, and delete defined Project, Product, or Plant Breakdown Structures. A PBS is a hierarchical representation of the materials or products required to complete a project.
Create a PBS
Method: post
Path: /primeapi/restapi/pbs
Delete a PBS
Method: delete
Path: /primeapi/restapi/pbs/{id}
Delete all Children in a PBS Hierarchy
Method: delete
Path: /primeapi/restapi/pbs/children/{id}
Update a PBS
Method: put
Path: /primeapi/restapi/pbs
View a Child in a PBS Hierarchy
Method: get
Path: /primeapi/restapi/pbs/children/{id}
View a PBS
Method: get
Path: /primeapi/restapi/pbs/{id}
View a PBS by Code
Method: get
Path: /primeapi/restapi/pbs/project/{id}/code/{code}
View a PBS by Name
Method: get
Path: /primeapi/restapi/pbs/project/{id}/name/{name}
View a PBS by Project
Method: get
Path: /primeapi/restapi/pbs/project/{id}
View All Children in a PBS Hierarchy
Method: get
Path: /primeapi/restapi/pbs/{id}/childrenHierarchy
Period Closeout Record
Use the Period Closeout service to view period closeouts.
View a Period Closeout
Method: get
Path: /primeapi/restapi/periodCloseoutRecord/{id}
View a Period Closeout by Project
Method: get
Path: /primeapi/restapi/periodCloseoutRecord/project/{projectId}
View a Scope Item Assignment Period Closeout
Method: get
Path: /primeapi/restapi/periodCloseoutData/{id}
View a Scope Item Assignment Period Closeout by Period Item
Method: get
Path: /primeapi/restapi/periodCloseoutData/periodItem/{periodItemId}
View a Scope Item Assignment Period Closeout by Scope Item Assignement
Method: get
Path: /primeapi/restapi/periodCloseoutData/scopeAssignment/{scopeItemAssignmentId}
Portfolio
Use the Portfolio service to create, view, update, and delete portfolios. Portfolios are collections of projects or other portfolios that enable you to plan resource and budget allocations across the collection.
Batch Create Portfolios
Method: post
Path: /primeapi/restapi/portfolio/batch
Batch Delete Portfolios
Method: delete
Path: /primeapi/restapi/portfolio/batch
Batch Update Portfolios
Method: put
Path: /primeapi/restapi/portfolio/batch
Create a Portfolio
Method: post
Path: /primeapi/restapi/portfolio
Delete a Portfolio
Method: delete
Path: /primeapi/restapi/portfolio/{id}
Refresh a Portfolio
Method: get
Path: /primeapi/restapi/portfolio/refresh/{id}
Update a Portfolio
Method: put
Path: /primeapi/restapi/portfolio
View a Portfolio
Method: get
Path: /primeapi/restapi/portfolio/{id}
View a Portfolio by Name
Method: get
Path: /primeapi/restapi/portfolio/name/{name}
View a Portfolio by Name and Workspace
Method: get
Path: /primeapi/restapi/portfolio/workspaceId/{workspaceId}/name/{name}
View a Portfolio Image
Method: get
Path: /primeapi/restapi/portfolio/image/{id}
View Portfolios by Workspace
Method: get
Path: /primeapi/restapi/portfolio/workspace/{id}
Portfolio Measure Manual Value
The Portfolio Measure Manual Value resource enables you to create, view, update, and delete portfolio measure manual values.
Batch Create Portfolio Measure Manual Values
Method: post
Path: /primeapi/restapi/portfolioMeasureManualValue/batch
Batch Delete Portfolio Measure Manual Values
Method: delete
Path: /primeapi/restapi/portfolioMeasureManualValue/batch
Batch Update Portfolio Measure Manual Values
Method: put
Path: /primeapi/restapi/portfolioMeasureManualValue/batch
Create a Portfolio Measure Manual Value
Method: post
Path: /primeapi/restapi/portfolioMeasureManualValue
Delete a Portfolio Measure Manual Value
Method: delete
Path: /primeapi/restapi/portfolioMeasureManualValue/{id}
Update a Portfolio Measure Manual Value
Method: put
Path: /primeapi/restapi/portfolioMeasureManualValue
View a Portfolio Measure Manual Value
Method: get
Path: /primeapi/restapi/portfolioMeasureManualValue/{id}
View a Portfolio Measure Manual Value by Measure
Method: get
Path: /primeapi/restapi/portfolioMeasureManualValue/measure/{measureId}
View a Portfolio Measure Manual Value by Measure and Portfolio
Method: get
Path: /primeapi/restapi/portfolioMeasureManualValue/measure/{measureId}/portfolio/{portfolioId}
View a Portfolio Measure Manual Value by Portfolio
Method: get
Path: /primeapi/restapi/portfolioMeasureManualValue/portfolio/{portfolioId}
PortfolioMeasure
Use the Portfolio Measure service to create, view, update, and delete portfolio measures. Portfolio measures represent associations between measures and portfolios.
Batch Create Portfolio Measures
Method: post
Path: /primeapi/restapi/portfolioMeasure/batch
Batch Delete Portfolio Measures
Method: delete
Path: /primeapi/restapi/portfolioMeasure/batch
Batch Update Portfolio Measures
Method: put
Path: /primeapi/restapi/portfolioMeasure/batch
Create a Portfolio Measure
Method: post
Path: /primeapi/restapi/portfolioMeasure
Delete a Portfolio Measure
Method: delete
Path: /primeapi/restapi/portfolioMeasure/{id}
Update a Portfolio Measure
Method: put
Path: /primeapi/restapi/portfolioMeasure
View a Portfolio Measure
Method: get
Path: /primeapi/restapi/portfolioMeasure/{id}
View a Portfolio Measure by Measure
Method: get
Path: /primeapi/restapi/portfolioMeasure/measure/{measureId}
View a Portfolio Measure by Portfolio
Method: get
Path: /primeapi/restapi/portfolioMeasure/currentUserPortfolios
View a Portfolio Measure by Portfolio
Method: get
Path: /primeapi/restapi/portfolioMeasure/portfolio/{portfolioId}
PortfolioMeasureValue
Use the Portfolio Measure Value service to view portfolio measure values.
View a Project Measure Value
Method: get
Path: /primeapi/restapi/portfolioMeasureValue/{id}
View a Project Measure Value by Measure
Method: get
Path: /primeapi/restapi/portfolioMeasureValue/measure/{measureId}
View a Project Measure Value by Measure and Portfolio
Method: get
Path: /primeapi/restapi/portfolioMeasureValue/measure/{measureId}/portfolio/{portfolioId}
View Project Measure Value by Portfolio
Method: get
Path: /primeapi/restapi/portfolioMeasureValue/portfolio/{portfolioId}
PortfolioProject
Use the Portfolio Project service to create, view, update, and delete portfolio projects. Portfolio projects are references to projects that belong to a portfolio. Portfolio projects contain the system-generated identifiers of the project, as well as the identifier of the portfolio the project belongs to.
View a Portfolio Project
Method: get
Path: /primeapi/restapi/portfolioProject/{id}
View Portfolio Projects by Portfolio
Method: get
Path: /primeapi/restapi/portfolioProject/portfolio/{id}
Project
Use the Project service to create, view, update, and delete projects. Projects are company initiatives and goals you can manage in Oracle Prime Update Keys : 'projectId'
Batch Delete Projects
Method: delete
Path: /primeapi/restapi/project/batch?cascadeOnDelete={cascadeOnDelete}
Batch Integrate Projects with an External Data Source
Method: post
Path: /primeapi/restapi/project/syncBatch
Create a Project
Method: post
Path: /primeapi/restapi/project
Delete a Project
Method: delete
Path: /primeapi/restapi/project/{id}?cascadeOnDelete={cascadeOnDelete}
Integrate a Project with an External Data Source
Method: post
Path: /primeapi/restapi/project/sync
Update a Project
Method: put
Path: /primeapi/restapi/project
View a Project by Code
Method: get
Path: /primeapi/restapi/project/code/{code}
View a Project by Code and Workspace
Method: get
Path: /primeapi/restapi/project/workspace/{workspaceId}/code/{code}
View a project by code.
Method: get
Path: /primeapi/restapi/project/byItemCode?workspaceCode={workspaceCode}&projectCode={projectCode}
View a Project by Name
Method: get
Path: /primeapi/restapi/project/name/{name}
View a Project by Workspace
Method: get
Path: /primeapi/restapi/project/workspace/{id}
View a Project Image
Method: get
Path: /primeapi/restapi/project/image/{id}
View all projects by parent code.
Method: get
Path: /primeapi/restapi/project/byParent?workspaceCode={workspaceCode}
View Integrated Projects
Method: get
Path: /primeapi/restapi/project/externallySourced
View Project by Name and Workspace
Method: get
Path: /primeapi/restapi/project/nameLike/{name}
View Project Configured Fields
Method: get
Path: /primeapi/restapi/project/{id}/configuredFields
View Projects by Assigned Code Value
Method: get
Path: /primeapi/restapi/project/codeType/{typeId}/codeValue/{code}
View Projects by Assigned Configured Field Value
Method: get
Path: /primeapi/restapi/project/configuredField/{viewColumnName}/{value}
Project Actuals
Use the Project Actuals service to create, view, update, and delete project actuals. Project actuals are manual or scope based costs that represent pending or confirmed spending on your projects. Update Keys : 'projectActualId'
Batch Create Project Actuals
Method: post
Path: /primeapi/restapi/projectActuals/batch
Batch Integrate Project Actuals Data with an External Data Source
Method: post
Path: /primeapi/restapi/projectActuals/syncBatch
Batch Update Project Actuals
Method: put
Path: /primeapi/restapi/projectActuals/batch
Create a Project Actual
Method: post
Path: /primeapi/restapi/projectActuals
Integrate Project Actuals Data with an External Data Source
Method: post
Path: /primeapi/restapi/projectActuals/sync
Update a Project Actual
Method: put
Path: /primeapi/restapi/projectActuals
View a Project Actual
Method: get
Path: /primeapi/restapi/projectActuals/{id}
View a Project Actual by Code
Method: get
Path: /primeapi/restapi/projectActuals/code/{code}
View a Project Actual by Code and Project
Method: get
Path: /primeapi/restapi/projectActuals/project/{projectId}/code/{code}
View Integrated Project Actuals
Method: get
Path: /primeapi/restapi/projectActuals/externallySourced
View Project Actual Configured Fields
Method: get
Path: /primeapi/restapi/projectActuals/{id}/configuredFields
View Project Actuals by Assigned Configured Field Value
Method: get
Path: /primeapi/restapi/projectActuals/project/{id}/configuredField/{viewColumnName}/{value}
View Project Actuals by Project
Method: get
Path: /primeapi/restapi/projectActuals/project/{id}
Project Actuals Line Item
Batch Integrate Project Actuals Line Items with an External Data Source
Method: post
Path: /primeapi/restapi/projectActualsLineItem/syncBatch
Create a Project Actuals Line Item
Method: post
Path: /primeapi/restapi/projectActualsLineItem
Create Project Actuals Line Items
Method: post
Path: /primeapi/restapi/projectActualsLineItem/batch
Delete a Project Actuals Line Item
Method: delete
Path: /primeapi/restapi/projectActualsLineItem/{id}
Delete Project Actuals Line Items
Method: delete
Path: /primeapi/restapi/projectActualsLineItem/batch
Integrate a Project Actuals Line Item with an External Data Source
Method: post
Path: /primeapi/restapi/projectActualsLineItem/sync
Update a Project Actuals Line Item
Method: put
Path: /primeapi/restapi/projectActualsLineItem
Update Project Actuals Line Items
Method: put
Path: /primeapi/restapi/projectActualsLineItem/batch
View a Project Actual Line Item
Method: get
Path: /primeapi/restapi/projectActualsLineItem/{id}
View a Project Actuals Line Item by Code
Method: get
Path: /primeapi/restapi/projectActualsLineItem/code/{code}
View a Project Actuals Line Item by Code and Project Actual ID
Method: get
Path: /primeapi/restapi/projectActualsLineItem/projectActual/{actualId}/code/{code}
View Integrated Project Actuals Line Items
Method: get
Path: /primeapi/restapi/projectActualsLineItem/externallySourced
View Project Actual Line Items by Project Actual
Method: get
Path: /primeapi/restapi/projectActualsLineItem/projectActuals/{id}
Project Budget
Use the Project Budget services to view project budgets.
Change a Project Budget Status
Method: put
Path: /primeapi/restapi/projectBudget/project/{id}/changeBudgetStatus
View a Project Budget
Method: get
Path: /primeapi/restapi/projectBudget/{id}
View a project budget by parent code
Method: get
Path: /primeapi/restapi/projectBudget/byParent?workspaceCode={workspaceCode}&projectCode={projectCode}
View a Project Budget by Project
Method: get
Path: /primeapi/restapi/projectBudget/project/{id}
View A Project Budget Status Transition History by Project
Method: get
Path: /primeapi/restapi/projectBudget/project/{id}/statusTransitionHistory
View Budget Transactions by Project
Method: get
Path: /primeapi/restapi/projectBudget/project/{id}/transactions
View Budget Transactions by Project Budget
Method: get
Path: /primeapi/restapi/projectBudget/{id}/transactions
Project Collections
The Project Collections service enables you to send requests related to Project Collections.
Batch Create Project Collections
Method: post
Path: /primeapi/restapi/projectCollections/batch
Batch Delete Project Collections
Method: delete
Path: /primeapi/restapi/projectCollections/batch
Batch Update Project Collections
Method: put
Path: /primeapi/restapi/projectCollections/batch
Create a Project Collection
Method: post
Path: /primeapi/restapi/projectCollections
Delete a Project Collection
Method: delete
Path: /primeapi/restapi/projectCollections/{id}
Update a Project Collection
Method: put
Path: /primeapi/restapi/projectCollections
View a Project Collection
Method: get
Path: /primeapi/restapi/projectCollections/{id}
View a Project Collection by Name
Method: get
Path: /primeapi/restapi/projectCollections/name/{name}
View a Project Collection by Workspace
Method: get
Path: /primeapi/restapi/projectCollections/workspace/{workspaceId}
View Projects in a Project Collection
Method: get
Path: /primeapi/restapi/projectCollections/projectCollection/{projectCollectionId}
Project Company
Use the Project Company service to view companies associated with projects. Update Keys : 'projectCompanyId'
Batch Create Project Companies
Method: post
Path: /primeapi/restapi/projectCompany/batch
Batch Delete Project Companies
Method: delete
Path: /primeapi/restapi/projectCompany/batch
Batch Update Project Companies.
Method: put
Path: /primeapi/restapi/projectCompany/batch
Create a Project Company
Method: post
Path: /primeapi/restapi/projectCompany
Delete a Project Company by Work Manager Task
Method: delete
Path: /primeapi/restapi/projectCompany/{id}
Update a Project Company
Method: put
Path: /primeapi/restapi/projectCompany
View a Project Company
Method: get
Path: /primeapi/restapi/projectCompany/{id}
View Project Companies
Method: get
Path: /primeapi/restapi/projectCompany/company/{companyName}/{postalCode}
View Project Companies by Code
Method: get
Path: /primeapi/restapi/projectCompany/workspace/{workspaceCode}/project/{projectCode}
View Project Companies by Project
Method: get
Path: /primeapi/restapi/projectCompany/project/{projectId}
Project Dependency
Use the Project Dependency service to create, view, update, and delete project dependencies. Dependencies specify direct relationships between projects and indicate the progress of one project is reliant upon the progress of another.
Batch Create Project Dependencies
Method: post
Path: /primeapi/restapi/projectDependency/batch
Batch Delete Project Dependencies
Method: delete
Path: /primeapi/restapi/projectDependency/batch
Batch Update Project Dependencies
Method: put
Path: /primeapi/restapi/projectDependency/batch
Create a Project Dependency
Method: post
Path: /primeapi/restapi/projectDependency
Delete a Project Dependency
Method: delete
Path: /primeapi/restapi/projectDependency/{id}
Update a Project Dependency
Method: put
Path: /primeapi/restapi/projectDependency
View a Project Dependency
Method: get
Path: /primeapi/restapi/projectDependency/{id}
View Project Dependencies by Dependent Project
Method: get
Path: /primeapi/restapi/projectDependency/depends/{id}
View Project Dependencies by Supported Project
Method: get
Path: /primeapi/restapi/projectDependency/supports/{id}
Project Rank
The Project Rank service enables you to send and retrieve information related to a project's rank.
Batch Create Project Ranks
Method: post
Path: /primeapi/restapi/projectRank/batch
Batch Update Project Ranks
Method: put
Path: /primeapi/restapi/projectRank/batch
Create a Project Rank
Method: post
Path: /primeapi/restapi/projectRank
Update a Project Rank
Method: put
Path: /primeapi/restapi/projectRank
View a Project Rank
Method: get
Path: /primeapi/restapi/projectRank/{id}
View a Project Rank by Project
Method: get
Path: /primeapi/restapi/projectRank/project/{projectId}
Project Resource Work Rate
The Project Resource Work Rate service enables you to send and retrieve information related to work rate of a project's resource.
Batch Create Project Resource Work Rates
Method: post
Path: /primeapi/restapi/projectResourceWorkRate/batch
Batch Update Project Resource Work Rates
Method: put
Path: /primeapi/restapi/projectResourceWorkRate/batch
Create a Project Resource Work Rate
Method: post
Path: /primeapi/restapi/projectResourceWorkRate
Update a Project Resource Work Rate
Method: put
Path: /primeapi/restapi/projectResourceWorkRate
View a Project Resource Work Rate
Method: get
Path: /primeapi/restapi/projectResourceWorkRate/{id}
View a Project Resource Work Rate by Project and Resource
Method: get
Path: /primeapi/restapi/projectResourceWorkRate/project/{projectId}/resource/{resourceId}
View a Project Resource Work Rate by Project Resource
Method: get
Path: /primeapi/restapi/projectResourceWorkRate/projectResource/{projectResouceId}
Project Risk
Use the Project Risk service to create, view, update, and delete project risks.
Batch Create Project Risks
Method: post
Path: /primeapi/restapi/projectRisk/batch
Batch Delete Project Risks
Method: delete
Path: /primeapi/restapi/projectRisk/batch
Batch Update Project Risks
Method: put
Path: /primeapi/restapi/projectRisk/batch
Create a Project Risk
Method: post
Path: /primeapi/restapi/projectRisk
Delete a Project Risk
Method: delete
Path: /primeapi/restapi/projectRisk/{id}
Update a Project Risk
Method: put
Path: /primeapi/restapi/projectRisk
View a Project Risk
Method: get
Path: /primeapi/restapi/projectRisk/{id}
View a Project Risk by Configured Field Value
Method: get
Path: /primeapi/restapi/projectRisk/project/{id}/configuredField/{viewColumnName}/{value}
View a Project Risk by Project and Risk Code
Method: get
Path: /primeapi/restapi/projectRisk/project/{id}/riskCode/{riskCode}
View a risk by name
Method: get
Path: /primeapi/restapi/projectRisk/name/{name}
View Project Risk Configured Fields
Method: get
Path: /primeapi/restapi/projectRisk/{id}/configuredFields
View Project Risks by Project
Method: get
Path: /primeapi/restapi/projectRisk/projectId/{id}
View Risk Mitigation by Project Risk
Method: get
Path: /primeapi/restapi/projectRisk/mitigation/{projectRiskId}
ProjectMeasureValue
The Project Measure Value service enables you to send and retrieve information related to Project Measure Values.
View a Project Measure Value
Method: get
Path: /primeapi/restapi/projectMeasureValue/{id}
View a Project Measure Value by Measure
Method: get
Path: /primeapi/restapi/projectMeasureValue/measure/{measureId}
View a Project Measure Value by Project
Method: get
Path: /primeapi/restapi/projectMeasureValue/project/{projectId}
Projects Aggregate
Use the Projects Aggregate service to view project information aggregated with budget plans and project portfolios.
View a Project Aggregate by Budget Plan
Method: get
Path: /primeapi/restapi/projectsAggregate/capitalPlan?id={id}
View a Project Aggregate by Reference ID and Rollup Type
Method: get
Path: /primeapi/restapi/projectsAggregate/reference/{refId}/rollupType/{rollupType}
View a Project Aggregate by Rollup
Method: get
Path: /primeapi/restapi/projectsAggregate/rollupId/{rollupId}
View Project Aggregates by Project Portfolio
Method: get
Path: /primeapi/restapi/projectsAggregate/projectPortfolio?id={id}
Reason
Use the Reason service to create, view, update, and delete reasons. Reasons provide justifications for recommitting to a task. Update Keys : 'reasonId'
Assign or Promote a Reason
Method: post
Path: /primeapi/restapi/reason/replicateObjectInWorkspaces/reason/{reasonId}/workspace/{workspaceId}
Batch Create Reasons
Method: post
Path: /primeapi/restapi/reason/batch
Batch Delete Reasons
Method: delete
Path: /primeapi/restapi/reason/batch
Batch Update Reasons
Method: put
Path: /primeapi/restapi/reason/batch
Create a Reason
Method: post
Path: /primeapi/restapi/reason
Delete a Reason
Method: delete
Path: /primeapi/restapi/reason/{id}
Update a Reason
Method: put
Path: /primeapi/restapi/reason
View a Reason
Method: get
Path: /primeapi/restapi/reason/{id}
View Reason by Workspace and Name
Method: get
Path: /primeapi/restapi/reason/workspace/{workspaceId}/name/{reasonName}
View Reasons by Workspace
Method: get
Path: /primeapi/restapi/reason/workspace/{id}
RelatedItems
Use the entity reference service to create, view, and delete references between application objects.
Batch Create References
Method: post
Path: /primeapi/restapi/entityReference/batch
Batch Delete References
Method: delete
Path: /primeapi/restapi/entityReference/batch
Create a Reference
Method: post
Path: /primeapi/restapi/entityReference/link
Delete a Reference
Method: delete
Path: /primeapi/restapi/entityReference/{id}
Unlink a Reference
Method: put
Path: /primeapi/restapi/entityReference/unLink
View Linked References
Method: get
Path: /primeapi/restapi/entityReference/linkedReferences?projectCode={projectCode}&workspaceCode={workspaceCode}&recordType={recordType}&recordCode={recordCode}&recordId={recordId}
View Objects that Support References
Method: get
Path: /primeapi/restapi/entityReference/linkableObjectReferences?projectCode={projectCode}&workspaceCode={workspaceCode}&recordType={recordType}&recordCode={recordCode}&recordId={recordId}&objectType={objectType}
View References
Method: get
Path: /primeapi/restapi/entityReference/{id}
View the References of a Linked Object
Method: get
Path: /primeapi/restapi/entityReference/linkedObjectReferences?projectCode={projectCode}&workspaceCode={workspaceCode}&recordType={recordType}&recordCode={recordCode}&recordId={recordId}&objectType={objectType}
View the Related Items of a Reference
Method: get
Path: /primeapi/restapi/entityReference/relatedItems?projectCode={projectCode}&workspaceCode={workspaceCode}&recordType={recordType}&recordCode={recordCode}&recordId={recordId}
Relationship
Use the Relationship service to create, view, update, and delete relationships. Relationships define how an activity relates to the start or finish of another activity and indicate whether activities must be completed sequentially or can be done in parallel.
Batch Create Activity Relationships
Method: post
Path: /primeapi/restapi/relationship/batch
Batch Delete Activity Relationships
Method: delete
Path: /primeapi/restapi/relationship/batch
Batch Update Activity Relationships
Method: put
Path: /primeapi/restapi/relationship/batch
Create an Activity Relationship
Method: post
Path: /primeapi/restapi/relationship
Delete an Activity Relationship
Method: delete
Path: /primeapi/restapi/relationship/{id}
Update an activity relationship
Method: put
Path: /primeapi/restapi/relationship
View all Relationships Associated to an Activity
Method: get
Path: /primeapi/restapi/relationship/activityId/{id}
View an Activity Relationship
Method: get
Path: /primeapi/restapi/relationship/{id}
Report Cycle
Use the Report Cycle service to create, view, update, and delete report cycles created within a project. Report cycles represent the planning periods used to plan and update scope assignment progress.
Assign or Promote a Report Cycle
Method: post
Path: /primeapi/restapi/reportCycle/replicateObjectInWorkspaces/reportCycle/{reportCycleId}/workspace/{workspaceId}
Batch Create Report Cycles
Method: post
Path: /primeapi/restapi/reportCycle/batch
Batch Delete Report Cycles
Method: delete
Path: /primeapi/restapi/reportCycle/batch
Batch Update Report Cycles
Method: put
Path: /primeapi/restapi/reportCycle/batch
Create a Report Cycle
Method: post
Path: /primeapi/restapi/reportCycle
Delete a Report Cycle
Method: delete
Path: /primeapi/restapi/reportCycle/{id}
Update a Report Cycle
Method: put
Path: /primeapi/restapi/reportCycle
View a Report Cycle
Method: get
Path: /primeapi/restapi/reportCycle/{id}
View a Report Cycle by Workspace
Method: get
Path: /primeapi/restapi/reportCycle/workspace/{id}
Resource
The Resource service enables you to create, view, update, and delete resources. Resources represent any quantifiable item you can track and assign to specific activities in a project. Update Keys : 'resourceId'
Assign or Promote a Resource
Method: post
Path: /primeapi/restapi/resource/replicateObjectInWorkspaces/resource/{resourceId}/workspace/{workspaceId}
Batch Create Resources or Roles
Method: post
Path: /primeapi/restapi/resource/batch
Batch Delete Resources or Roles
Method: delete
Path: /primeapi/restapi/resource/batch
Batch Delete Workspace Resources or Roles
Method: delete
Path: /primeapi/restapi/resource/workspaceResource/batch
Batch Integrate Resources with an External Data Source
Method: post
Path: /primeapi/restapi/resource/syncBatch
Batch Update Resources or Roles
Method: put
Path: /primeapi/restapi/resource/batch
Delete a Resource or Role
Method: delete
Path: /primeapi/restapi/resource/{id}
Delete a Workspace Resource or Role
Method: delete
Path: /primeapi/restapi/resource/workspaceResource/{workspaceResourceId}
Integrate a Resource with an External Data Source
Method: post
Path: /primeapi/restapi/resource/sync
View a resource by code
Method: get
Path: /primeapi/restapi/resource/byItemCode?workspaceCode={workspaceCode}&resourceCode={resourceCode}
View a Resource by Code and Type
Method: get
Path: /primeapi/restapi/resource/code/{code}/type/{type}
View a Resource by Resource Class
Method: get
Path: /primeapi/restapi/resource?type={type}
View a Resource or Role
Method: get
Path: /primeapi/restapi/resource/{id}
View All Child Resources and Roles by Resource Hierarchy
Method: get
Path: /primeapi/restapi/resource/{id}/type/{type}/childrenHierarchy
View all resources by parent code
Method: get
Path: /primeapi/restapi/resource/byParent?workspaceCode={workspaceCode}
View Integrated Resources
Method: get
Path: /primeapi/restapi/resource/externallySourced
View Resources and Roles by Workspace
Method: get
Path: /primeapi/restapi/resource/workspace/{id}
View Resources by Assigned Code Value
Method: get
Path: /primeapi/restapi/resource/codeType/{typeId}/codeValue/{code}
View Resources or Roles by Project
Method: get
Path: /primeapi/restapi/resource/projectId/{id}
View Workspace Resources or Roles by Workspace and Resource Class
Method: get
Path: /primeapi/restapi/resource/workspaceResource/workspace/{workspaceId}?type={type}
Resource Demand
Use the Resource Demand service to create, view, update, and delete resource demands. A resource demands represent the high-level role requirements of a project.
Create a resource demand
Method: post
Path: /primeapi/restapi/resourceDemand
Create resource demands
Method: post
Path: /primeapi/restapi/resourceDemand/batch
Delete a resource demand
Method: delete
Path: /primeapi/restapi/resourceDemand/{id}
Delete resource demands
Method: delete
Path: /primeapi/restapi/resourceDemand/batch
Update a resource demand
Method: put
Path: /primeapi/restapi/resourceDemand
Update resource demands
Method: put
Path: /primeapi/restapi/resourceDemand/batch
View a resource demand
Method: get
Path: /primeapi/restapi/resourceDemand/{id}
View Resource Demands by Project ID
Method: get
Path: /primeapi/restapi/resourceDemand/project/{id}
Resource Role Assignment
The Resource Role Assignment services enables you to create, view, update, and delete assignments between resources and roles. A resource role assignment indicates whether or not a resource is fulfilling a particular role.
Batch Create Resource Role Assignments
Method: post
Path: /primeapi/restapi/resourceRoleAssignment/batch
Batch Delete Resource Role Assignments
Method: delete
Path: /primeapi/restapi/resourceRoleAssignment/batch
Batch Update Resource Role Assignments
Method: put
Path: /primeapi/restapi/resourceRoleAssignment/batch
Create a Resource Role Assignment
Method: post
Path: /primeapi/restapi/resourceRoleAssignment
Delete a Resource Role Assignment
Method: delete
Path: /primeapi/restapi/resourceRoleAssignment/{id}
Update a Resource Role Assignment
Method: put
Path: /primeapi/restapi/resourceRoleAssignment
View a Resource Role Assignment
Method: get
Path: /primeapi/restapi/resourceRoleAssignment/{id}
View a Resource Role Assignment by Primary Flag
Method: get
Path: /primeapi/restapi/resourceRoleAssignment/primaryFlag/{flag}
View a Resource Role Assignment by Resource
Method: get
Path: /primeapi/restapi/resourceRoleAssignment/resource/{id}
View a Resource Role Assignment by Resource and Role
Method: get
Path: /primeapi/restapi/resourceRoleAssignment/resource/{resId}/role/{roleId}
Resource Work Rate
Use the Resource Work Rate service to create, view, update, and delete workspace resource rates for resources or roles.
Batch Create Maximum Work Units per Time Period
Method: post
Path: /primeapi/restapi/resourceWorkRate/batch
Batch Delete Maximum Work Units per Time Period
Method: delete
Path: /primeapi/restapi/resourceWorkRate/batch
Batch Update Maximum Work Units per Time Period
Method: put
Path: /primeapi/restapi/resourceWorkRate/batch
Create a Maximum Work Unit per Time Period
Method: post
Path: /primeapi/restapi/resourceWorkRate
Delete a Maximum Work Unit per Time Period
Method: delete
Path: /primeapi/restapi/resourceWorkRate/{id}
Update a Maximum Work Unit per Time Period
Method: put
Path: /primeapi/restapi/resourceWorkRate
View a Maximum Work Unit per Time Period
Method: get
Path: /primeapi/restapi/resourceWorkRate/{id}
View a Resource Work Rate
Method: get
Path: /primeapi/restapi/resourceWorkRate/resource/{id}
Rfi
Use the RFI service to create, update, view, and delete RFIs. RFIs are formal questions from subcontractors to general contractors. Update Keys : 'projectId, itemCode' or 'rfiId' or 'workspaceCode, projectCode, itemCode'
Accept an RFI
Method: put
Path: /primeapi/restapi/rfi/accept/workspace/{workspaceCode}/project/{projectCode}/code/{rfiCode}/discussion/{discussionId}
Batch Create an RFI
Method: post
Path: /primeapi/restapi/rfi/batch
Batch Delete an RFI
Method: delete
Path: /primeapi/restapi/rfi/batch
Batch Update an RFI
Method: put
Path: /primeapi/restapi/rfi/batch
Create an RFI
Method: post
Path: /primeapi/restapi/rfi
Delte an RFI
Method: delete
Path: /primeapi/restapi/rfi/{id}
Remove Users from RFI Notifications
Method: delete
Path: /primeapi/restapi/rfi/delete/notificationUsers/workspace/{workspaceCode}/project/{projectCode}/code/{rfiCode}
Updat an RFI
Method: put
Path: /primeapi/restapi/rfi
View an RFI
Method: get
Path: /primeapi/restapi/rfi/{id}
View an RFI by Code
Method: get
Path: /primeapi/restapi/rfi/workspace/{workspaceCode}/project/{projCode}/code/{rfiCode}
View an RFI by Parent
Method: get
Path: /primeapi/restapi/rfi/workspace/{workspaceCode}/project/{projectCode}
View RFI Correspondence
Method: get
Path: /primeapi/restapi/rfi/correspondence/workspace/{workspaceCode}/project/{projCode}/code/{rfiCode}
Withdraw RFI Acceptance
Method: put
Path: /primeapi/restapi/rfi/unaccept/workspace/{workspaceCode}/project/{projectCode}/code/{rfiCode}/discussion/{discussionId}
Risk Impact
Use the Risk Impact service to create, view, update, and delete risk impacts. Risk Impacts capture the overall significance of potential effects risks can have on your projects, and help you determine which risks to prioritize and mitigate.
Batch Create Risk Impacts
Method: post
Path: /primeapi/restapi/riskImpact/batch
Batch Delete Risk Impacts
Method: delete
Path: /primeapi/restapi/riskImpact/batch
Batch Update Risk Impacts
Method: put
Path: /primeapi/restapi/riskImpact/batch
Create a Risk Impact
Method: post
Path: /primeapi/restapi/riskImpact
Delete a Risk Impact
Method: delete
Path: /primeapi/restapi/riskImpact/{id}
Update a Risk Impact
Method: put
Path: /primeapi/restapi/riskImpact
View a Risk Impact
Method: get
Path: /primeapi/restapi/riskImpact/{id}
View Risk Impacts by Project Risk, Risk Score Type, and Risk Score Threshold
Method: get
Path: /primeapi/restapi/riskImpact/projectRisk/{pId}/riskScoreType/{sId}/riskScoreThreshold/{tId}
Risk Matrix
Use the Risk Matrix service to create, view, update, and delete risk matrixes.
Assign or Promote a Risk Matrix
Method: post
Path: /primeapi/restapi/riskMatrix/replicateObjectInWorkspaces/riskMatrix/{riskMatrixId}/workspace/{workspaceId}
Batch Create Risk Matrixes
Method: post
Path: /primeapi/restapi/riskMatrix/batch
Batch Delete Risk Matrixes
Method: delete
Path: /primeapi/restapi/riskMatrix/batch
Batch Update Risk Matrixes
Method: put
Path: /primeapi/restapi/riskMatrix/batch
Create a Risk Matrix
Method: post
Path: /primeapi/restapi/riskMatrix
Delete a Risk Matrix
Method: delete
Path: /primeapi/restapi/riskMatrix/{id}
Update a Risk Matrix
Method: put
Path: /primeapi/restapi/riskMatrix
View a Risk Matrix
Method: get
Path: /primeapi/restapi/riskMatrix/{id}
View a Risk Matrix by Name
Method: get
Path: /primeapi/restapi/riskMatrix/name/{name}
View a risk matrix by name and workspace
Method: get
Path: /primeapi/restapi/riskMatrix/resolveRiskMatrix/workspace/{workspaceId}/riskMatrix/{riskMatrix}
View a Risk Matrix by Name and Workspace
Method: get
Path: /primeapi/restapi/riskMatrix/workspace/{workspaceId}/name/{name}
View Risk Matrixes by Workspace
Method: get
Path: /primeapi/restapi/riskMatrix/workspace/{id}
View Workspace Risk Matrix Template by Name
Method: get
Path: /primeapi/restapi/riskMatrix/resolveByName/{name}
Risk Mitigation
The Risk Mitigation service enables you to create, update, view, and delete risk mitigations.
Batch Create Risk Mitigations
Method: post
Path: /primeapi/restapi/riskMitigation/batch
Batch Delete Risk Mitigations
Method: delete
Path: /primeapi/restapi/riskMitigation/batch
Batch Update Risk Mitigations
Method: put
Path: /primeapi/restapi/riskMitigation/batch
Create a Risk Mitigation
Method: post
Path: /primeapi/restapi/riskMitigation
Delete a Risk Mitigation
Method: delete
Path: /primeapi/restapi/riskMitigation/{id}
Update a Risk Mitigation
Method: put
Path: /primeapi/restapi/riskMitigation
View a Risk Mitigation
Method: get
Path: /primeapi/restapi/riskMitigation/{id}
View a Risk Mitigation by Code
Method: get
Path: /primeapi/restapi/riskMitigation/code/{code}
View a Risk Mitigation by Code and Project Risk
Method: get
Path: /primeapi/restapi/riskMitigation/projectRisk/{projectRiskId}/code/{code}
Risk Score Type
Use the Risk Score Type service to create, view, update, and delete risk score types. Risk Score Types specify thresholds which can be used to quantitatively compare the anticipated impacts of risks.
Assign or Promote a Risk Score Type
Method: post
Path: /primeapi/restapi/riskScoreType/replicateObjectInWorkspaces/riskScoreType/{riskScoreTypeId}/workspace/{workspaceId}
Batch Create Risk Score Types
Method: post
Path: /primeapi/restapi/riskScoreType/batch
Batch Update Risk Score Types
Method: put
Path: /primeapi/restapi/riskScoreType/batch
Create a Risk Score Type
Method: post
Path: /primeapi/restapi/riskScoreType
Delete a Risk Score Type
Method: delete
Path: /primeapi/restapi/riskScoreType/{id}
Update a Risk Score Type
Method: put
Path: /primeapi/restapi/riskScoreType
View a Risk Score Type
Method: get
Path: /primeapi/restapi/riskScoreType/{id}
View a Risk Score Type by Name
Method: get
Path: /primeapi/restapi/riskScoreType/name/{name}
View a Risk Score Type by Name and Project
Method: get
Path: /primeapi/restapi/riskScoreType/name/{name}/project/{projectId}
View a risk score type by name and workspace
Method: get
Path: /primeapi/restapi/riskScoreType/resolveRiskScoreType/workspace/{workspaceId}/riskScoreType/{riskScoreTypeName}
View a Risk Score Type by Name and Workspace
Method: get
Path: /primeapi/restapi/riskScoreType/workspace/{workspaceId}/name/{name}
View all Risk Score Types by Workspace
Method: get
Path: /primeapi/restapi/riskScoreType/workspace/{id}
View Score Types by Associated Threshold
Method: get
Path: /primeapi/restapi/riskScoreType/threshold/{riskScoreTypeId}
Scope Assignment Actuals Time Phased Data
The Scope Assignment Actuals Time Phased Data service enables you to create, view, update, and delete scope assignment time phased actuals data.
Create Scope Assignment Actuals Time Phased Data
Method: post
Path: /primeapi/restapi/actualsTimePhasedData
Create Scope Assignment Actuals Time Phased Data
Method: post
Path: /primeapi/restapi/actualsTimePhasedData/batch
Update Scope Assignment Actuals Time Phased Data
Method: put
Path: /primeapi/restapi/actualsTimePhasedData/batch
Update Scope Assignment Actuals Time Phased Data
Method: put
Path: /primeapi/restapi/actualsTimePhasedData
View Scope Assignment Actuals Time Phased Data
Method: get
Path: /primeapi/restapi/actualsTimePhasedData/{id}
View Scope Assignment Actuals Time Phased Data by Scope Assignment
Method: get
Path: /primeapi/restapi/actualsTimePhasedData/scopeAssignment/{id}
Scope Assignment Baseline Time Phased Data
Use the Scope Assignment Baseline Time Phased Data service to view, create, update and delete scope assignment baseline time phased data.
View Scope Assignment Baseline Time Phased Data
Method: get
Path: /primeapi/restapi/baselineTimePhasedData/{id}
View Scope Assignment Baseline Time Phased Data by Scope Assignment
Method: get
Path: /primeapi/restapi/baselineTimePhasedData/scopeAssignment/{id}
Scope Assignment Installed Time Phased Data
Use the Scope Assignment Installed Time phased data service enables you to send requests related to scope assignment installed time phased data.
Create a Scope Assignment Installed Time Phased Data
Method: post
Path: /primeapi/restapi/installedTimePhasedData
Create Scope Assignment Installed Time Phased Data
Method: post
Path: /primeapi/restapi/installedTimePhasedData/batch
Update a Scope Assignment Installed Time Phased Data
Method: put
Path: /primeapi/restapi/installedTimePhasedData
Update Scope Assignment Installed Time Phased Data
Method: put
Path: /primeapi/restapi/installedTimePhasedData/batch
View Scope Assignment Installed Time Phased Data
Method: get
Path: /primeapi/restapi/installedTimePhasedData/{id}
View Scope Assignment Installed Time Phased Data by Scope Assignment ID
Method: get
Path: /primeapi/restapi/installedTimePhasedData/scopeAssignment/{id}
Scope Assignment Planned Time Phased Data
Use the scope assignment planned time phased data service to view scope assignment planned time phased data.
Create a Scope Assignment Planned Time Phased Data Object
Method: post
Path: /primeapi/restapi/plannedTimePhasedData
Create Scope Assignment Planned Time Phased Data.
Method: post
Path: /primeapi/restapi/plannedTimePhasedData/batch
Update a Scope Assignment Planned Time Phased Data Object
Method: put
Path: /primeapi/restapi/plannedTimePhasedData
Update Scope Assignment Planned Time Phased Data
Method: put
Path: /primeapi/restapi/plannedTimePhasedData/batch
View Scope Assignment Planned Time Phased Data
Method: get
Path: /primeapi/restapi/plannedTimePhasedData/{id}
View Scope Assignment Planned Time Phased Data by Scope Assignment ID
Method: get
Path: /primeapi/restapi/plannedTimePhasedData/scopeAssignment/{id}
Scope Item
Use the Scope Item service to create, view, update, and delete scope items. Scope Items represent materials or products needed to complete a project.
Create a Scope Item
Method: post
Path: /primeapi/restapi/scopeItem
Delete a Scope Item
Method: delete
Path: /primeapi/restapi/scopeItem/{id}
Update a Scope Item
Method: put
Path: /primeapi/restapi/scopeItem
View a Scope Item
Method: get
Path: /primeapi/restapi/scopeItem/{id}
View a Scope Item by Code
Method: get
Path: /primeapi/restapi/scopeItem/code/{code}
View a Scope Item by Code
Method: get
Path: /primeapi/restapi/scopeItem/project/{id}/code/{code}
View a Scope Item by Name
Method: get
Path: /primeapi/restapi/scopeItem/project/{id}/name/{name}
View a Scope Item by PBS
Method: get
Path: /primeapi/restapi/scopeItem/pbsId/{id}
View Scope Item by Assigned Code Value
Method: get
Path: /primeapi/restapi/scopeItem/project/{id}/codeType/{typeId}/codeValue/{code}
View Scope Item Configured Fields
Method: get
Path: /primeapi/restapi/scopeItem/{id}/configuredFields
View Scope Items by Assigned Configured Field Value
Method: get
Path: /primeapi/restapi/scopeItem/project/{id}/configuredField/{viewColumnName}/{value}
View Scope Items by Project
Method: get
Path: /primeapi/restapi/scopeItem/project/{id}
Scope Item Aggregate
Use the Scope Item Aggregates service to view scope item aggregates.
View Scope Item Aggregates
Method: get
Path: /primeapi/restapi/scopeItemAggregate/{id}
View Scope Item Aggregates by Project
Method: get
Path: /primeapi/restapi/scopeItemAggregate/project/{projectId}
Scope Item Assignment
Use the Scope Item Assignment service to create, view, update, and delete scope assignments.
Create a Scope Item Assignment
Method: post
Path: /primeapi/restapi/scopeItemAssignment
Delete a Scope Item Assignment
Method: delete
Path: /primeapi/restapi/scopeItemAssignment/{id}
Update a Scope Item Assignment
Method: put
Path: /primeapi/restapi/scopeItemAssignment
View a Scope Item Assignment
Method: get
Path: /primeapi/restapi/scopeItemAssignment/{id}
View a Scope Item Assignment by Code
Method: get
Path: /primeapi/restapi/scopeItemAssignment/code/{code}
View a Scope Item Assignments by Project
Method: get
Path: /primeapi/restapi/scopeItemAssignment/project/{id}
View a Scope Item Assignments by Scope Item
Method: get
Path: /primeapi/restapi/scopeItemAssignment/scope/{id}
View a Scope Item Assignments by Work Package
Method: get
Path: /primeapi/restapi/scopeItemAssignment/workPackage/{id}
View Scope Item Assignment Configured Fields
Method: get
Path: /primeapi/restapi/scopeItemAssignment/{id}/configuredFields
View Scope Item Assignments by Assigned Code Value
Method: get
Path: /primeapi/restapi/scopeItemAssignment/project/{id}/codeType/{typeId}/codeValue/{code}
View Scope Item Assignments by Assigned Configured Field Value
Method: get
Path: /primeapi/restapi/scopeItemAssignment/project/{id}/configuredField/{viewColumnName}/{value}
Scope Item Assignment Activity
Use the Scope Item Assignment Activity service to create, view, update, and delete scope assignments and activity relationships. Update Keys : 'scopeItemAssignmentActivityId'
Batch Create a Scope Item Assignment Activity
Method: post
Path: /primeapi/restapi/scopeItemAssignmentActivity/batch
Batch Delete Scope Item Assignment Activities
Method: delete
Path: /primeapi/restapi/scopeItemAssignmentActivity/batch
Batch Update Scope Item Assignment Activities
Method: put
Path: /primeapi/restapi/scopeItemAssignmentActivity/batch
Create a Scope Item Assignment Activity
Method: post
Path: /primeapi/restapi/scopeItemAssignmentActivity
Delete a Scope Item Assignment Activity
Method: delete
Path: /primeapi/restapi/scopeItemAssignmentActivity/{id}
Delete Scope Item Assignment Activities by Activity
Method: delete
Path: /primeapi/restapi/scopeItemAssignmentActivity/activity/{id}
Delete Scope Item Assignment Activities by Scope Item Assignment
Method: delete
Path: /primeapi/restapi/scopeItemAssignmentActivity/scopeItemAssignment/{id}
Update a Scope Item Assignment Activity
Method: put
Path: /primeapi/restapi/scopeItemAssignmentActivity
View a Scope Item Assignment Activity
Method: get
Path: /primeapi/restapi/scopeItemAssignmentActivity/{id}
View all Scope Item Assignment Activities by Activity
Method: get
Path: /primeapi/restapi/scopeItemAssignmentActivity/activity/{id}
View all Scope Item Assignment Activities by Scope Item Assignment
Method: get
Path: /primeapi/restapi/scopeItemAssignmentActivity/scopeItemAssignment/{id}
Scope Item Assignment Aggregate
Use the scope item assignment aggregate service to view scope item assignment aggregates.
View Scope Item Assignment Aggregates
Method: get
Path: /primeapi/restapi/scopeItemAssignmentAggregate/{id}
View Scope Item Assignment Aggregates by Reference
Method: get
Path: /primeapi/restapi/scopeItemAssignmentAggregate/reference/{id}?rollupType={rollupType}
Scope Item Assignment Change Request
Use the Scope Item Assignment Change Requests service to create, view, update, and delete scope item assignment change requests.
Batch Create Scope Item Assignment Change Requests
Method: post
Path: /primeapi/restapi/scopeItemAssignmentChangeRequest/batch
Batch Update Scope Item Assignment Change Requests
Method: put
Path: /primeapi/restapi/scopeItemAssignmentChangeRequest/batch
Create a Scope Item Assignment Change Request
Method: post
Path: /primeapi/restapi/scopeItemAssignmentChangeRequest
Update a Scope Item Assignment Change Request
Method: put
Path: /primeapi/restapi/scopeItemAssignmentChangeRequest
View a Scope Item Assignment Change Request
Method: get
Path: /primeapi/restapi/scopeItemAssignmentChangeRequest/{id}
View a Scope Item Assignment Change Request by Scope Item Assignment
Method: get
Path: /primeapi/restapi/scopeItemAssignmentChangeRequest/scopeItemAssignment/{scopeItemAssignmentId}
Scope Item Assignment Transfer Request
Use the Scope Item Assignment Transfer Requests service to create, view, update, and delete scope item assignment transfer requests.
Create a Scope Item Assignment Transfer Request
Method: post
Path: /primeapi/restapi/scopeItemAssignmentTransferRequest
Create Scope Item Assignment Transfer Requests
Method: post
Path: /primeapi/restapi/scopeItemAssignmentTransferRequest/batch
Update a Scope Item Assignment Transfer Request
Method: put
Path: /primeapi/restapi/scopeItemAssignmentTransferRequest
Update Scope Item Assignment Transfer Requests
Method: put
Path: /primeapi/restapi/scopeItemAssignmentTransferRequest/batch
View a Scope Item Assignment Transfer Request
Method: get
Path: /primeapi/restapi/scopeItemAssignmentTransferRequest/{id}
View a Scope Item Assignment Transfer Request by Scope Item Assignment ID
Method: get
Path: /primeapi/restapi/scopeItemAssignmentTransferRequest/scopeItemAssignment/{scopeItemAssignmentId}
Scope Item Change Request
Use the Scope Item Change Request service to create, view, update, and delete scope item change requests.
Batch Update Scope Item Change Requests
Method: put
Path: /primeapi/restapi/scopeItemChangeRequest/batch
Create a Scope Item Change Request
Method: post
Path: /primeapi/restapi/scopeItemChangeRequest
Update a Scope Item Change Request
Method: put
Path: /primeapi/restapi/scopeItemChangeRequest
View a Scope Item Change Request
Method: get
Path: /primeapi/restapi/scopeItemChangeRequest/scopeItem/{scopeItemId}
View a Scope Item Change Request
Method: get
Path: /primeapi/restapi/scopeItemChangeRequest/{id}
Segment
Use the Cost Breakdown Structure segment service to create, view, update, and delete CBS segments for workspaces and projects. Segments determine the hierarchical depth of a CBS and designate how CBS codes are concatenated. Update Keys : 'segmentId'
Create a Project Segment
Method: post
Path: /primeapi/restapi/segment/project/{id}
Create a Workspace Segment
Method: post
Path: /primeapi/restapi/segment/workspace/{id}
Update a Project Segment
Method: put
Path: /primeapi/restapi/segment/project
Update a Workspace Segment
Method: put
Path: /primeapi/restapi/segment/workspace
View a Workspace Segment
Method: get
Path: /primeapi/restapi/segment/{id}?type={type}
View workspace segments by workspace or project
Method: get
Path: /primeapi/restapi/segment/project/{id}
View workspace segments by workspace or project
Method: get
Path: /primeapi/restapi/segment/workspace/{id}
SpecSection
The SpecSection Company service enables you to send and retrieve information related to SpecSections.
Batch Create Spec Sections
Method: post
Path: /primeapi/restapi/specSection/batch
Batch Delete Spec Sections
Method: delete
Path: /primeapi/restapi/specSection/batch
Batch Update Spec Sections
Method: put
Path: /primeapi/restapi/specSection/batch
Create a Spec Section
Method: post
Path: /primeapi/restapi/specSection
Delete a Spec Section
Method: delete
Path: /primeapi/restapi/specSection/{id}
Update a Spec Section.
Method: put
Path: /primeapi/restapi/specSection
View a Spec Section
Method: get
Path: /primeapi/restapi/specSection/{id}
View a Spec Section by Code
Method: get
Path: /primeapi/restapi/specSection/code/{code}
View a Spec Section by Project Code and Workspace Code
Method: get
Path: /primeapi/restapi/specSection/workspace/{worksaceCode}/project/{projectCode}
Strategy
Use the Strategy service you to create, view, update, and delete strategies.
Batch Create Strategies
Method: post
Path: /primeapi/restapi/strategy/batch
Batch Deletes Strategies
Method: delete
Path: /primeapi/restapi/strategy/batch
Batch Update Strategies
Method: put
Path: /primeapi/restapi/strategy/batch
Create a Strategy
Method: post
Path: /primeapi/restapi/strategy
Create a Strategy Configured Field
Method: post
Path: /primeapi/restapi/strategy/configuredField
Delete a Strategy
Method: delete
Path: /primeapi/restapi/strategy/{id}
Update a Strategy
Method: put
Path: /primeapi/restapi/strategy
View a Configured Field
Method: get
Path: /primeapi/restapi/strategy/configuredField/{columnId}
View a Strategy
Method: get
Path: /primeapi/restapi/strategy/{id}
View Strategies Measure Values by Workspace
Method: get
Path: /primeapi/restapi/strategy/measureValue/workspace/{workspaceId}
View Strategy Configured Fields by Workspace
Method: get
Path: /primeapi/restapi/strategy/configuredField/workspace/{id}
View Strategy Measure Values by Strategy
Method: get
Path: /primeapi/restapi/strategy/measureValue/strategy/{strategyId}
Strategy Measure
Use the Strategy Measure service to create, view, update, and delete Strategy Measures.
Batch Create Strategy Measures
Method: post
Path: /primeapi/restapi/strategyMeasure/batch
Batch Delete Strategy Measures
Method: delete
Path: /primeapi/restapi/strategyMeasure/batch
Create a Strategy Measure
Method: post
Path: /primeapi/restapi/strategyMeasure
Delete a Strategy Measure
Method: delete
Path: /primeapi/restapi/strategyMeasure/{id}
View a Strategy Measure
Method: get
Path: /primeapi/restapi/strategyMeasure/{id}
Strategy Measure Manual Value
Use the Strategy Measure Manual Value service to create, view, update, and delete Strategy Measure Manual Values.
Batch Create Strategy Measure Manual Values
Method: post
Path: /primeapi/restapi/strategyMeasureManualValue/batch
Batch Update Strategy Measure Manual Values
Method: put
Path: /primeapi/restapi/strategyMeasureManualValue/batch
Create a Strategy Measure Manual Value
Method: post
Path: /primeapi/restapi/strategyMeasureManualValue
Updates a Strategy Measure Manual Value
Method: put
Path: /primeapi/restapi/strategyMeasureManualValue
View a Strategy Measure Manual Value
Method: get
Path: /primeapi/restapi/strategyMeasureManualValue/{id}
View Strategy Measure Manual Value Date Sequences
Method: get
Path: /primeapi/restapi/strategyMeasureManualValue/dateSequenceRange/measure/{measureId}
Strategy Measure Value
Use the Strategy Measure Value service to view strategy measure values.
View a Strategy Measure Value Trend
Method: get
Path: /primeapi/restapi/strategyMeasureValue/strategyMeasureSpread/measure/{measureId}/strategy/{strategyId}
Strategy Project
Use the Strategy Project service to create, view, update, and delete strategy projects.
Batch Create Strategy Projects
Method: post
Path: /primeapi/restapi/strategyProject/batch
Batch Delete Strategy Projects
Method: delete
Path: /primeapi/restapi/strategyProject/batch
Batch Update Strategy Projects
Method: put
Path: /primeapi/restapi/strategyProject/batch
Create a Strategy Project
Method: post
Path: /primeapi/restapi/strategyProject
Delete a Strategy Project
Method: delete
Path: /primeapi/restapi/strategyProject/{id}
Delete a Strategy Project by Strategy and Project
Method: delete
Path: /primeapi/restapi/strategyProject/strategy/{strategyId}/project/{projectId}
Update a Strategy Project
Method: put
Path: /primeapi/restapi/strategyProject
View a Strategy Project
Method: get
Path: /primeapi/restapi/strategyProject/{id}
View Strategy Projects by Strategy
Method: get
Path: /primeapi/restapi/strategyProject/strategy/{strategyId}
Strategy Type
Use the Strategy Type service to create, view, up send and retrieve information related to strategy types.
Assign or Promote a Strategy Type
Method: post
Path: /primeapi/restapi/strategyType/replicateObjectInWorkspaces/strategyType/{strategyTypeId}/workspace/{workspaceId}
Batch Create Strategy Types
Method: post
Path: /primeapi/restapi/strategyType/batch
Batch Delete Strategy Types
Method: delete
Path: /primeapi/restapi/strategyType/batch
Batch Update Strategy Types
Method: put
Path: /primeapi/restapi/strategyType/batch
Create a Strategy Type
Method: post
Path: /primeapi/restapi/strategyType
Delete a Strategy Type
Method: delete
Path: /primeapi/restapi/strategyType/{id}
Update a Strategy Type
Method: put
Path: /primeapi/restapi/strategyType
View a Strategy Type
Method: get
Path: /primeapi/restapi/strategyType/{id}
View Strategy Types by Workspace
Method: get
Path: /primeapi/restapi/strategyType/workspace/{workspaceId}
Submittal
The Submittal Company service enables you to send and retrieve information related to Submittals. Update Keys : 'projectId, itemCode' or 'submittalId' or 'workspaceCode, projectCode, itemCode'
Batch Create Submittals
Method: post
Path: /primeapi/restapi/submittal/batch
Batch Delete Submittals
Method: delete
Path: /primeapi/restapi/submittal/batch
Batch Update Submittals
Method: put
Path: /primeapi/restapi/submittal/batch
Create a Submittal
Method: post
Path: /primeapi/restapi/submittal
Delete a Submittal
Method: delete
Path: /primeapi/restapi/submittal/{id}
Update a Submittal
Method: put
Path: /primeapi/restapi/submittal
View a Submittal
Method: get
Path: /primeapi/restapi/submittal/{id}
View a Submittal by Code
Method: get
Path: /primeapi/restapi/submittal/code/{code}
View a Submittal by Project Code and Workspace Code
Method: get
Path: /primeapi/restapi/submittal/workspace/{worksaceCode}/project/{projectCode}
View Submittal History by Code
Method: get
Path: /primeapi/restapi/submittal/history/submittalCode/{code}
Threshold
The Threshold service enables you to create, view, update, and delete thresholds. Thresholds are visual indicators used to convey the current status of a value compared to upper and lower limits.
Batch Create Thresholds
Method: post
Path: /primeapi/restapi/threshold/batch
Batch Update Thresholds
Method: put
Path: /primeapi/restapi/threshold/batch
Create a Threshold
Method: post
Path: /primeapi/restapi/threshold
Update a Threshold
Method: put
Path: /primeapi/restapi/threshold
View a Threshold
Method: get
Path: /primeapi/restapi/threshold/{id}
Units Of Measure
Use the Units of Measure service to create, view, update, and delete units of measure.
Assign or Promote a Unit of Measure
Method: post
Path: /primeapi/restapi/unitsOfMeasure/replicateObjectInWorkspaces/unitsOfMeasure/{unitsOfMeasureId}/workspace/{workspaceId}
Batch Create Units of Measures
Method: post
Path: /primeapi/restapi/unitsOfMeasure/batch
Batch Delete Units of Measures
Method: delete
Path: /primeapi/restapi/unitsOfMeasure/batch
Batch Update Units of Measures
Method: put
Path: /primeapi/restapi/unitsOfMeasure/batch
Create a Unit of Measure
Method: post
Path: /primeapi/restapi/unitsOfMeasure
Delete a Unit of Measure
Method: delete
Path: /primeapi/restapi/unitsOfMeasure/{id}
Update a Unit of Measure
Method: put
Path: /primeapi/restapi/unitsOfMeasure
View a Unit of Measure
Method: get
Path: /primeapi/restapi/unitsOfMeasure/{id}
View a Unit of Measure by Code
Method: get
Path: /primeapi/restapi/unitsOfMeasure/code/{code}
View a Unit of Measure by Name
Method: get
Path: /primeapi/restapi/unitsOfMeasure/name/{name}/workspace/{id}
View a Unit of Measure by Workspace
Method: get
Path: /primeapi/restapi/unitsOfMeasure/workspace/{id}
User Preferences
Use the User Preferences service to view and update user preferences. User preferences determine data display formats and personal details, and are exclusive to each user.
Batch Update User Preferences
Method: put
Path: /primeapi/restapi/userPreferences/batch
Update a User's Preferences
Method: put
Path: /primeapi/restapi/userPreferences
View All User Preferences
Method: get
Path: /primeapi/restapi/userPreferences/allUserSettings
View User Preferences
Method: get
Path: /primeapi/restapi/userPreferences/{id}
View User Preferences by Setting Name
Method: get
Path: /primeapi/restapi/userPreferences/name/{name}
WBS
Use the WBS service to create, view, update, and delete workspace breakdown structures. Work Breakdown Structures (WBS) represent hierarchical arrangements of the work required to bring a project to completion.
Create a WBS
Method: post
Path: /primeapi/restapi/wbs
Delete a WBS
Method: delete
Path: /primeapi/restapi/wbs/{id}
Delete WBS Children
Method: delete
Path: /primeapi/restapi/wbs/children/{id}
Update a WBS
Method: put
Path: /primeapi/restapi/wbs
View a WBS
Method: get
Path: /primeapi/restapi/wbs/{id}
View a WBS by Code
Method: get
Path: /primeapi/restapi/wbs/project/{id}/code/{code}
View a WBS by Name
Method: get
Path: /primeapi/restapi/wbs/project/{id}/name/{name}
View a WBS by Project
Method: get
Path: /primeapi/restapi/wbs/project/{id}
View a WBS by WBS Code, Parent WBS Code, and Project ID
Method: get
Path: /primeapi/restapi/wbs/wbsCode/{code}/parentWbsCode/{parentCode}/projectId/{projectId}
View All Children in a WBS Hierarchy
Method: get
Path: /primeapi/restapi/wbs/{id}/childrenHierarchy
View WBS by Assigned Code Value
Method: get
Path: /primeapi/restapi/wbs/project/{id}/codeType/{typeId}/codeValue/{code}
View WBS by Assigned Configured Field Value
Method: get
Path: /primeapi/restapi/wbs/project/{id}/configuredField/{viewColumnName}/{value}
View WBS Children
Method: get
Path: /primeapi/restapi/wbs/children/{id}
View WBS Configured Fields
Method: get
Path: /primeapi/restapi/wbs/{id}/configuredFields
Work Package
The Work Package service enables you to send requests related to the defined work package.
Create a Work Package
Method: post
Path: /primeapi/restapi/workPackage
Delete a Work Package
Method: delete
Path: /primeapi/restapi/workPackage/{id}
Update a Work Package
Method: put
Path: /primeapi/restapi/workPackage
View a Work Package
Method: get
Path: /primeapi/restapi/workPackage/{id}
View a Work Package by Assigned Code Value
Method: get
Path: /primeapi/restapi/workPackage/project/{id}/codeType/{typeId}/codeValue/{code}
View a Work Package by Project and Code
Method: get
Path: /primeapi/restapi/workPackage/project/{id}/code/{code}
View a Work Package by Project and Name
Method: get
Path: /primeapi/restapi/workPackage/project/{id}/name/{name}
View a Work Package by WBS
Method: get
Path: /primeapi/restapi/workPackage/wbs/{id}
View Work Package Configured Fields
Method: get
Path: /primeapi/restapi/workPackage/{id}/configuredFields
View Work Packages by Assigned Configured Field Value
Method: get
Path: /primeapi/restapi/workPackage/project/{id}/configuredField/{viewColumnName}/{value}
View Work Packages by Project
Method: get
Path: /primeapi/restapi/workPackage/project/{id}
WorkManagerTask
Use the work manager task service to create, view, update, and delete work manager tasks.
Batch Create Work Manager Tasks
Method: post
Path: /primeapi/restapi/workManagerTask/batch
Batch Delete Work Manager Tasks
Method: delete
Path: /primeapi/restapi/workManagerTask/batch
Batch Update Work Manager Tasks
Method: put
Path: /primeapi/restapi/workManagerTask/batch
Create a Work Manager Task
Method: post
Path: /primeapi/restapi/workManagerTask
Delete a Work Manager Task
Method: delete
Path: /primeapi/restapi/workManagerTask/{id}
Update a Work Manager Task
Method: put
Path: /primeapi/restapi/workManagerTask
View a Work Manager Task
Method: get
Path: /primeapi/restapi/workManagerTask/{id}
View a Work Manager Task by Activity
Method: get
Path: /primeapi/restapi/workManagerTask/project/{projectId}/activity/{activityId}
View a Work Manager Task by Code
Method: get
Path: /primeapi/restapi/workManagerTask/code/{code}
View a Work Manager Task by Project
Method: get
Path: /primeapi/restapi/workManagerTask/project/{id}
View Work Manager Tasks by Configured Field Values
Method: get
Path: /primeapi/restapi/workManagerTask/project/{id}/configuredField/{viewColumnName}/{value}
View Work Manger Task Activities by Assigned Code Value.
Method: get
Path: /primeapi/restapi/workManagerTask/project/{id}/codeType/{typeId}/codeValue/{code}
WorkManagerTaskCommitment
Use the Work Manager Task Commitment service to create, view, update, and delete work manager tasks.
Create a Work Manager Task Commitment
Method: post
Path: /primeapi/restapi/workManagerTaskCommitment
Update a Work Manager Task Commitment
Method: put
Path: /primeapi/restapi/workManagerTaskCommitment
View a Work Manager Task Commitment
Method: get
Path: /primeapi/restapi/workManagerTaskCommitment/{id}
View a Work Manager Task Commitment by Associated User
Method: get
Path: /primeapi/restapi/workManagerTaskCommitment/user/{id}
View a Work Manager Task Commitment by Reason
Method: get
Path: /primeapi/restapi/workManagerTaskCommitment/reason/{id}
View Last Work Manager Task Commitment
Method: get
Path: /primeapi/restapi/workManagerTaskCommitment/lastCommitment/task/{id}
View Work Manager Task Commitment by Task
Method: get
Path: /primeapi/restapi/workManagerTaskCommitment/allCommitment/task/{id}
WorkManagerTaskDependency
Use the Work Manager Task Dependency service to create, view, update, and delete work manager task dependencies.
Returns the Work Manager Task Dependencies for the specified Project ID
Method: get
Path: /primeapi/restapi/workManagerTaskDependency/project/{projectId}
Returns the Work Manager Task Dependencies for the specified Task ID
Method: get
Path: /primeapi/restapi/workManagerTaskDependency/task/{tasksId}
Returns the Work Manager Task Dependencies for the specified Workspace and Project Codes.
Method: get
Path: /primeapi/restapi/workManagerTaskDependency/workspace/{workspaceCode}/project/{projectCode}
Returns the Work Manager Task Dependencies for the specified Workspace,Project and Task Codes
Method: get
Path: /primeapi/restapi/workManagerTaskDependency/workspace/{workspaceCode}/project/{projectCode}/task/{tasksCode}
Returns the Work Manager Task Dependency for the specified Work Manager Task Dependency ID
Method: get
Path: /primeapi/restapi/workManagerTaskDependency/{id}
WorkPackage Aggregate
View a Work Package Aggregate by Reference
Method: get
Path: /primeapi/restapi/workPackageAggregate/reference/{id}?rollupType={rollupType}
View a Work Package Aggregate by Rollup
Method: get
Path: /primeapi/restapi/workPackageAggregate/{id}
WorkPackage Change Request
Use the Work Package Change Request service to create, view, update, and delete work package change requests.
Batch Create Work Package Change Requests
Method: post
Path: /primeapi/restapi/workPackageChangeRequest/batch
Batch Delete Work Package Change Requests
Method: delete
Path: /primeapi/restapi/workPackageChangeRequest/batch
Batch Update Work Package Change Requests
Method: put
Path: /primeapi/restapi/workPackageChangeRequest/batch
Create a Work Package Change Request
Method: post
Path: /primeapi/restapi/workPackageChangeRequest
Delete a Work Package Change Request
Method: delete
Path: /primeapi/restapi/workPackageChangeRequest/{id}
Update a Work Package Change Request
Method: put
Path: /primeapi/restapi/workPackageChangeRequest
View a Work Package Change Request
Method: get
Path: /primeapi/restapi/workPackageChangeRequest/{id}
Workspace
Use the Workspace service to create, update, delete, and view workspaces.
Batch Create Workspaces
Method: post
Path: /primeapi/restapi/workspace/batch
Batch Delete Workspaces
Method: delete
Path: /primeapi/restapi/workspace/batch
Batch Update Workspaces
Method: put
Path: /primeapi/restapi/workspace/batch
Create a Workspace
Method: post
Path: /primeapi/restapi/workspace
Delete a Workspace
Method: delete
Path: /primeapi/restapi/workspace/{id}
Update a Workspace
Method: put
Path: /primeapi/restapi/workspace
View a Workspace
Method: get
Path: /primeapi/restapi/workspace/{id}
View a Workspace by Code
Method: get
Path: /primeapi/restapi/workspace/code/{code}
View a Workspace Image
Method: get
Path: /primeapi/restapi/workspace/image/{id}
View All Child Workspaces in a Workspace Hierarchy
Method: get
Path: /primeapi/restapi/workspace/{id}/childrenHierarchy
View all Workspaces
Method: get
Path: /primeapi/restapi/workspace
View Child Workspaces
Method: get
Path: /primeapi/restapi/workspace/children/{id}
View the Root Workspace
Method: get
Path: /primeapi/restapi/workspace/root
Workspace Resource Rate
Use the Workspace Resource Rate service to create, view, update, and delete Workspace Resource Rates for the resources or roles.
Batch Create Workspace Resource Rates
Method: post
Path: /primeapi/restapi/workspaceResourceRate/batch
Batch Delete Workspace Resource Rates
Method: delete
Path: /primeapi/restapi/workspaceResourceRate/batch
Batch Update Workspace Resource Rates
Method: put
Path: /primeapi/restapi/workspaceResourceRate/batch
Create a Workspace Resource Rate
Method: post
Path: /primeapi/restapi/workspaceResourceRate
Delete a Workspace Resource Rate
Method: delete
Path: /primeapi/restapi/workspaceResourceRate/{id}
Update a Workspace Resource Rate
Method: put
Path: /primeapi/restapi/workspaceResourceRate
View a Workspace Resource Rate
Method: get
Path: /primeapi/restapi/workspaceResourceRate/{id}
View a Workspace Resource Rate by Resource
Method: get
Path: /primeapi/restapi/workspaceResourceRate/resource/{id}