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: postPath:
/primeapi/restapi/action/applyActivityUncertainity/run
- Close a Project Current Period Item
- Method: postPath:
/primeapi/restapi/action/periodCloseout
- Create a Budget Plan Snapshot
- Method: postPath:
/primeapi/restapi/action/capitalPlanSnapshot
- Create a Project Baseline
- Method: postPath:
/primeapi/restapi/action/createBaseline
- Create a Project Snapshot
- Method: postPath:
/primeapi/restapi/action/projectSnapshot
- Delete a Budget Plan Snapshot
- Method: deletePath:
/primeapi/restapi/action/capitalPlan/snapshot/{id}
- Delete a Project Snapshot
- Method: deletePath:
/primeapi/restapi/action/project/snapshot/{id}
- Download a Report
- Method: getPath:
/primeapi/restapi/action/reportResult/{jobId}
- Perform Project Resource Leveling
- Method: postPath:
/primeapi/restapi/action/level
- Run a Report
- Method: postPath:
/primeapi/restapi/action/report/run
- Schedule a Project
- Method: postPath:
/primeapi/restapi/action/scheduleProject
- Schedule Measure Computation
- Method: postPath:
/primeapi/restapi/action/computeMeasure
- Schedule Measure Computation
- Method: postPath:
/primeapi/restapi/action/computeStrategyMeasure
- Schedule Risk Analysis
- Method: postPath:
/primeapi/restapi/action/runRiskAnalysis
- Set a Current Baseline
- Method: putPath:
/primeapi/restapi/action/setCurrentBaseline
- View Job Status
- Method: getPath:
/primeapi/restapi/action/jobStatus/{jobId}
- View Job Status and Job Log
- Method: getPath:
/primeapi/restapi/action/jobStatusWithLog/{jobId}
- View Project Baseline Status
- Method: getPath:
/primeapi/restapi/action/baselineStatus/{id}
- View Snapshots by Budget Plan ID
- Method: getPath:
/primeapi/restapi/action/snapshot/capitalPlan/{id}
- View Snapshots by Project ID
- Method: getPath:
/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: postPath:
/primeapi/restapi/activity/batch
- Batch Delete Activities
- Method: deletePath:
/primeapi/restapi/activity/batch
- Batch Update Activities
- Method: putPath:
/primeapi/restapi/activity/batch
- Create an Activity
- Method: postPath:
/primeapi/restapi/activity
- Delete an Activity
- Method: deletePath:
/primeapi/restapi/activity/{id}
- Update an Activity
- Method: putPath:
/primeapi/restapi/activity
- View Activities by Configured Field
- Method: getPath:
/primeapi/restapi/activity/project/{id}/configuredField/{viewColumnName}/{value}
- View Activities by Project
- Method: getPath:
/primeapi/restapi/activity/project/{id}
- View Activities by Project, Code Type, and Code Value
- Method: getPath:
/primeapi/restapi/activity/project/{id}/codeType/{typeId}/codeValue/{code}
- View Activities by WBS
- Method: getPath:
/primeapi/restapi/activity/wbsId/{id}
- View Activity Configured Fields
- Method: getPath:
/primeapi/restapi/activity/{id}/configuredFields
- View all activities by parent code.
- Method: getPath:
/primeapi/restapi/activity/byParent?workspaceCode={workspaceCode}&projectCode={projectCode}
- View all Child Activities of an Activity
- Method: getPath:
/primeapi/restapi/activity/{id}/childrenHierarchy
- View an Activity
- Method: getPath:
/primeapi/restapi/activity/{id}
- View an activity by code
- Method: getPath:
/primeapi/restapi/activity/byItemCode?workspaceCode={workspaceCode}&projectCode={projectCode}&activityCode={activityCode}
- View an Activity by Code
- Method: getPath:
/primeapi/restapi/activity/code/{code}
- View an Activity by Project and Activity Code
- Method: getPath:
/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: getPath:
/primeapi/restapi/activityAggregate/wbs/projects?id={id}
- View a Work Package Activity Aggregate by Portfolio
- Method: getPath:
/primeapi/restapi/activityAggregate/workPackage/portfolio?id={id}
- View a Work Package Activity Aggregate by Projects
- Method: getPath:
/primeapi/restapi/activityAggregate/workPackage/project?id={id}
- View an Activity Aggregate
- Method: getPath:
/primeapi/restapi/activityAggregate/{id}
- View an Activity Aggregate by Project
- Method: getPath:
/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: postPath:
/primeapi/restapi/activityFavorite/batch
- Batch Delete Activity Favorites
- Method: deletePath:
/primeapi/restapi/activityFavorite/batch
- Create an Activity Favorite
- Method: postPath:
/primeapi/restapi/activityFavorite
- Delete an Activity Favorite
- Method: deletePath:
/primeapi/restapi/activityFavorite/{id}
- View Activity Favorites by User
- Method: getPath:
/primeapi/restapi/activityFavorite/userId/{userId}
- View Activity Favorites by User and Activity
- Method: getPath:
/primeapi/restapi/activityFavorite/userId/{userId}/activityId/{activityId}
- View an Activity Favorite
- Method: getPath:
/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: postPath:
/primeapi/restapi/activityRisk/batch
- Batch Delete Activity Risks
- Method: deletePath:
/primeapi/restapi/activityRisk/batch
- Batch Update Activity Risks
- Method: putPath:
/primeapi/restapi/activityRisk/batch
- Create an Activity Risk
- Method: postPath:
/primeapi/restapi/activityRisk
- Delete an Activity Risk
- Method: deletePath:
/primeapi/restapi/activityRisk/{id}
- Update an Activity Risk
- Method: putPath:
/primeapi/restapi/activityRisk
- View an Activity Risk
- Method: getPath:
/primeapi/restapi/activityRisk/{id}
- View an Activity Risk by Activity
- Method: getPath:
/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: postPath:
/primeapi/restapi/applicationUserGroup/batch
- Batch Update User Groups
- Method: putPath:
/primeapi/restapi/applicationUserGroup/batch
- Create a User Group
- Method: postPath:
/primeapi/restapi/applicationUserGroup
- Update a User Group
- Method: putPath:
/primeapi/restapi/applicationUserGroup
- View a User Group
- Method: getPath:
/primeapi/restapi/applicationUserGroup/{id}
- View a User Group by Name
- Method: getPath:
/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: postPath:
/primeapi/restapi/assignment/batch
- Batch Create Assignments
- Method: postPath:
/primeapi/restapi/assignment/gateway/batch
- Batch Delete Assignments
- Method: deletePath:
/primeapi/restapi/assignment/batch
- Batch Update Assignments
- Method: putPath:
/primeapi/restapi/assignment/batch
- Batch Update Assignments
- Method: putPath:
/primeapi/restapi/assignment/gateway/batch
- Create an Assignment
- Method: postPath:
/primeapi/restapi/assignment
- Delete an Assignment
- Method: deletePath:
/primeapi/restapi/assignment/{id}
- Update an Assignment
- Method: putPath:
/primeapi/restapi/assignment
- View an Assignment
- Method: getPath:
/primeapi/restapi/assignment/{id}
- View an Assignment by Resource
- Method: getPath:
/primeapi/restapi/assignment/resource/{id}
- View an Assignment by Resource Code
- Method: getPath:
/primeapi/restapi/assignment/resource/code/{code}
- View Assignment by Activity and Code
- Method: getPath:
/primeapi/restapi/assignment/activity/{id}/code/{code}
- View Assignment by Code
- Method: getPath:
/primeapi/restapi/assignment/code/{code}
- View Assignment Configured Fields
- Method: getPath:
/primeapi/restapi/assignment/{id}/configuredFields
- View Assignments by Activity
- Method: getPath:
/primeapi/restapi/assignment/activityId/{id}
- View Assignments by Configured Field Values
- Method: getPath:
/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: postPath:
/primeapi/restapi/assignmentFavorite/batch
- Batch Delete Assignment Favorites
- Method: deletePath:
/primeapi/restapi/assignmentFavorite/batch
- Create an Assignment Favorite
- Method: postPath:
/primeapi/restapi/assignmentFavorite
- Delete an Assignment Favorite
- Method: deletePath:
/primeapi/restapi/assignmentFavorite/{id}
- View all Assignment Favorites Assigned to a User
- Method: getPath:
/primeapi/restapi/assignmentFavorite/userId/{userId}
- View an Assignment Favorite
- Method: getPath:
/primeapi/restapi/assignmentFavorite/{id}
- View an Assignment Favorite by User and Assignment
- Method: getPath:
/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: postPath:
/primeapi/restapi/budgetChange/batch
- Batch Delete Budget Changes
- Method: deletePath:
/primeapi/restapi/budgetChange/batch
- Batch Delete Budget Transactions
- Method: deletePath:
/primeapi/restapi/budgetChange/transactions/batch
- Batch Update Budget Changes
- Method: putPath:
/primeapi/restapi/budgetChange/batch
- Change Budget Change Status
- Method: putPath:
/primeapi/restapi/budgetChange/{id}/changeBudgetChangeStatus
- Create a Budget Change
- Method: postPath:
/primeapi/restapi/budgetChange
- Delete a Budget Change
- Method: deletePath:
/primeapi/restapi/budgetChange/{id}
- Delete a Budget Transaction
- Method: deletePath:
/primeapi/restapi/budgetChange/transaction/{id}
- Update a Budget Change
- Method: putPath:
/primeapi/restapi/budgetChange
- View a Budget Change
- Method: getPath:
/primeapi/restapi/budgetChange/{id}
- View a Budget Change by Asssigned Configured Fields
- Method: getPath:
/primeapi/restapi/budgetChange/project/{id}/configuredField/{viewColumnName}/{value}
- View a Budget Change by Asssigned Configured Fields
- Method: getPath:
/primeapi/restapi/budgetChange/projectBudget/{id}/configuredField/{viewColumnName}/{value}
- View a budget change by code
- Method: getPath:
/primeapi/restapi/budgetChange/byItemCode?workspaceCode={workspaceCode}&projectCode={projectCode}&budgetChangeCode={budgetChangeCode}
- View a Budget Change by Code and Project
- Method: getPath:
/primeapi/restapi/budgetChange/project/{id}/code/{code}
- View a Budget Change by Code and Project Budget
- Method: getPath:
/primeapi/restapi/budgetChange/projectBudget/{id}/code/{code}
- View all budget changes by parent code
- Method: getPath:
/primeapi/restapi/budgetChange/byParent?workspaceCode={workspaceCode}&projectCode={projectCode}
- View Budget Change Configured Fields
- Method: getPath:
/primeapi/restapi/budgetChange/{id}/configuredFields
- View Budget Changes by Project
- Method: getPath:
/primeapi/restapi/budgetChange/project/{id}
- View Budget Changes by Project Budget
- Method: getPath:
/primeapi/restapi/budgetChange/projectBudget/{id}
- View Budget Transactions by Budget Change
- Method: getPath:
/primeapi/restapi/budgetChange/{id}/transactions
- View Status Transition History Record by Budget Change
- Method: getPath:
/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: getPath:
/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: postPath:
/primeapi/restapi/budgetItem/batch
- Batch Delete Budget Items
- Method: deletePath:
/primeapi/restapi/budgetItem/batch
- Batch Integrate Budget Items with an External Data Source
- Method: postPath:
/primeapi/restapi/budgetItem/syncBatch
- Batch Update Budget Items
- Method: putPath:
/primeapi/restapi/budgetItem/batch
- Create a Budget Item
- Method: postPath:
/primeapi/restapi/budgetItem
- Delete a Budget Item
- Method: deletePath:
/primeapi/restapi/budgetItem/{id}
- Integrate a Budget Item with an External Data Source
- Method: postPath:
/primeapi/restapi/budgetItem/sync
- Update a Budget Item
- Method: putPath:
/primeapi/restapi/budgetItem
- View a Budget Item by Assigned Configured Field
- Method: getPath:
/primeapi/restapi/budgetItem/project/{id}/configuredField/{viewColumnName}/{value}
- View a Budget Item by Assigned Configured Field
- Method: getPath:
/primeapi/restapi/budgetItem/projectBudget/{id}/configuredField/{viewColumnName}/{value}
- View a budget item by code
- Method: getPath:
/primeapi/restapi/budgetItem/byItemCode?workspaceCode={workspaceCode}&projectCode={projectCode}&budgetItemCode={budgetItemCode}
- View a Budget Item by Name
- Method: getPath:
/primeapi/restapi/budgetItem/name/{name}
- View all budget items by parent code
- Method: getPath:
/primeapi/restapi/budgetItem/byParent?workspaceCode={workspaceCode}&projectCode={projectCode}
- View Budget Item by Code and Project
- Method: getPath:
/primeapi/restapi/budgetItem/project/{id}/code/{code}
- View Budget Item by Code and Project Budget
- Method: getPath:
/primeapi/restapi/budgetItem/projectBudget/{id}/code/{code}
- View Budget Item Configured Fields
- Method: getPath:
/primeapi/restapi/budgetItem/{id}/configuredFields
- View Budget Items by Project
- Method: getPath:
/primeapi/restapi/budgetItem/project/{id}
- View Budget Items by Project Budget
- Method: getPath:
/primeapi/restapi/budgetItem/projectBudget/{id}
- View Budget Transaction by Assigned Configured Field
- Method: getPath:
/primeapi/restapi/budgetItem/{id}/transactions/configuredField/{viewColumnName}/{value}
- View Budget Transactions by Budget Item
- Method: getPath:
/primeapi/restapi/budgetItem/{id}/transactions
- View Integrated Budget Items
- Method: getPath:
/primeapi/restapi/budgetItem/externallySourced
- View the Configured Fields by Budget Transaction
- Method: getPath:
/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: postPath:
/primeapi/restapi/budgetTransfer/batch
- Batch Delete Budget Transactions
- Method: deletePath:
/primeapi/restapi/budgetTransfer/transactions/batch
- Batch Delete Budget Transfers
- Method: deletePath:
/primeapi/restapi/budgetTransfer/batch
- Batch Update Budget Transfers
- Method: putPath:
/primeapi/restapi/budgetTransfer/batch
- Change a Budget Transfer Status
- Method: putPath:
/primeapi/restapi/budgetTransfer/{id}/changeBudgetTransferStatus
- Create a Budget Transfer
- Method: postPath:
/primeapi/restapi/budgetTransfer
- Delete a Budget Transaction
- Method: deletePath:
/primeapi/restapi/budgetTransfer/transaction/{id}
- Delete a Budget Transfer
- Method: deletePath:
/primeapi/restapi/budgetTransfer/{id}
- Update a Budget Transfer
- Method: putPath:
/primeapi/restapi/budgetTransfer
- View a Budget Transfer
- Method: getPath:
/primeapi/restapi/budgetTransfer/{id}
- View a budget transfer by code
- Method: getPath:
/primeapi/restapi/budgetTransfer/byItemCode?workspaceCode={workspaceCode}&projectCode={projectCode}&budgetTransferCode={budgetTransferCode}
- View a Budget Transfer by Code and Project
- Method: getPath:
/primeapi/restapi/budgetTransfer/project/{id}/code/{code}
- View a Status Transition History Record by Budget Transfer
- Method: getPath:
/primeapi/restapi/budgetTransfer/{id}/statusTransitionHistory
- View a Status Transition History Record by Project
- Method: getPath:
/primeapi/restapi/budgetTransfer/project/{id}/statusTransitionHistory
- View all budget transfers by parent code
- Method: getPath:
/primeapi/restapi/budgetTransfer/byParent?workspaceCode={workspaceCode}&projectCode={projectCode}
- View Budget Transactions by Budget Transfer
- Method: getPath:
/primeapi/restapi/budgetTransfer/{id}/transactions
- View Budget Transfer by Assigned Configured Field
- Method: getPath:
/primeapi/restapi/budgetTransfer/project/{id}/configuredField/{viewColumnName}/{value}
- View Budget Transfer by Assigned Configured Field
- Method: getPath:
/primeapi/restapi/budgetTransfer/projectBudget/{id}/configuredField/{viewColumnName}/{value}
- View Budget Transfer by Code and Project Budget
- Method: getPath:
/primeapi/restapi/budgetTransfer/projectBudget/{id}/code/{code}
- View Budget Transfer Configured Fields
- Method: getPath:
/primeapi/restapi/budgetTransfer/{id}/configuredFields
- View Budget Transfers by Project
- Method: getPath:
/primeapi/restapi/budgetTransfer/project/{id}
- View Budget Transfers by Project Budget
- Method: getPath:
/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: postPath:
/primeapi/restapi/cbs/project/syncBatch
- Create a Project CBS Code
- Method: postPath:
/primeapi/restapi/cbs/project/{id}
- Create a Project Costing Source
- Method: postPath:
/primeapi/restapi/cbs/project/{id}/projectCostingSource
- Create a Workspace CBS Code
- Method: postPath:
/primeapi/restapi/cbs/workspace/{id}
- Delete a Project CBS Code by Workspace CBS ID
- Method: deletePath:
/primeapi/restapi/cbs/project/{id}
- Delete a Workspace CBS Code by Workspace CBS ID
- Method: deletePath:
/primeapi/restapi/cbs/workspace/{id}
- Integrate a CBS with an External Data Source
- Method: postPath:
/primeapi/restapi/cbs/project/sync
- Push Down all Workspace CBS Code to Project
- Method: putPath:
/primeapi/restapi/cbs/import/workspace/{workspaceCode}/project/{projectCode}
- Push Down all Workspace CBS Code to Project
- Method: putPath:
/primeapi/restapi/cbs/moveAll/workspace/{workspaceCode}/project/{projectCode}
- Reset all Project Cost Sheet Code.
- Method: deletePath:
/primeapi/restapi/cbs/resetCostSheet/workspace/{workspaceCode}/project/{projectCode}
- Update a Project CBS Code by CBS
- Method: putPath:
/primeapi/restapi/cbs/project
- Update a Project Costing Source
- Method: putPath:
/primeapi/restapi/cbs/project/{id}/projectCostingSource
- Update a Workspace CBS Code
- Method: putPath:
/primeapi/restapi/cbs/workspace
- View a CBS by ID and Type
- Method: getPath:
/primeapi/restapi/cbs/{id}?type={type}
- View a CBS Sheet Code by Project and CBS Code
- Method: getPath:
/primeapi/restapi/cbs/project/{id}/code/{cbsCode}
- View a CBS Sheet Total Cost Row by Project
- Method: getPath:
/primeapi/restapi/cbs/project/{id}/totalCost
- View a project CBS by code
- Method: getPath:
/primeapi/restapi/cbs/project/byItemCode?workspaceCode={workspaceCode}&projectCode={projectCode}&cbsCode={cbsCode}
- View a Project Costing Source
- Method: getPath:
/primeapi/restapi/cbs/project/{id}/projectCostingSource
- View a workspace CBS by code
- Method: getPath:
/primeapi/restapi/cbs/workspace/byItemCode?workspaceCode={workspaceCode}&cbsCode={cbsCode}
- View a Workspace Total Item by ID and Template Type
- Method: getPath:
/primeapi/restapi/cbs/aggregate/reference/{id}?templateType={templateType}
- View all CBS Codes Assigned to a Workspace or Project
- Method: getPath:
/primeapi/restapi/cbs/project/{id}
- View all CBS Codes Assigned to a Workspace or Project
- Method: getPath:
/primeapi/restapi/cbs/workspace/{id}
- View all project CBSs by parent code
- Method: getPath:
/primeapi/restapi/cbs/project/byParent?workspaceCode={workspaceCode}&projectCode={projectCode}
- View all workspace CBSs by parent code
- Method: getPath:
/primeapi/restapi/cbs/workspace/byParent?workspaceCode={workspaceCode}
- View Integrated CBSs
- Method: getPath:
/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: postPath:
/primeapi/restapi/calendar/replicateObjectInWorkspaces/calendar/{calendarId}/workspace/{workspaceId}
- Batch Create Calendars
- Method: postPath:
/primeapi/restapi/calendar/batch
- Batch Delete Calendars
- Method: deletePath:
/primeapi/restapi/calendar/batch
- Batch Update Calendars
- Method: putPath:
/primeapi/restapi/calendar/batch
- Create a Calendar
- Method: postPath:
/primeapi/restapi/calendar
- Delete a Calendar
- Method: deletePath:
/primeapi/restapi/calendar/{id}
- Update a Calendar
- Method: putPath:
/primeapi/restapi/calendar
- View a Calendar
- Method: getPath:
/primeapi/restapi/calendar/{id}
- View a calendar by code
- Method: getPath:
/primeapi/restapi/calendar/byItemCode?workspaceCode={workspaceCode}&calendarCode={calendarCode}
- View a Calendar by Code
- Method: getPath:
/primeapi/restapi/calendar/code/{code}
- View a Calendar by Code
- Method: getPath:
/primeapi/restapi/calendar/workspace/{workspaceId}/code/{code}
- View all calendars by parent
- Method: getPath:
/primeapi/restapi/calendar/byParent?workspaceCode={workspaceCode}
- View Calendar Exceptions
- Method: getPath:
/primeapi/restapi/calendar/exception/{id}
- View Calendars by Workspace
- Method: getPath:
/primeapi/restapi/calendar/workspace/{id}
- View Default Workspace Calendar
- Method: getPath:
/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: postPath:
/primeapi/restapi/capitalPortfolioMember/batch
- Create a Capital Portfolio Member
- Method: postPath:
/primeapi/restapi/capitalPortfolioMember
- View a Capital Portfolio Member
- Method: getPath:
/primeapi/restapi/capitalPortfolioMember/portfolio/{portfolioId}
- View a Capital Portfolio Member
- Method: getPath:
/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: postPath:
/primeapi/restapi/changeEstimate/batch
- Batch Delete Change Estimates
- Method: deletePath:
/primeapi/restapi/changeEstimate/batch
- Batch Update Change Estimates
- Method: putPath:
/primeapi/restapi/changeEstimate/batch
- Create a Change Estimate
- Method: postPath:
/primeapi/restapi/changeEstimate
- Delete a Change Estimate
- Method: deletePath:
/primeapi/restapi/changeEstimate/{id}
- Update a Change Estimate
- Method: putPath:
/primeapi/restapi/changeEstimate
- View a Change Estimate
- Method: getPath:
/primeapi/restapi/changeEstimate/{id}
- View a Change Estimate by Parent
- Method: getPath:
/primeapi/restapi/changeEstimate/byParent?worksaceCode={worksaceCode}&projectCode={projectCode}&changeEventCode={changeEventCode}
- View a Change Estimate by Parent and Code
- Method: getPath:
/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: postPath:
/primeapi/restapi/changeEvent/batch
- Batch Delete Change Events
- Method: deletePath:
/primeapi/restapi/changeEvent/batch
- Batch Update Change Events
- Method: putPath:
/primeapi/restapi/changeEvent/batch
- Create a Change Event
- Method: postPath:
/primeapi/restapi/changeEvent
- Delete a Change Event
- Method: deletePath:
/primeapi/restapi/changeEvent/{id}
- Update a Change Event
- Method: putPath:
/primeapi/restapi/changeEvent
- View a Change Event
- Method: getPath:
/primeapi/restapi/changeEvent/{id}
- View a Change Event by Parent
- Method: getPath:
/primeapi/restapi/changeEvent/byParent?worksaceCode={worksaceCode}&projectCode={projectCode}
- View a Change Event by Parent and Code
- Method: getPath:
/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: postPath:
/primeapi/restapi/changeOrder/batch
- Batch Delete Change Orders
- Method: deletePath:
/primeapi/restapi/changeOrder/batch
- Batch Integrate Change Orders with an External Data Source
- Method: postPath:
/primeapi/restapi/changeOrder/syncBatch
- Batch Update Change Orders
- Method: putPath:
/primeapi/restapi/changeOrder/batch
- Collect Change Orders
- Method: putPath:
/primeapi/restapi/changeOrder/collect/workspace/{worksaceCode}/project/{projectCode}/associatedContract/{associatedContractCode}/code/{contractChangeOrderCode}
- Create a Change Order
- Method: postPath:
/primeapi/restapi/changeOrder
- Delete a Change Order
- Method: deletePath:
/primeapi/restapi/changeOrder/{id}
- Integrate a Change Order with an External Data Source
- Method: postPath:
/primeapi/restapi/changeOrder/sync
- Uncollect Change Orders
- Method: putPath:
/primeapi/restapi/changeOrder/uncollect/workspace/{workspaceCode}/project/{projectCode}/associatedContract/{associatedContractCode}/code/{contractChangeOrderCode}
- Update a Change Order
- Method: putPath:
/primeapi/restapi/changeOrder
- View a Change Order
- Method: getPath:
/primeapi/restapi/changeOrder/{id}
- View Change Orders by Parent
- Method: getPath:
/primeapi/restapi/changeOrder/workspace/{worksaceCode}/project/{projectCode}/associatedAgreement/{associatedAgreementCode}/type/{agreementType}
- View Change Orders by Parent and Code
- Method: getPath:
/primeapi/restapi/changeOrder/workspace/{worksaceCode}/project/{projectCode}/associatedAgreement/{associatedAgreementCode}/type/{agreementType}/code/{changeOrderCode}
- View Collected Change Orders
- Method: getPath:
/primeapi/restapi/changeOrder/collected/workspace/{worksaceCode}/project/{projectCode}/associatedContract/{associatedContractCode}/contractChangeOrder/{contractChangeOrderCode}
- View Integrated Change Orders
- Method: getPath:
/primeapi/restapi/changeOrder/externallySourced
- View Uncollected Change Orders
- Method: getPath:
/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: postPath:
/primeapi/restapi/changeOrderLineItem/batch
- Batch Delete Change Order Line Items
- Method: deletePath:
/primeapi/restapi/changeOrderLineItem/batch
- Batch Integrate Change Order Line Items with an External Data Source
- Method: postPath:
/primeapi/restapi/changeOrderLineItem/syncBatch
- Batch Update Change Order Line Items
- Method: putPath:
/primeapi/restapi/changeOrderLineItem/batch
- Create a Change Order Line Item
- Method: postPath:
/primeapi/restapi/changeOrderLineItem
- Delete a Change Order Line Item
- Method: deletePath:
/primeapi/restapi/changeOrderLineItem/{id}
- Integrate a Change Order Line Item with an External Data Source
- Method: postPath:
/primeapi/restapi/changeOrderLineItem/sync
- Update a Change Order Line Item
- Method: putPath:
/primeapi/restapi/changeOrderLineItem
- View Change Order Line Items
- Method: getPath:
/primeapi/restapi/changeOrderLineItem/{id}
- View Change Order Line Items by Parent
- Method: getPath:
/primeapi/restapi/changeOrderLineItem/workspace/{worksaceCode}/project/{projectCode}/changeOrder/{changeOrderCode}/associatedAgreement/{associatedAgreementCode}/type/{agreementType}
- View Change Order Line Items by Parent and Code
- Method: getPath:
/primeapi/restapi/changeOrderLineItem/workspace/{worksaceCode}/project/{projectCode}/changeOrder/{changeOrderCode}/associatedAgreement/{associatedAgreementCode}/type/{agreementType}/code/{lineItemCode}
- View Integrated Change Order Line Items
- Method: getPath:
/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: postPath:
/primeapi/restapi/changeOrderSOV/batch
- Batch Delete Change Order SOVs
- Method: deletePath:
/primeapi/restapi/changeOrderSOV/batch
- Batch Updated Change Order SOVs
- Method: putPath:
/primeapi/restapi/changeOrderSOV/batch
- Create a Change Order SOV
- Method: postPath:
/primeapi/restapi/changeOrderSOV
- Delete a Change Order SOV
- Method: deletePath:
/primeapi/restapi/changeOrderSOV/{id}
- Update a Change Order SOV
- Method: putPath:
/primeapi/restapi/changeOrderSOV
- View a Change Order SOV
- Method: getPath:
/primeapi/restapi/changeOrderSOV/{id}
- View a Change Order SOV by Parent
- Method: getPath:
/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: getPath:
/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: postPath:
/primeapi/restapi/changeRequest/batch
- Batch Update Change Requests
- Method: putPath:
/primeapi/restapi/changeRequest/batch
- Create a Change Request
- Method: postPath:
/primeapi/restapi/changeRequest
- Update a Change Request
- Method: putPath:
/primeapi/restapi/changeRequest
- View a Change Request
- Method: getPath:
/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: postPath:
/primeapi/restapi/codeValue/batch
- Batch Delete Code Values
- Method: deletePath:
/primeapi/restapi/codeValue/batch
- Batch Update Code Values
- Method: putPath:
/primeapi/restapi/codeValue/batch
- Create a Code Value
- Method: postPath:
/primeapi/restapi/codeValue
- Delete a Code Value
- Method: deletePath:
/primeapi/restapi/codeValue/{id}
- Update a Code Value
- Method: putPath:
/primeapi/restapi/codeValue
- View a Code Value
- Method: getPath:
/primeapi/restapi/codeValue/{id}
- View All Child Code Values in a Code Value Hierarchy
- Method: getPath:
/primeapi/restapi/codeValue/{id}/childrenHierarchy
- View Code Value by Code Type and Workspace
- Method: getPath:
/primeapi/restapi/codeValue/workspaceId/{workspaceId}/codeTypeId/{codeTypeId}
- View Code Values by Code Type
- Method: getPath:
/primeapi/restapi/codeValue/codeType/{id}
- View Code Values by Code Type and Code
- Method: getPath:
/primeapi/restapi/codeValue/code/{code}/codeType/{id}
- View Code Values by Code Type Name
- Method: getPath:
/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: postPath:
/primeapi/restapi/codeType/replicateObjectInWorkspaces/codeType/{codeTypeId}/workspace/{workspaceId}
- Batch Create Code Types
- Method: postPath:
/primeapi/restapi/codeType/batch
- Batch Delete Code Types
- Method: deletePath:
/primeapi/restapi/codeType/batch
- Delete a Code Type
- Method: deletePath:
/primeapi/restapi/codeType/{id}
- Update Code Types
- Method: putPath:
/primeapi/restapi/codeType/batch
- View a Code Type
- Method: getPath:
/primeapi/restapi/codeType/{id}
- View a code type by code
- Method: getPath:
/primeapi/restapi/codeType/byItemCode?workspaceCode={workspaceCode}&codeTypeCode={codeTypeCode}
- View all code types by parent
- Method: getPath:
/primeapi/restapi/codeType/byParent?workspaceCode={workspaceCode}
- View Code Types by Associated Object
- Method: getPath:
/primeapi/restapi/codeType?type={type}
- View Code Types by Workspace
- Method: getPath:
/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: postPath:
/primeapi/restapi/commitment/batch
- Batch Delete Commitments
- Method: deletePath:
/primeapi/restapi/commitment/batch
- Batch Integrate Commitments with an External Data Source
- Method: postPath:
/primeapi/restapi/commitment/syncBatch
- Batch Update Commitments
- Method: putPath:
/primeapi/restapi/commitment/batch
- Create a Commitment
- Method: postPath:
/primeapi/restapi/commitment
- Delete a Commitment
- Method: deletePath:
/primeapi/restapi/commitment/{id}
- Integrate a Commitment with an External Data Source
- Method: postPath:
/primeapi/restapi/commitment/sync
- Update a Commitment
- Method: putPath:
/primeapi/restapi/commitment
- View a Commitment
- Method: getPath:
/primeapi/restapi/commitment/{id}
- View a commitment by code
- Method: getPath:
/primeapi/restapi/commitment/byItemCode?workspaceCode={workspaceCode}&projectCode={projectCode}&commitmentCode={commitmentCode}
- View a Commitment by Item Code
- Method: getPath:
/primeapi/restapi/commitment/code/{code}
- View a Commitment by Item Code and Project
- Method: getPath:
/primeapi/restapi/commitment/project/{projectId}/code/{code}
- View all commitments by parent
- Method: getPath:
/primeapi/restapi/commitment/byParent?workspaceCode={workspaceCode}&projectCode={projectCode}
- View Commitments by Project
- Method: getPath:
/primeapi/restapi/commitment/project/{id}
- View Integrated Commitments
- Method: getPath:
/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: postPath:
/primeapi/restapi/commitmentLineItem/batch
- Batch Delete Commitment Line Items
- Method: deletePath:
/primeapi/restapi/commitmentLineItem/batch
- Batch Integrate Commitment Line Items with an External Data Source
- Method: postPath:
/primeapi/restapi/commitmentLineItem/syncBatch
- Batch Update Commitment Line Items
- Method: putPath:
/primeapi/restapi/commitmentLineItem/batch
- Create a Commitment Line Item
- Method: postPath:
/primeapi/restapi/commitmentLineItem
- Delete a Commitment Line Item
- Method: deletePath:
/primeapi/restapi/commitmentLineItem/{id}
- Integrate a Commitment Line Item with an External Data Source
- Method: postPath:
/primeapi/restapi/commitmentLineItem/sync
- Update a Commitment Line Item
- Method: putPath:
/primeapi/restapi/commitmentLineItem
- View a Commitment Line Item
- Method: getPath:
/primeapi/restapi/commitmentLineItem/{id}
- View a Commitment Line Item by Commitment Line Item Code
- Method: getPath:
/primeapi/restapi/commitmentLineItem/code/{code}
- View a Commitment Line Item by Commitment Line Item Code and Commitment
- Method: getPath:
/primeapi/restapi/commitmentLineItem/commitment/{commitmentId}/code/{code}
- View Commitment Line Items by Commitment
- Method: getPath:
/primeapi/restapi/commitmentLineItem/commitment/{commitmentId}
- View Integrated Commitment Line Items
- Method: getPath:
/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: postPath:
/primeapi/restapi/company/syncBatch
- Delete a Company
- Method: deletePath:
/primeapi/restapi/company/{id}
- Integrate a Company with an External Data Source
- Method: postPath:
/primeapi/restapi/company/sync
- View a Company
- Method: getPath:
/primeapi/restapi/company/{id}
- View a Company by Name
- Method: getPath:
/primeapi/restapi/company/name/{name}
- View all Companies
- Method: getPath:
/primeapi/restapi/company/list
- View Companies by Assigned Configured Field Value
- Method: getPath:
/primeapi/restapi/company/configuredField/{viewColumnName}/{value}
- View Companies by Tenant Owner
- Method: getPath:
/primeapi/restapi/company/tenantOwner
- View Company Configured Fields
- Method: getPath:
/primeapi/restapi/company/{id}/configuredFields
- View Integrated Companies
- Method: getPath:
/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: postPath:
/primeapi/restapi/field/replicateObjectInWorkspaces/configuredField/{configuredFieldId}/workspace/{workspaceId}
- Create a Configured Field
- Method: postPath:
/primeapi/restapi/field?objectType={objectType}
- View a Configured Field
- Method: getPath:
/primeapi/restapi/field/{id}
- View a Configured Field by Workspace
- Method: getPath:
/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: postPath:
/primeapi/restapi/contract/batch
- Batch Delete Contracts
- Method: deletePath:
/primeapi/restapi/contract/batch
- Batch Update Contracts
- Method: putPath:
/primeapi/restapi/contract/batch
- Create a Contract
- Method: postPath:
/primeapi/restapi/contract
- Delete a Contract
- Method: deletePath:
/primeapi/restapi/contract/{id}
- Update a Contract
- Method: putPath:
/primeapi/restapi/contract
- View a Contract
- Method: getPath:
/primeapi/restapi/contract/{id}
- View a Contract by Code
- Method: getPath:
/primeapi/restapi/contract/code/{code}
- View Contract Status Transition History
- Method: getPath:
/primeapi/restapi/contract/{code}/project/{projectId}/history
- View Contracts by Project
- Method: getPath:
/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: postPath:
/primeapi/restapi/contractLineItem/batch
- Batch Delete Contract Line Items
- Method: deletePath:
/primeapi/restapi/contractLineItem/batch
- Batch Update Contract Line Items
- Method: putPath:
/primeapi/restapi/contractLineItem/batch
- Create a Contract Line Item
- Method: postPath:
/primeapi/restapi/contractLineItem
- Delete a Contract Line Item
- Method: deletePath:
/primeapi/restapi/contractLineItem/{id}
- Delete Contract Line Items by Contract
- Method: deletePath:
/primeapi/restapi/contractLineItem/contract/{id}
- Update a Contract Line Item
- Method: putPath:
/primeapi/restapi/contractLineItem
- View a Contract Line Item
- Method: getPath:
/primeapi/restapi/contractLineItem/{id}
- View a Contract Line Item by Code
- Method: getPath:
/primeapi/restapi/contractLineItem/code/{code}
- View a Contract Line Item by Contract
- Method: getPath:
/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: postPath:
/primeapi/restapi/costCategory/replicateObjectInWorkspaces/costCategory/{costCategoryId}/workspace/{workspaceId}
- Batch Create Cost Categories
- Method: postPath:
/primeapi/restapi/costCategory/batch
- Batch Delete Cost Categories
- Method: deletePath:
/primeapi/restapi/costCategory/batch
- Batch Update Cost Categories
- Method: putPath:
/primeapi/restapi/costCategory/batch
- Delete a Cost Category
- Method: deletePath:
/primeapi/restapi/costCategory/{id}
- View a Cost Category
- Method: getPath:
/primeapi/restapi/costCategory/{id}
- View a Cost Category by Name
- Method: getPath:
/primeapi/restapi/costCategory/name/{name}
- View a Cost Category by Name and Workspace
- Method: getPath:
/primeapi/restapi/costCategory/workspace/{workspaceId}/name/{name}
- View a Cost Category Row
- Method: getPath:
/primeapi/restapi/costCategory/categoryRow/costCategory/{costCategoryId}
- View a Cost Category Row by Cost Item
- Method: getPath:
/primeapi/restapi/costCategory/categoryRow/costItem/{costItemId}
- View a Cost Category Row by Cost Sheet
- Method: getPath:
/primeapi/restapi/costCategory/categoryRow/costSheet/{costSheetId}
- View Code Type by Cost Category Type
- Method: getPath:
/primeapi/restapi/costCategory?type={type}
- View Cost Categories by Workspace
- Method: getPath:
/primeapi/restapi/costCategory/workspace/{id}
- View Cost Category Rows by Cost Category Name and Project
- Method: getPath:
/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: postPath:
/primeapi/restapi/currency/replicateObjectInWorkspaces/currency/{currencyId}/workspace/{workspaceId}
- Create a Currency
- Method: postPath:
/primeapi/restapi/currency
- Delete a Currency
- Method: deletePath:
/primeapi/restapi/currency/{id}
- Update a Currency
- Method: putPath:
/primeapi/restapi/currency
- View a Currency
- Method: getPath:
/primeapi/restapi/currency/{id}
- View a Currency by Code
- Method: getPath:
/primeapi/restapi/currency/code/{code}
- View a Currency by Name
- Method: getPath:
/primeapi/restapi/currency/name/{name}
- View a Currency Seed
- Method: getPath:
/primeapi/restapi/currency/currencySeed
- View Currencies by Workspace
- Method: getPath:
/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: postPath:
/primeapi/restapi/curve/replicateObjectInWorkspaces/curve/{curveId}/workspace/{workspaceId}
- Batch Create Curves
- Method: postPath:
/primeapi/restapi/curve/batch
- Batch Delete Curves
- Method: deletePath:
/primeapi/restapi/curve/batch
- Batch Update Curves
- Method: putPath:
/primeapi/restapi/curve/batch
- Create a Curve
- Method: postPath:
/primeapi/restapi/curve
- Delete a Curve
- Method: deletePath:
/primeapi/restapi/curve/{id}
- Update a Curve
- Method: putPath:
/primeapi/restapi/curve
- View a Curve
- Method: getPath:
/primeapi/restapi/curve/{id}
- View a Curve by Name
- Method: getPath:
/primeapi/restapi/curve/name/{curveName}
- View a Curve by Workspace
- Method: getPath:
/primeapi/restapi/curve/workspace/{workspaceId}
- View a Curve by Workspace and Name
- Method: getPath:
/primeapi/restapi/curve/workspace/{workspaceId}/name/{curveName}
- View a curve profile by name and workspace
- Method: getPath:
/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: postPath:
/primeapi/restapi/customLogItem/batch
- Batch Delete Custom Log Items
- Method: deletePath:
/primeapi/restapi/customLogItem/batch
- Batch Update Custom Log Items
- Method: putPath:
/primeapi/restapi/customLogItem/batch
- Create a Custom Log Item
- Method: postPath:
/primeapi/restapi/customLogItem
- Delete a Custom Log Item
- Method: deletePath:
/primeapi/restapi/customLogItem/{id}
- Update a Custom Log Item
- Method: putPath:
/primeapi/restapi/customLogItem
- View a Custom Log Item
- Method: getPath:
/primeapi/restapi/customLogItem/{id}
- View a Custom Log Item by Parent
- Method: getPath:
/primeapi/restapi/customLogItem/workspace/{worksaceCode}/project/{projectCode}/customLogObject/{customLogObjectName}
- View a Custom Log Item by Parent and Code
- Method: getPath:
/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: postPath:
/primeapi/restapi/customLogTypeObject/batch
- Batch Delete Custom Log Type Object Code Types
- Method: deletePath:
/primeapi/restapi/customLogTypeObject/codeTypes/workspace/{workspaceCode}/project/{projectCode}/name/{customLogTypeObjectName}
- Batch Delete Custom Log Type Object Configured Fields
- Method: deletePath:
/primeapi/restapi/customLogTypeObject/udfs/workspace/{workspaceCode}/project/{projectCode}/name/{customLogTypeObjectName}
- Batch Delete Custom Log Type Objects
- Method: deletePath:
/primeapi/restapi/customLogTypeObject/batch
- Batch Update Custom Log Type Objects
- Method: putPath:
/primeapi/restapi/customLogTypeObject/batch
- Create a Custom Log Type Object
- Method: postPath:
/primeapi/restapi/customLogTypeObject
- Delete a Custom Log Type Object
- Method: deletePath:
/primeapi/restapi/customLogTypeObject/{id}
- Update a Custom Log Type Object
- Method: putPath:
/primeapi/restapi/customLogTypeObject
- View a Custom Log Type Object
- Method: getPath:
/primeapi/restapi/customLogTypeObject/{id}
- View a Custom Log Type Object by Parent and Code
- Method: getPath:
/primeapi/restapi/customLogTypeObject/workspace/{workspaceCode}/project/{projectCode}/name/{customLogObjectName}
- View Custom Log Type Objects by Parent
- Method: getPath:
/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: deletePath:
/primeapi/restapi/document/batch/files
- Batch Delete Folders
- Method: deletePath:
/primeapi/restapi/document/batch/folders
- Check-in a Document
- Method: postPath:
/primeapi/restapi/document/file/{id}/checkin
- Check-out a Document
- Method: getPath:
/primeapi/restapi/document/file/{id}/checkout
- Copy a Template to a Folder
- Method: postPath:
/primeapi/restapi/document/templateCopy/sourceTemplate/{id}/targetFolder/{targetId}
- Create a Document
- Method: postPath:
/primeapi/restapi/document/folder
- Delete a File
- Method: deletePath:
/primeapi/restapi/document/file/{id}
- Delete a Folder
- Method: deletePath:
/primeapi/restapi/document/folder/{id}
- Download a File
- Method: getPath:
/primeapi/restapi/document/file/{id}/download
- Download a Specific Version of a File
- Method: getPath:
/primeapi/restapi/document/file/{id}/version/{ver}/download
- Link a document to another object
- Method: getPath:
/primeapi/restapi/document/{docId}/scope/{type}/scopeId/{id}/linkDocument
- Unlink a Document
- Method: getPath:
/primeapi/restapi/document/{docId}/scope/{type}/scopeId/{id}/unlinkDocument
- Update a File
- Method: putPath:
/primeapi/restapi/document/file
- Update a Folder
- Method: putPath:
/primeapi/restapi/document/folder
- Upload a Document
- Method: postPath:
/primeapi/restapi/document/uploadFile/parent/{folderId}/fileName/{fileName}
- View a Child Folder
- Method: getPath:
/primeapi/restapi/document/folder/{id}/childFolders
- View a Document by Path
- Method: getPath:
/primeapi/restapi/document/workspace/{code}/{type}/search?path={path}
- View a File
- Method: getPath:
/primeapi/restapi/document/file/{id}
- View a File by Folder
- Method: getPath:
/primeapi/restapi/document/folder/{id}/files
- View a Folder
- Method: getPath:
/primeapi/restapi/document/folder/{id}
- View a Folder by Name
- Method: getPath:
/primeapi/restapi/document/{name}/folderTemplate/{id}
- View all Children by Template
- Method: getPath:
/primeapi/restapi/document/template/{id}/allChildren
- View all Children of a Folder
- Method: getPath:
/primeapi/restapi/document/folder/{id}/allChildren
- View all Document References
- Method: getPath:
/primeapi/restapi/document/file/{id}/references
- View File Annotations
- Method: getPath:
/primeapi/restapi/document/file/{id}/version/{ver}/annotations
- View File Versions
- Method: getPath:
/primeapi/restapi/document/file/{id}/version
- View Files by Template
- Method: getPath:
/primeapi/restapi/document/template/{id}/files
- View Folders by Template
- Method: getPath:
/primeapi/restapi/document/template/{id}/childFolders
- View the Root Folder by Template
- Method: getPath:
/primeapi/restapi/document/template/{id}/root
- View the Root Folder of a Portfolio
- Method: getPath:
/primeapi/restapi/document/portfolio/{id}/root
- View the Root Folder of a Project
- Method: getPath:
/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: postPath:
/primeapi/restapi/folderTemplate/batch
- Batch Delete Document Folder Structure Templates
- Method: deletePath:
/primeapi/restapi/folderTemplate/batch
- Batch Update Document Folder Structure Templates
- Method: putPath:
/primeapi/restapi/folderTemplate/batch
- Create a Document Folder Structure Template
- Method: postPath:
/primeapi/restapi/folderTemplate
- Delete a Document Folder Structure Template
- Method: deletePath:
/primeapi/restapi/folderTemplate/{id}
- Update a Document Folder Structure Template
- Method: putPath:
/primeapi/restapi/folderTemplate
- View a Document Folder Strucutre Template
- Method: getPath:
/primeapi/restapi/folderTemplate/{id}
- View all Document Folder Structure Templates by Workspace
- Method: getPath:
/primeapi/restapi/folderTemplate/workspace/{id}
- View Document Folder Structure Templates by Name
- Method: getPath:
/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: postPath:
/primeapi/restapi/exchangeRate
- View an Exchange Rate
- Method: getPath:
/primeapi/restapi/exchangeRate/{id}
- View Exchange Rates by Currency
- Method: getPath:
/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: postPath:
/primeapi/restapi/funds/workspace/workspace/allocation
- Allocates a Workspace Fund to the Portfolio.
- Method: postPath:
/primeapi/restapi/funds/workspace/portfolio/allocation
- Allocates a Workspace Fund to the Project.
- Method: postPath:
/primeapi/restapi/funds/workspace/project/allocation
- Create Portfolio Funds.
- Method: postPath:
/primeapi/restapi/funds/portfolio/batch
- Create Project Funds.
- Method: postPath:
/primeapi/restapi/funds/project/batch
- Create Workspace Funds.
- Method: postPath:
/primeapi/restapi/funds/workspace/batch
- Creates a Portfolio Fund.
- Method: postPath:
/primeapi/restapi/funds/portfolio
- Creates a Project Fund.
- Method: postPath:
/primeapi/restapi/funds/project
- Creates a Workspace Fund.
- Method: postPath:
/primeapi/restapi/funds/workspace
- Delete Funds.
- Method: deletePath:
/primeapi/restapi/funds/batch
- Deletes a Fund.
- Method: deletePath:
/primeapi/restapi/funds/{id}
- Return Fund Totals for the Specified Portfolio Code and Workspace Code.
- Method: getPath:
/primeapi/restapi/funds/portfolio/fundtotal?workspaceCode={workspaceCode}&portfolioCode={portfolioCode}
- Return Fund Totals for the Specified Workspace Code.
- Method: getPath:
/primeapi/restapi/funds/workspace/fundtotal?workspaceCode={workspaceCode}
- Return Funds for the Specified Portfolio Code and Workspace Code.
- Method: getPath:
/primeapi/restapi/funds/portfolio/list?portfolioCode={portfolioCode}&workspaceCode={workspaceCode}
- Return Funds for the Specified Project Code.
- Method: getPath:
/primeapi/restapi/funds/project/list?projectCode={projectCode}
- Return Funds for the Specified Workspace Code.
- Method: getPath:
/primeapi/restapi/funds/workspace/list?workspaceCode={workspaceCode}
- Returns the Fund for the Specified Project Code and Fund Code.
- Method: getPath:
/primeapi/restapi/funds/project/byFundCode?projectCode={projectCode}&fundCode={fundCode}
- Returns the Fund for the Specified Project Code and Fund Name.
- Method: getPath:
/primeapi/restapi/funds/project/byFundName?projectCode={projectCode}&fundName={fundName}
- Returns the Fund for the Specified Workspace Code and Fund Code.
- Method: getPath:
/primeapi/restapi/funds/workspace/byFundCode?workspaceCode={workspaceCode}&fundCode={fundCode}
- Returns the Fund for the Specified Workspace Code and Fund Name.
- Method: getPath:
/primeapi/restapi/funds/workspace/byFundName?workspaceCode={workspaceCode}&fundName={fundName}
- Update Portfolio Funds.
- Method: putPath:
/primeapi/restapi/funds/portfolio/batch
- Update Project Funds.
- Method: putPath:
/primeapi/restapi/funds/project/batch
- Update Workspace Funds.
- Method: putPath:
/primeapi/restapi/funds/workspace/batch
- Updates a Portfolio Fund.
- Method: putPath:
/primeapi/restapi/funds/portfolio
- Updates a Project Fund.
- Method: putPath:
/primeapi/restapi/funds/project
- Updates a Workspace Fund.
- Method: putPath:
/primeapi/restapi/funds/workspace
- View a Fund.
- Method: getPath:
/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: postPath:
/primeapi/restapi/pims/appInstances
- Delete a Gateway App Instance
- Method: deletePath:
/primeapi/restapi/pims/appInstances/{id}
- Test a Gateway Deployment Connection
- Method: postPath:
/primeapi/restapi/pims/appInstances/testConnection
- Update a Gateway App Instance
- Method: putPath:
/primeapi/restapi/pims/appInstances/{id}
- View a Gateway App Instance
- Method: getPath:
/primeapi/restapi/pims/appInstances/{id}
- View All Gateway App Instances
- Method: getPath:
/primeapi/restapi/pims/appInstances/list?appId={appId}
- View All Gateway Deployments
- Method: getPath:
/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: getPath:
/primeapi/restapi/pims/appInstanceConfigurations/{id}
- View All Gateway App Instance Configurations
- Method: getPath:
/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: getPath:
/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: getPath:
/primeapi/restapi/pims/flowFieldMapTemplates/{id}
- View All Gateway Flow Field Mapping Templates
- Method: getPath:
/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: getPath:
/primeapi/restapi/pims/flowInstances/{id}
- View All Gateway Business Flow Instances
- Method: getPath:
/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: getPath:
/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: getPath:
/primeapi/restapi/pims/flowLoadObjects/list?flowId={flowId}
Gateway Flow Parameters
PIMS flow parameters.
- View a Gateway Flow Parameter
- Method: getPath:
/primeapi/restapi/pims/flowParameters/{id}
- View All Gateway Flow Parameters
- Method: getPath:
/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: getPath:
/primeapi/restapi/pims/flowStepInstanceMessages/download/{id}
- View Business Flow Step Messages
- Method: getPath:
/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: getPath:
/primeapi/restapi/pims/flowStepInstances/list?flowInstanceId={flowInstanceId}
- View Business Flow Step Details
- Method: getPath:
/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: postPath:
/primeapi/restapi/pims/flows
- Delete a Gateway Business Flow
- Method: deletePath:
/primeapi/restapi/pims/flows/{id}
- Update a Gateway Business Flow
- Method: putPath:
/primeapi/restapi/pims/flows/{id}
- View a Gateway Business Flow
- Method: getPath:
/primeapi/restapi/pims/flows/{id}
- View all Gateway Business Flows
- Method: getPath:
/primeapi/restapi/pims/flows/list?flowDefinitionId={flowDefinitionId}&isUser={isUser}
Gateway Parameter Values
PIMS parameter values.
- Returns all parameterValue business objects.
- Method: getPath:
/primeapi/restapi/pims/parameterValues/list?scheduleId={scheduleId}
- Returns the parameterValue business object for the specified parameterValue ID.
- Method: getPath:
/primeapi/restapi/pims/parameterValues/{id}
- Returns the parameterValue businesss objects for the specified Job ID.
- Method: getPath:
/primeapi/restapi/pims/parameterValues/byJobId?jobId={jobId}¶mName={paramName}
Gateway Services
- Initiate a Gateway Job
- Method: postPath:
/primeapi/restapi/pims/services/createJobProcess/{id}?review={review}&runOnChain={runOnChain}
- Initiate a Gateway Job with a Parameter
- Method: postPath:
/primeapi/restapi/pims/services/createJobProcessWithParameters/{id}
Gateway Synchronizations
PIMS synchronizations.
- Create a Business Flow Schedule
- Method: postPath:
/primeapi/restapi/pims/synchronizations
- Delete a Business Flow Schedule
- Method: deletePath:
/primeapi/restapi/pims/synchronizations/{id}
- Update a Business Flow Schedule
- Method: putPath:
/primeapi/restapi/pims/synchronizations/{id}
- View a Business Flow Schedule
- Method: getPath:
/primeapi/restapi/pims/synchronizations/{id}
- View All Business Flow Schedules
- Method: getPath:
/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: postPath:
/primeapi/restapi/holiday/batch
- Batch Delete Holidays
- Method: deletePath:
/primeapi/restapi/holiday/batch
- Batch Update Holidays
- Method: putPath:
/primeapi/restapi/holiday/batch
- Create a Holiday
- Method: postPath:
/primeapi/restapi/holiday
- Delete a Holiday
- Method: deletePath:
/primeapi/restapi/holiday/{id}
- Update a Holiday
- Method: putPath:
/primeapi/restapi/holiday
- View a Holiday
- Method: getPath:
/primeapi/restapi/holiday/{id}
- View a Holiday by Name
- Method: getPath:
/primeapi/restapi/holiday/name/{name}
- View a Holiday List by Holiday Group
- Method: getPath:
/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: postPath:
/primeapi/restapi/holidayList/batch
- Batch Delete Holiday Lists
- Method: deletePath:
/primeapi/restapi/holidayList/batch
- Batch Update Holiday Lists
- Method: putPath:
/primeapi/restapi/holidayList/batch
- Create a Holiday List
- Method: postPath:
/primeapi/restapi/holidayList
- Delete a Holiday List
- Method: deletePath:
/primeapi/restapi/holidayList/{id}
- Update a Holiday List
- Method: putPath:
/primeapi/restapi/holidayList
- View a Holiday List
- Method: getPath:
/primeapi/restapi/holidayList/{id}
- View a Holiday List by Name
- Method: getPath:
/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: postPath:
/primeapi/restapi/location/replicateObjectInWorkspaces/location/{locationId}/workspace/{workspaceId}
- Batch Create Locations
- Method: postPath:
/primeapi/restapi/location/batch
- Batch Delete Locations
- Method: deletePath:
/primeapi/restapi/location/batch
- Batch Update Locations
- Method: putPath:
/primeapi/restapi/location/batch
- Create a Location
- Method: postPath:
/primeapi/restapi/location
- Delete a Location
- Method: deletePath:
/primeapi/restapi/location/{id}
- Update a Location
- Method: putPath:
/primeapi/restapi/location
- View a Location
- Method: getPath:
/primeapi/restapi/location/{id}
- View a Location by Code
- Method: getPath:
/primeapi/restapi/location/code/{code}
- View a Location by Code and Workspace
- Method: getPath:
/primeapi/restapi/location/workspace/{workspaceId}/code/{code}
- View a Location by Name
- Method: getPath:
/primeapi/restapi/location/name/{name}
- View a Location by Workspace
- Method: getPath:
/primeapi/restapi/location/workspace/{id}
Measure
The Measure service enable you to create, update, view, and delete measures.
- Assign or Promote a Measure
- Method: postPath:
/primeapi/restapi/measure/replicateObjectInWorkspaces/measure/{measureId}/workspace/{workspaceId}
- Batch Create Measures
- Method: postPath:
/primeapi/restapi/measure/batch
- Batch Delete Measures
- Method: deletePath:
/primeapi/restapi/measure/batch
- Batch Update Measures
- Method: putPath:
/primeapi/restapi/measure/batch
- Create a Measure
- Method: postPath:
/primeapi/restapi/measure
- Delete a Measure
- Method: deletePath:
/primeapi/restapi/measure/{id}
- Update a Measure
- Method: putPath:
/primeapi/restapi/measure
- View a Measure
- Method: getPath:
/primeapi/restapi/measure/{id}
- View a Measure by Workspace and Name
- Method: getPath:
/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: postPath:
/primeapi/restapi/measureThreshold/batch
- Batch Delete Measure Thresholds
- Method: deletePath:
/primeapi/restapi/measureThreshold/batch
- Batch Update Measure Thresholds
- Method: putPath:
/primeapi/restapi/measureThreshold/batch
- Create a Measure Threshold
- Method: postPath:
/primeapi/restapi/measureThreshold
- Delete a Measure Threshold
- Method: deletePath:
/primeapi/restapi/measureThreshold/{id}
- Update a Measure Threshold
- Method: putPath:
/primeapi/restapi/measureThreshold
- View a Measure Threshold
- Method: getPath:
/primeapi/restapi/measureThreshold/{id}
- View a Measure Threshold by Measure
- Method: getPath:
/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: getPath:
/primeapi/restapi/monteCarloActivityDelta/{id}
- View a Monte Carlo Activity Delta by Activity
- Method: getPath:
/primeapi/restapi/monteCarloActivityDelta/activity/{activityId}
MonteCarlo Activity Deterministic Values
- View Monte Carlo Activity Deterministic Values
- Method: getPath:
/primeapi/restapi/monteCarloActivityDeterministicValues/{id}
- View Monte Carlo Activity Deterministic Values by Activity and Scenario
- Method: getPath:
/primeapi/restapi/monteCarloActivityDeterministicValues/activity/{activityId}/scenario/{scenario}
- View Monte Carlo Activity Deterministic Values by Project and Scenario
- Method: getPath:
/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: getPath:
/primeapi/restapi/monteCarloActivityRiskResult/{id}
- View Monte Carlo Activity Risk Results by Project Risk
- Method: getPath:
/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: getPath:
/primeapi/restapi/monteCarloProjectDelta/{id}
- View Monte Carlo Project Delta by Project and Scenario
- Method: getPath:
/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: getPath:
/primeapi/restapi/monteCarloProjectDeterministicValues/{id}
- View Monte Carlo Project Deterministic Values by Project and Scenario
- Method: getPath:
/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: getPath:
/primeapi/restapi/monteCarloProjectResult/{id}
- View a Monte Carlo Project Result by Project and Scenario
- Method: getPath:
/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: getPath:
/primeapi/restapi/monteCarloRiskResult/{id}
- View a Monte Carlo Risk Result by Project and Scenario
- Method: getPath:
/primeapi/restapi/monteCarloRiskResult/project/{projectId}/scenario/{scenario}
- View a Monte Carlo Risk Result by Project Risk and Scenario
- Method: getPath:
/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: getPath:
/primeapi/restapi/monteCarloRunSettings/{id}
- View Monte Carlo Run Settings by Project and Scenario
- Method: getPath:
/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: putPath:
/primeapi/restapi/monteCarloSettings/batch
- Create Default Monte Carlo Settings for a Project
- Method: postPath:
/primeapi/restapi/monteCarloSettings/createDefault/{projectId}
- Update Monte Carlo Settings
- Method: putPath:
/primeapi/restapi/monteCarloSettings
- View Monte Carlo Settings
- Method: getPath:
/primeapi/restapi/monteCarloSettings/{id}
- View Monte Carlo Settings by Project
- Method: getPath:
/primeapi/restapi/monteCarloSettings/project/{projectId}
Office
The Office service enables you to create, view, update, or delete offices.
- Create an Office.
- Method: postPath:
/primeapi/restapi/office
- Create Offices.
- Method: postPath:
/primeapi/restapi/office/batch
- Delete an Office.
- Method: deletePath:
/primeapi/restapi/office/{id}
- Delete Offices.
- Method: deletePath:
/primeapi/restapi/office/batch
- Update an Office.
- Method: putPath:
/primeapi/restapi/office
- Update Offices.
- Method: putPath:
/primeapi/restapi/office/batch
- View an Office.
- Method: getPath:
/primeapi/restapi/office/{id}
- View Offices for specified company.
- Method: getPath:
/primeapi/restapi/office/company/{name}/{postalCode}/{countryCode}
- View Offices for specified name.
- Method: getPath:
/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: postPath:
/primeapi/restapi/pbs
- Delete a PBS
- Method: deletePath:
/primeapi/restapi/pbs/{id}
- Delete all Children in a PBS Hierarchy
- Method: deletePath:
/primeapi/restapi/pbs/children/{id}
- Update a PBS
- Method: putPath:
/primeapi/restapi/pbs
- View a Child in a PBS Hierarchy
- Method: getPath:
/primeapi/restapi/pbs/children/{id}
- View a PBS
- Method: getPath:
/primeapi/restapi/pbs/{id}
- View a PBS by Code
- Method: getPath:
/primeapi/restapi/pbs/project/{id}/code/{code}
- View a PBS by Name
- Method: getPath:
/primeapi/restapi/pbs/project/{id}/name/{name}
- View a PBS by Project
- Method: getPath:
/primeapi/restapi/pbs/project/{id}
- View All Children in a PBS Hierarchy
- Method: getPath:
/primeapi/restapi/pbs/{id}/childrenHierarchy
Period Closeout Record
Use the Period Closeout service to view period closeouts.
- View a Period Closeout
- Method: getPath:
/primeapi/restapi/periodCloseoutRecord/{id}
- View a Period Closeout by Project
- Method: getPath:
/primeapi/restapi/periodCloseoutRecord/project/{projectId}
- View a Scope Item Assignment Period Closeout
- Method: getPath:
/primeapi/restapi/periodCloseoutData/{id}
- View a Scope Item Assignment Period Closeout by Period Item
- Method: getPath:
/primeapi/restapi/periodCloseoutData/periodItem/{periodItemId}
- View a Scope Item Assignment Period Closeout by Scope Item Assignement
- Method: getPath:
/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: postPath:
/primeapi/restapi/portfolio/batch
- Batch Delete Portfolios
- Method: deletePath:
/primeapi/restapi/portfolio/batch
- Batch Update Portfolios
- Method: putPath:
/primeapi/restapi/portfolio/batch
- Create a Portfolio
- Method: postPath:
/primeapi/restapi/portfolio
- Delete a Portfolio
- Method: deletePath:
/primeapi/restapi/portfolio/{id}
- Refresh a Portfolio
- Method: getPath:
/primeapi/restapi/portfolio/refresh/{id}
- Update a Portfolio
- Method: putPath:
/primeapi/restapi/portfolio
- View a Portfolio
- Method: getPath:
/primeapi/restapi/portfolio/{id}
- View a Portfolio by Name
- Method: getPath:
/primeapi/restapi/portfolio/name/{name}
- View a Portfolio by Name and Workspace
- Method: getPath:
/primeapi/restapi/portfolio/workspaceId/{workspaceId}/name/{name}
- View a Portfolio Image
- Method: getPath:
/primeapi/restapi/portfolio/image/{id}
- View Portfolios by Workspace
- Method: getPath:
/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: postPath:
/primeapi/restapi/portfolioMeasureManualValue/batch
- Batch Delete Portfolio Measure Manual Values
- Method: deletePath:
/primeapi/restapi/portfolioMeasureManualValue/batch
- Batch Update Portfolio Measure Manual Values
- Method: putPath:
/primeapi/restapi/portfolioMeasureManualValue/batch
- Create a Portfolio Measure Manual Value
- Method: postPath:
/primeapi/restapi/portfolioMeasureManualValue
- Delete a Portfolio Measure Manual Value
- Method: deletePath:
/primeapi/restapi/portfolioMeasureManualValue/{id}
- Update a Portfolio Measure Manual Value
- Method: putPath:
/primeapi/restapi/portfolioMeasureManualValue
- View a Portfolio Measure Manual Value
- Method: getPath:
/primeapi/restapi/portfolioMeasureManualValue/{id}
- View a Portfolio Measure Manual Value by Measure
- Method: getPath:
/primeapi/restapi/portfolioMeasureManualValue/measure/{measureId}
- View a Portfolio Measure Manual Value by Measure and Portfolio
- Method: getPath:
/primeapi/restapi/portfolioMeasureManualValue/measure/{measureId}/portfolio/{portfolioId}
- View a Portfolio Measure Manual Value by Portfolio
- Method: getPath:
/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: postPath:
/primeapi/restapi/portfolioMeasure/batch
- Batch Delete Portfolio Measures
- Method: deletePath:
/primeapi/restapi/portfolioMeasure/batch
- Batch Update Portfolio Measures
- Method: putPath:
/primeapi/restapi/portfolioMeasure/batch
- Create a Portfolio Measure
- Method: postPath:
/primeapi/restapi/portfolioMeasure
- Delete a Portfolio Measure
- Method: deletePath:
/primeapi/restapi/portfolioMeasure/{id}
- Update a Portfolio Measure
- Method: putPath:
/primeapi/restapi/portfolioMeasure
- View a Portfolio Measure
- Method: getPath:
/primeapi/restapi/portfolioMeasure/{id}
- View a Portfolio Measure by Measure
- Method: getPath:
/primeapi/restapi/portfolioMeasure/measure/{measureId}
- View a Portfolio Measure by Portfolio
- Method: getPath:
/primeapi/restapi/portfolioMeasure/currentUserPortfolios
- View a Portfolio Measure by Portfolio
- Method: getPath:
/primeapi/restapi/portfolioMeasure/portfolio/{portfolioId}
PortfolioMeasureValue
Use the Portfolio Measure Value service to view portfolio measure values.
- View a Project Measure Value
- Method: getPath:
/primeapi/restapi/portfolioMeasureValue/{id}
- View a Project Measure Value by Measure
- Method: getPath:
/primeapi/restapi/portfolioMeasureValue/measure/{measureId}
- View a Project Measure Value by Measure and Portfolio
- Method: getPath:
/primeapi/restapi/portfolioMeasureValue/measure/{measureId}/portfolio/{portfolioId}
- View Project Measure Value by Portfolio
- Method: getPath:
/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: getPath:
/primeapi/restapi/portfolioProject/{id}
- View Portfolio Projects by Portfolio
- Method: getPath:
/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: deletePath:
/primeapi/restapi/project/batch?cascadeOnDelete={cascadeOnDelete}
- Batch Integrate Projects with an External Data Source
- Method: postPath:
/primeapi/restapi/project/syncBatch
- Create a Project
- Method: postPath:
/primeapi/restapi/project
- Delete a Project
- Method: deletePath:
/primeapi/restapi/project/{id}?cascadeOnDelete={cascadeOnDelete}
- Integrate a Project with an External Data Source
- Method: postPath:
/primeapi/restapi/project/sync
- Update a Project
- Method: putPath:
/primeapi/restapi/project
- View a Project by Code
- Method: getPath:
/primeapi/restapi/project/code/{code}
- View a Project by Code and Workspace
- Method: getPath:
/primeapi/restapi/project/workspace/{workspaceId}/code/{code}
- View a project by code.
- Method: getPath:
/primeapi/restapi/project/byItemCode?workspaceCode={workspaceCode}&projectCode={projectCode}
- View a Project by Name
- Method: getPath:
/primeapi/restapi/project/name/{name}
- View a Project by Workspace
- Method: getPath:
/primeapi/restapi/project/workspace/{id}
- View a Project Image
- Method: getPath:
/primeapi/restapi/project/image/{id}
- View all projects by parent code.
- Method: getPath:
/primeapi/restapi/project/byParent?workspaceCode={workspaceCode}
- View Integrated Projects
- Method: getPath:
/primeapi/restapi/project/externallySourced
- View Project by Name and Workspace
- Method: getPath:
/primeapi/restapi/project/nameLike/{name}
- View Project Configured Fields
- Method: getPath:
/primeapi/restapi/project/{id}/configuredFields
- View Projects by Assigned Code Value
- Method: getPath:
/primeapi/restapi/project/codeType/{typeId}/codeValue/{code}
- View Projects by Assigned Configured Field Value
- Method: getPath:
/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: postPath:
/primeapi/restapi/projectActuals/batch
- Batch Integrate Project Actuals Data with an External Data Source
- Method: postPath:
/primeapi/restapi/projectActuals/syncBatch
- Batch Update Project Actuals
- Method: putPath:
/primeapi/restapi/projectActuals/batch
- Create a Project Actual
- Method: postPath:
/primeapi/restapi/projectActuals
- Integrate Project Actuals Data with an External Data Source
- Method: postPath:
/primeapi/restapi/projectActuals/sync
- Update a Project Actual
- Method: putPath:
/primeapi/restapi/projectActuals
- View a Project Actual
- Method: getPath:
/primeapi/restapi/projectActuals/{id}
- View a Project Actual by Code
- Method: getPath:
/primeapi/restapi/projectActuals/code/{code}
- View a Project Actual by Code and Project
- Method: getPath:
/primeapi/restapi/projectActuals/project/{projectId}/code/{code}
- View Integrated Project Actuals
- Method: getPath:
/primeapi/restapi/projectActuals/externallySourced
- View Project Actual Configured Fields
- Method: getPath:
/primeapi/restapi/projectActuals/{id}/configuredFields
- View Project Actuals by Assigned Configured Field Value
- Method: getPath:
/primeapi/restapi/projectActuals/project/{id}/configuredField/{viewColumnName}/{value}
- View Project Actuals by Project
- Method: getPath:
/primeapi/restapi/projectActuals/project/{id}
Project Actuals Line Item
- Batch Integrate Project Actuals Line Items with an External Data Source
- Method: postPath:
/primeapi/restapi/projectActualsLineItem/syncBatch
- Create a Project Actuals Line Item
- Method: postPath:
/primeapi/restapi/projectActualsLineItem
- Create Project Actuals Line Items
- Method: postPath:
/primeapi/restapi/projectActualsLineItem/batch
- Delete a Project Actuals Line Item
- Method: deletePath:
/primeapi/restapi/projectActualsLineItem/{id}
- Delete Project Actuals Line Items
- Method: deletePath:
/primeapi/restapi/projectActualsLineItem/batch
- Integrate a Project Actuals Line Item with an External Data Source
- Method: postPath:
/primeapi/restapi/projectActualsLineItem/sync
- Update a Project Actuals Line Item
- Method: putPath:
/primeapi/restapi/projectActualsLineItem
- Update Project Actuals Line Items
- Method: putPath:
/primeapi/restapi/projectActualsLineItem/batch
- View a Project Actual Line Item
- Method: getPath:
/primeapi/restapi/projectActualsLineItem/{id}
- View a Project Actuals Line Item by Code
- Method: getPath:
/primeapi/restapi/projectActualsLineItem/code/{code}
- View a Project Actuals Line Item by Code and Project Actual ID
- Method: getPath:
/primeapi/restapi/projectActualsLineItem/projectActual/{actualId}/code/{code}
- View Integrated Project Actuals Line Items
- Method: getPath:
/primeapi/restapi/projectActualsLineItem/externallySourced
- View Project Actual Line Items by Project Actual
- Method: getPath:
/primeapi/restapi/projectActualsLineItem/projectActuals/{id}
Project Budget
Use the Project Budget services to view project budgets.
- Change a Project Budget Status
- Method: putPath:
/primeapi/restapi/projectBudget/project/{id}/changeBudgetStatus
- View a Project Budget
- Method: getPath:
/primeapi/restapi/projectBudget/{id}
- View a project budget by parent code
- Method: getPath:
/primeapi/restapi/projectBudget/byParent?workspaceCode={workspaceCode}&projectCode={projectCode}
- View a Project Budget by Project
- Method: getPath:
/primeapi/restapi/projectBudget/project/{id}
- View A Project Budget Status Transition History by Project
- Method: getPath:
/primeapi/restapi/projectBudget/project/{id}/statusTransitionHistory
- View Budget Transactions by Project
- Method: getPath:
/primeapi/restapi/projectBudget/project/{id}/transactions
- View Budget Transactions by Project Budget
- Method: getPath:
/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: postPath:
/primeapi/restapi/projectCollections/batch
- Batch Delete Project Collections
- Method: deletePath:
/primeapi/restapi/projectCollections/batch
- Batch Update Project Collections
- Method: putPath:
/primeapi/restapi/projectCollections/batch
- Create a Project Collection
- Method: postPath:
/primeapi/restapi/projectCollections
- Delete a Project Collection
- Method: deletePath:
/primeapi/restapi/projectCollections/{id}
- Update a Project Collection
- Method: putPath:
/primeapi/restapi/projectCollections
- View a Project Collection
- Method: getPath:
/primeapi/restapi/projectCollections/{id}
- View a Project Collection by Name
- Method: getPath:
/primeapi/restapi/projectCollections/name/{name}
- View a Project Collection by Workspace
- Method: getPath:
/primeapi/restapi/projectCollections/workspace/{workspaceId}
- View Projects in a Project Collection
- Method: getPath:
/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: postPath:
/primeapi/restapi/projectCompany/batch
- Batch Delete Project Companies
- Method: deletePath:
/primeapi/restapi/projectCompany/batch
- Batch Update Project Companies.
- Method: putPath:
/primeapi/restapi/projectCompany/batch
- Create a Project Company
- Method: postPath:
/primeapi/restapi/projectCompany
- Delete a Project Company by Work Manager Task
- Method: deletePath:
/primeapi/restapi/projectCompany/{id}
- Update a Project Company
- Method: putPath:
/primeapi/restapi/projectCompany
- View a Project Company
- Method: getPath:
/primeapi/restapi/projectCompany/{id}
- View Project Companies
- Method: getPath:
/primeapi/restapi/projectCompany/company/{companyName}/{postalCode}
- View Project Companies by Code
- Method: getPath:
/primeapi/restapi/projectCompany/workspace/{workspaceCode}/project/{projectCode}
- View Project Companies by Project
- Method: getPath:
/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: postPath:
/primeapi/restapi/projectDependency/batch
- Batch Delete Project Dependencies
- Method: deletePath:
/primeapi/restapi/projectDependency/batch
- Batch Update Project Dependencies
- Method: putPath:
/primeapi/restapi/projectDependency/batch
- Create a Project Dependency
- Method: postPath:
/primeapi/restapi/projectDependency
- Delete a Project Dependency
- Method: deletePath:
/primeapi/restapi/projectDependency/{id}
- Update a Project Dependency
- Method: putPath:
/primeapi/restapi/projectDependency
- View a Project Dependency
- Method: getPath:
/primeapi/restapi/projectDependency/{id}
- View Project Dependencies by Dependent Project
- Method: getPath:
/primeapi/restapi/projectDependency/depends/{id}
- View Project Dependencies by Supported Project
- Method: getPath:
/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: postPath:
/primeapi/restapi/projectRank/batch
- Batch Update Project Ranks
- Method: putPath:
/primeapi/restapi/projectRank/batch
- Create a Project Rank
- Method: postPath:
/primeapi/restapi/projectRank
- Update a Project Rank
- Method: putPath:
/primeapi/restapi/projectRank
- View a Project Rank
- Method: getPath:
/primeapi/restapi/projectRank/{id}
- View a Project Rank by Project
- Method: getPath:
/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: postPath:
/primeapi/restapi/projectResourceWorkRate/batch
- Batch Update Project Resource Work Rates
- Method: putPath:
/primeapi/restapi/projectResourceWorkRate/batch
- Create a Project Resource Work Rate
- Method: postPath:
/primeapi/restapi/projectResourceWorkRate
- Update a Project Resource Work Rate
- Method: putPath:
/primeapi/restapi/projectResourceWorkRate
- View a Project Resource Work Rate
- Method: getPath:
/primeapi/restapi/projectResourceWorkRate/{id}
- View a Project Resource Work Rate by Project and Resource
- Method: getPath:
/primeapi/restapi/projectResourceWorkRate/project/{projectId}/resource/{resourceId}
- View a Project Resource Work Rate by Project Resource
- Method: getPath:
/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: postPath:
/primeapi/restapi/projectRisk/batch
- Batch Delete Project Risks
- Method: deletePath:
/primeapi/restapi/projectRisk/batch
- Batch Update Project Risks
- Method: putPath:
/primeapi/restapi/projectRisk/batch
- Create a Project Risk
- Method: postPath:
/primeapi/restapi/projectRisk
- Delete a Project Risk
- Method: deletePath:
/primeapi/restapi/projectRisk/{id}
- Update a Project Risk
- Method: putPath:
/primeapi/restapi/projectRisk
- View a Project Risk
- Method: getPath:
/primeapi/restapi/projectRisk/{id}
- View a Project Risk by Configured Field Value
- Method: getPath:
/primeapi/restapi/projectRisk/project/{id}/configuredField/{viewColumnName}/{value}
- View a Project Risk by Project and Risk Code
- Method: getPath:
/primeapi/restapi/projectRisk/project/{id}/riskCode/{riskCode}
- View a risk by name
- Method: getPath:
/primeapi/restapi/projectRisk/name/{name}
- View Project Risk Configured Fields
- Method: getPath:
/primeapi/restapi/projectRisk/{id}/configuredFields
- View Project Risks by Project
- Method: getPath:
/primeapi/restapi/projectRisk/projectId/{id}
- View Risk Mitigation by Project Risk
- Method: getPath:
/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: getPath:
/primeapi/restapi/projectMeasureValue/{id}
- View a Project Measure Value by Measure
- Method: getPath:
/primeapi/restapi/projectMeasureValue/measure/{measureId}
- View a Project Measure Value by Project
- Method: getPath:
/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: getPath:
/primeapi/restapi/projectsAggregate/capitalPlan?id={id}
- View a Project Aggregate by Reference ID and Rollup Type
- Method: getPath:
/primeapi/restapi/projectsAggregate/reference/{refId}/rollupType/{rollupType}
- View a Project Aggregate by Rollup
- Method: getPath:
/primeapi/restapi/projectsAggregate/rollupId/{rollupId}
- View Project Aggregates by Project Portfolio
- Method: getPath:
/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: postPath:
/primeapi/restapi/reason/replicateObjectInWorkspaces/reason/{reasonId}/workspace/{workspaceId}
- Batch Create Reasons
- Method: postPath:
/primeapi/restapi/reason/batch
- Batch Delete Reasons
- Method: deletePath:
/primeapi/restapi/reason/batch
- Batch Update Reasons
- Method: putPath:
/primeapi/restapi/reason/batch
- Create a Reason
- Method: postPath:
/primeapi/restapi/reason
- Delete a Reason
- Method: deletePath:
/primeapi/restapi/reason/{id}
- Update a Reason
- Method: putPath:
/primeapi/restapi/reason
- View a Reason
- Method: getPath:
/primeapi/restapi/reason/{id}
- View Reason by Workspace and Name
- Method: getPath:
/primeapi/restapi/reason/workspace/{workspaceId}/name/{reasonName}
- View Reasons by Workspace
- Method: getPath:
/primeapi/restapi/reason/workspace/{id}
RelatedItems
Use the entity reference service to create, view, and delete references between application objects.
- Batch Create References
- Method: postPath:
/primeapi/restapi/entityReference/batch
- Batch Delete References
- Method: deletePath:
/primeapi/restapi/entityReference/batch
- Create a Reference
- Method: postPath:
/primeapi/restapi/entityReference/link
- Delete a Reference
- Method: deletePath:
/primeapi/restapi/entityReference/{id}
- Unlink a Reference
- Method: putPath:
/primeapi/restapi/entityReference/unLink
- View Linked References
- Method: getPath:
/primeapi/restapi/entityReference/linkedReferences?projectCode={projectCode}&workspaceCode={workspaceCode}&recordType={recordType}&recordCode={recordCode}&recordId={recordId}
- View Objects that Support References
- Method: getPath:
/primeapi/restapi/entityReference/linkableObjectReferences?projectCode={projectCode}&workspaceCode={workspaceCode}&recordType={recordType}&recordCode={recordCode}&recordId={recordId}&objectType={objectType}
- View References
- Method: getPath:
/primeapi/restapi/entityReference/{id}
- View the References of a Linked Object
- Method: getPath:
/primeapi/restapi/entityReference/linkedObjectReferences?projectCode={projectCode}&workspaceCode={workspaceCode}&recordType={recordType}&recordCode={recordCode}&recordId={recordId}&objectType={objectType}
- View the Related Items of a Reference
- Method: getPath:
/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: postPath:
/primeapi/restapi/relationship/batch
- Batch Delete Activity Relationships
- Method: deletePath:
/primeapi/restapi/relationship/batch
- Batch Update Activity Relationships
- Method: putPath:
/primeapi/restapi/relationship/batch
- Create an Activity Relationship
- Method: postPath:
/primeapi/restapi/relationship
- Delete an Activity Relationship
- Method: deletePath:
/primeapi/restapi/relationship/{id}
- Update an activity relationship
- Method: putPath:
/primeapi/restapi/relationship
- View all Relationships Associated to an Activity
- Method: getPath:
/primeapi/restapi/relationship/activityId/{id}
- View an Activity Relationship
- Method: getPath:
/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: postPath:
/primeapi/restapi/reportCycle/replicateObjectInWorkspaces/reportCycle/{reportCycleId}/workspace/{workspaceId}
- Batch Create Report Cycles
- Method: postPath:
/primeapi/restapi/reportCycle/batch
- Batch Delete Report Cycles
- Method: deletePath:
/primeapi/restapi/reportCycle/batch
- Batch Update Report Cycles
- Method: putPath:
/primeapi/restapi/reportCycle/batch
- Create a Report Cycle
- Method: postPath:
/primeapi/restapi/reportCycle
- Delete a Report Cycle
- Method: deletePath:
/primeapi/restapi/reportCycle/{id}
- Update a Report Cycle
- Method: putPath:
/primeapi/restapi/reportCycle
- View a Report Cycle
- Method: getPath:
/primeapi/restapi/reportCycle/{id}
- View a Report Cycle by Workspace
- Method: getPath:
/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: postPath:
/primeapi/restapi/resource/replicateObjectInWorkspaces/resource/{resourceId}/workspace/{workspaceId}
- Batch Create Resources or Roles
- Method: postPath:
/primeapi/restapi/resource/batch
- Batch Delete Resources or Roles
- Method: deletePath:
/primeapi/restapi/resource/batch
- Batch Delete Workspace Resources or Roles
- Method: deletePath:
/primeapi/restapi/resource/workspaceResource/batch
- Batch Integrate Resources with an External Data Source
- Method: postPath:
/primeapi/restapi/resource/syncBatch
- Batch Update Resources or Roles
- Method: putPath:
/primeapi/restapi/resource/batch
- Delete a Resource or Role
- Method: deletePath:
/primeapi/restapi/resource/{id}
- Delete a Workspace Resource or Role
- Method: deletePath:
/primeapi/restapi/resource/workspaceResource/{workspaceResourceId}
- Integrate a Resource with an External Data Source
- Method: postPath:
/primeapi/restapi/resource/sync
- View a resource by code
- Method: getPath:
/primeapi/restapi/resource/byItemCode?workspaceCode={workspaceCode}&resourceCode={resourceCode}
- View a Resource by Code and Type
- Method: getPath:
/primeapi/restapi/resource/code/{code}/type/{type}
- View a Resource by Resource Class
- Method: getPath:
/primeapi/restapi/resource?type={type}
- View a Resource or Role
- Method: getPath:
/primeapi/restapi/resource/{id}
- View All Child Resources and Roles by Resource Hierarchy
- Method: getPath:
/primeapi/restapi/resource/{id}/type/{type}/childrenHierarchy
- View all resources by parent code
- Method: getPath:
/primeapi/restapi/resource/byParent?workspaceCode={workspaceCode}
- View Integrated Resources
- Method: getPath:
/primeapi/restapi/resource/externallySourced
- View Resources and Roles by Workspace
- Method: getPath:
/primeapi/restapi/resource/workspace/{id}
- View Resources by Assigned Code Value
- Method: getPath:
/primeapi/restapi/resource/codeType/{typeId}/codeValue/{code}
- View Resources or Roles by Project
- Method: getPath:
/primeapi/restapi/resource/projectId/{id}
- View Workspace Resources or Roles by Workspace and Resource Class
- Method: getPath:
/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: postPath:
/primeapi/restapi/resourceDemand
- Create resource demands
- Method: postPath:
/primeapi/restapi/resourceDemand/batch
- Delete a resource demand
- Method: deletePath:
/primeapi/restapi/resourceDemand/{id}
- Delete resource demands
- Method: deletePath:
/primeapi/restapi/resourceDemand/batch
- Update a resource demand
- Method: putPath:
/primeapi/restapi/resourceDemand
- Update resource demands
- Method: putPath:
/primeapi/restapi/resourceDemand/batch
- View a resource demand
- Method: getPath:
/primeapi/restapi/resourceDemand/{id}
- View Resource Demands by Project ID
- Method: getPath:
/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: postPath:
/primeapi/restapi/resourceRoleAssignment/batch
- Batch Delete Resource Role Assignments
- Method: deletePath:
/primeapi/restapi/resourceRoleAssignment/batch
- Batch Update Resource Role Assignments
- Method: putPath:
/primeapi/restapi/resourceRoleAssignment/batch
- Create a Resource Role Assignment
- Method: postPath:
/primeapi/restapi/resourceRoleAssignment
- Delete a Resource Role Assignment
- Method: deletePath:
/primeapi/restapi/resourceRoleAssignment/{id}
- Update a Resource Role Assignment
- Method: putPath:
/primeapi/restapi/resourceRoleAssignment
- View a Resource Role Assignment
- Method: getPath:
/primeapi/restapi/resourceRoleAssignment/{id}
- View a Resource Role Assignment by Primary Flag
- Method: getPath:
/primeapi/restapi/resourceRoleAssignment/primaryFlag/{flag}
- View a Resource Role Assignment by Resource
- Method: getPath:
/primeapi/restapi/resourceRoleAssignment/resource/{id}
- View a Resource Role Assignment by Resource and Role
- Method: getPath:
/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: postPath:
/primeapi/restapi/resourceWorkRate/batch
- Batch Delete Maximum Work Units per Time Period
- Method: deletePath:
/primeapi/restapi/resourceWorkRate/batch
- Batch Update Maximum Work Units per Time Period
- Method: putPath:
/primeapi/restapi/resourceWorkRate/batch
- Create a Maximum Work Unit per Time Period
- Method: postPath:
/primeapi/restapi/resourceWorkRate
- Delete a Maximum Work Unit per Time Period
- Method: deletePath:
/primeapi/restapi/resourceWorkRate/{id}
- Update a Maximum Work Unit per Time Period
- Method: putPath:
/primeapi/restapi/resourceWorkRate
- View a Maximum Work Unit per Time Period
- Method: getPath:
/primeapi/restapi/resourceWorkRate/{id}
- View a Resource Work Rate
- Method: getPath:
/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: putPath:
/primeapi/restapi/rfi/accept/workspace/{workspaceCode}/project/{projectCode}/code/{rfiCode}/discussion/{discussionId}
- Batch Create an RFI
- Method: postPath:
/primeapi/restapi/rfi/batch
- Batch Delete an RFI
- Method: deletePath:
/primeapi/restapi/rfi/batch
- Batch Update an RFI
- Method: putPath:
/primeapi/restapi/rfi/batch
- Create an RFI
- Method: postPath:
/primeapi/restapi/rfi
- Delte an RFI
- Method: deletePath:
/primeapi/restapi/rfi/{id}
- Remove Users from RFI Notifications
- Method: deletePath:
/primeapi/restapi/rfi/delete/notificationUsers/workspace/{workspaceCode}/project/{projectCode}/code/{rfiCode}
- Updat an RFI
- Method: putPath:
/primeapi/restapi/rfi
- View an RFI
- Method: getPath:
/primeapi/restapi/rfi/{id}
- View an RFI by Code
- Method: getPath:
/primeapi/restapi/rfi/workspace/{workspaceCode}/project/{projCode}/code/{rfiCode}
- View an RFI by Parent
- Method: getPath:
/primeapi/restapi/rfi/workspace/{workspaceCode}/project/{projectCode}
- View RFI Correspondence
- Method: getPath:
/primeapi/restapi/rfi/correspondence/workspace/{workspaceCode}/project/{projCode}/code/{rfiCode}
- Withdraw RFI Acceptance
- Method: putPath:
/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: postPath:
/primeapi/restapi/riskImpact/batch
- Batch Delete Risk Impacts
- Method: deletePath:
/primeapi/restapi/riskImpact/batch
- Batch Update Risk Impacts
- Method: putPath:
/primeapi/restapi/riskImpact/batch
- Create a Risk Impact
- Method: postPath:
/primeapi/restapi/riskImpact
- Delete a Risk Impact
- Method: deletePath:
/primeapi/restapi/riskImpact/{id}
- Update a Risk Impact
- Method: putPath:
/primeapi/restapi/riskImpact
- View a Risk Impact
- Method: getPath:
/primeapi/restapi/riskImpact/{id}
- View Risk Impacts by Project Risk, Risk Score Type, and Risk Score Threshold
- Method: getPath:
/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: postPath:
/primeapi/restapi/riskMatrix/replicateObjectInWorkspaces/riskMatrix/{riskMatrixId}/workspace/{workspaceId}
- Batch Create Risk Matrixes
- Method: postPath:
/primeapi/restapi/riskMatrix/batch
- Batch Delete Risk Matrixes
- Method: deletePath:
/primeapi/restapi/riskMatrix/batch
- Batch Update Risk Matrixes
- Method: putPath:
/primeapi/restapi/riskMatrix/batch
- Create a Risk Matrix
- Method: postPath:
/primeapi/restapi/riskMatrix
- Delete a Risk Matrix
- Method: deletePath:
/primeapi/restapi/riskMatrix/{id}
- Update a Risk Matrix
- Method: putPath:
/primeapi/restapi/riskMatrix
- View a Risk Matrix
- Method: getPath:
/primeapi/restapi/riskMatrix/{id}
- View a Risk Matrix by Name
- Method: getPath:
/primeapi/restapi/riskMatrix/name/{name}
- View a risk matrix by name and workspace
- Method: getPath:
/primeapi/restapi/riskMatrix/resolveRiskMatrix/workspace/{workspaceId}/riskMatrix/{riskMatrix}
- View a Risk Matrix by Name and Workspace
- Method: getPath:
/primeapi/restapi/riskMatrix/workspace/{workspaceId}/name/{name}
- View Risk Matrixes by Workspace
- Method: getPath:
/primeapi/restapi/riskMatrix/workspace/{id}
- View Workspace Risk Matrix Template by Name
- Method: getPath:
/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: postPath:
/primeapi/restapi/riskMitigation/batch
- Batch Delete Risk Mitigations
- Method: deletePath:
/primeapi/restapi/riskMitigation/batch
- Batch Update Risk Mitigations
- Method: putPath:
/primeapi/restapi/riskMitigation/batch
- Create a Risk Mitigation
- Method: postPath:
/primeapi/restapi/riskMitigation
- Delete a Risk Mitigation
- Method: deletePath:
/primeapi/restapi/riskMitigation/{id}
- Update a Risk Mitigation
- Method: putPath:
/primeapi/restapi/riskMitigation
- View a Risk Mitigation
- Method: getPath:
/primeapi/restapi/riskMitigation/{id}
- View a Risk Mitigation by Code
- Method: getPath:
/primeapi/restapi/riskMitigation/code/{code}
- View a Risk Mitigation by Code and Project Risk
- Method: getPath:
/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: postPath:
/primeapi/restapi/riskScoreType/replicateObjectInWorkspaces/riskScoreType/{riskScoreTypeId}/workspace/{workspaceId}
- Batch Create Risk Score Types
- Method: postPath:
/primeapi/restapi/riskScoreType/batch
- Batch Update Risk Score Types
- Method: putPath:
/primeapi/restapi/riskScoreType/batch
- Create a Risk Score Type
- Method: postPath:
/primeapi/restapi/riskScoreType
- Delete a Risk Score Type
- Method: deletePath:
/primeapi/restapi/riskScoreType/{id}
- Update a Risk Score Type
- Method: putPath:
/primeapi/restapi/riskScoreType
- View a Risk Score Type
- Method: getPath:
/primeapi/restapi/riskScoreType/{id}
- View a Risk Score Type by Name
- Method: getPath:
/primeapi/restapi/riskScoreType/name/{name}
- View a Risk Score Type by Name and Project
- Method: getPath:
/primeapi/restapi/riskScoreType/name/{name}/project/{projectId}
- View a risk score type by name and workspace
- Method: getPath:
/primeapi/restapi/riskScoreType/resolveRiskScoreType/workspace/{workspaceId}/riskScoreType/{riskScoreTypeName}
- View a Risk Score Type by Name and Workspace
- Method: getPath:
/primeapi/restapi/riskScoreType/workspace/{workspaceId}/name/{name}
- View all Risk Score Types by Workspace
- Method: getPath:
/primeapi/restapi/riskScoreType/workspace/{id}
- View Score Types by Associated Threshold
- Method: getPath:
/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: postPath:
/primeapi/restapi/actualsTimePhasedData
- Create Scope Assignment Actuals Time Phased Data
- Method: postPath:
/primeapi/restapi/actualsTimePhasedData/batch
- Update Scope Assignment Actuals Time Phased Data
- Method: putPath:
/primeapi/restapi/actualsTimePhasedData/batch
- Update Scope Assignment Actuals Time Phased Data
- Method: putPath:
/primeapi/restapi/actualsTimePhasedData
- View Scope Assignment Actuals Time Phased Data
- Method: getPath:
/primeapi/restapi/actualsTimePhasedData/{id}
- View Scope Assignment Actuals Time Phased Data by Scope Assignment
- Method: getPath:
/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: getPath:
/primeapi/restapi/baselineTimePhasedData/{id}
- View Scope Assignment Baseline Time Phased Data by Scope Assignment
- Method: getPath:
/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: postPath:
/primeapi/restapi/installedTimePhasedData
- Create Scope Assignment Installed Time Phased Data
- Method: postPath:
/primeapi/restapi/installedTimePhasedData/batch
- Update a Scope Assignment Installed Time Phased Data
- Method: putPath:
/primeapi/restapi/installedTimePhasedData
- Update Scope Assignment Installed Time Phased Data
- Method: putPath:
/primeapi/restapi/installedTimePhasedData/batch
- View Scope Assignment Installed Time Phased Data
- Method: getPath:
/primeapi/restapi/installedTimePhasedData/{id}
- View Scope Assignment Installed Time Phased Data by Scope Assignment ID
- Method: getPath:
/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: postPath:
/primeapi/restapi/plannedTimePhasedData
- Create Scope Assignment Planned Time Phased Data.
- Method: postPath:
/primeapi/restapi/plannedTimePhasedData/batch
- Update a Scope Assignment Planned Time Phased Data Object
- Method: putPath:
/primeapi/restapi/plannedTimePhasedData
- Update Scope Assignment Planned Time Phased Data
- Method: putPath:
/primeapi/restapi/plannedTimePhasedData/batch
- View Scope Assignment Planned Time Phased Data
- Method: getPath:
/primeapi/restapi/plannedTimePhasedData/{id}
- View Scope Assignment Planned Time Phased Data by Scope Assignment ID
- Method: getPath:
/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: postPath:
/primeapi/restapi/scopeItem
- Delete a Scope Item
- Method: deletePath:
/primeapi/restapi/scopeItem/{id}
- Update a Scope Item
- Method: putPath:
/primeapi/restapi/scopeItem
- View a Scope Item
- Method: getPath:
/primeapi/restapi/scopeItem/{id}
- View a Scope Item by Code
- Method: getPath:
/primeapi/restapi/scopeItem/code/{code}
- View a Scope Item by Code
- Method: getPath:
/primeapi/restapi/scopeItem/project/{id}/code/{code}
- View a Scope Item by Name
- Method: getPath:
/primeapi/restapi/scopeItem/project/{id}/name/{name}
- View a Scope Item by PBS
- Method: getPath:
/primeapi/restapi/scopeItem/pbsId/{id}
- View Scope Item by Assigned Code Value
- Method: getPath:
/primeapi/restapi/scopeItem/project/{id}/codeType/{typeId}/codeValue/{code}
- View Scope Item Configured Fields
- Method: getPath:
/primeapi/restapi/scopeItem/{id}/configuredFields
- View Scope Items by Assigned Configured Field Value
- Method: getPath:
/primeapi/restapi/scopeItem/project/{id}/configuredField/{viewColumnName}/{value}
- View Scope Items by Project
- Method: getPath:
/primeapi/restapi/scopeItem/project/{id}
Scope Item Aggregate
Use the Scope Item Aggregates service to view scope item aggregates.
- View Scope Item Aggregates
- Method: getPath:
/primeapi/restapi/scopeItemAggregate/{id}
- View Scope Item Aggregates by Project
- Method: getPath:
/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: postPath:
/primeapi/restapi/scopeItemAssignment
- Delete a Scope Item Assignment
- Method: deletePath:
/primeapi/restapi/scopeItemAssignment/{id}
- Update a Scope Item Assignment
- Method: putPath:
/primeapi/restapi/scopeItemAssignment
- View a Scope Item Assignment
- Method: getPath:
/primeapi/restapi/scopeItemAssignment/{id}
- View a Scope Item Assignment by Code
- Method: getPath:
/primeapi/restapi/scopeItemAssignment/code/{code}
- View a Scope Item Assignments by Project
- Method: getPath:
/primeapi/restapi/scopeItemAssignment/project/{id}
- View a Scope Item Assignments by Scope Item
- Method: getPath:
/primeapi/restapi/scopeItemAssignment/scope/{id}
- View a Scope Item Assignments by Work Package
- Method: getPath:
/primeapi/restapi/scopeItemAssignment/workPackage/{id}
- View Scope Item Assignment Configured Fields
- Method: getPath:
/primeapi/restapi/scopeItemAssignment/{id}/configuredFields
- View Scope Item Assignments by Assigned Code Value
- Method: getPath:
/primeapi/restapi/scopeItemAssignment/project/{id}/codeType/{typeId}/codeValue/{code}
- View Scope Item Assignments by Assigned Configured Field Value
- Method: getPath:
/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: postPath:
/primeapi/restapi/scopeItemAssignmentActivity/batch
- Batch Delete Scope Item Assignment Activities
- Method: deletePath:
/primeapi/restapi/scopeItemAssignmentActivity/batch
- Batch Update Scope Item Assignment Activities
- Method: putPath:
/primeapi/restapi/scopeItemAssignmentActivity/batch
- Create a Scope Item Assignment Activity
- Method: postPath:
/primeapi/restapi/scopeItemAssignmentActivity
- Delete a Scope Item Assignment Activity
- Method: deletePath:
/primeapi/restapi/scopeItemAssignmentActivity/{id}
- Delete Scope Item Assignment Activities by Activity
- Method: deletePath:
/primeapi/restapi/scopeItemAssignmentActivity/activity/{id}
- Delete Scope Item Assignment Activities by Scope Item Assignment
- Method: deletePath:
/primeapi/restapi/scopeItemAssignmentActivity/scopeItemAssignment/{id}
- Update a Scope Item Assignment Activity
- Method: putPath:
/primeapi/restapi/scopeItemAssignmentActivity
- View a Scope Item Assignment Activity
- Method: getPath:
/primeapi/restapi/scopeItemAssignmentActivity/{id}
- View all Scope Item Assignment Activities by Activity
- Method: getPath:
/primeapi/restapi/scopeItemAssignmentActivity/activity/{id}
- View all Scope Item Assignment Activities by Scope Item Assignment
- Method: getPath:
/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: getPath:
/primeapi/restapi/scopeItemAssignmentAggregate/{id}
- View Scope Item Assignment Aggregates by Reference
- Method: getPath:
/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: postPath:
/primeapi/restapi/scopeItemAssignmentChangeRequest/batch
- Batch Update Scope Item Assignment Change Requests
- Method: putPath:
/primeapi/restapi/scopeItemAssignmentChangeRequest/batch
- Create a Scope Item Assignment Change Request
- Method: postPath:
/primeapi/restapi/scopeItemAssignmentChangeRequest
- Update a Scope Item Assignment Change Request
- Method: putPath:
/primeapi/restapi/scopeItemAssignmentChangeRequest
- View a Scope Item Assignment Change Request
- Method: getPath:
/primeapi/restapi/scopeItemAssignmentChangeRequest/{id}
- View a Scope Item Assignment Change Request by Scope Item Assignment
- Method: getPath:
/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: postPath:
/primeapi/restapi/scopeItemAssignmentTransferRequest
- Create Scope Item Assignment Transfer Requests
- Method: postPath:
/primeapi/restapi/scopeItemAssignmentTransferRequest/batch
- Update a Scope Item Assignment Transfer Request
- Method: putPath:
/primeapi/restapi/scopeItemAssignmentTransferRequest
- Update Scope Item Assignment Transfer Requests
- Method: putPath:
/primeapi/restapi/scopeItemAssignmentTransferRequest/batch
- View a Scope Item Assignment Transfer Request
- Method: getPath:
/primeapi/restapi/scopeItemAssignmentTransferRequest/{id}
- View a Scope Item Assignment Transfer Request by Scope Item Assignment ID
- Method: getPath:
/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: putPath:
/primeapi/restapi/scopeItemChangeRequest/batch
- Create a Scope Item Change Request
- Method: postPath:
/primeapi/restapi/scopeItemChangeRequest
- Update a Scope Item Change Request
- Method: putPath:
/primeapi/restapi/scopeItemChangeRequest
- View a Scope Item Change Request
- Method: getPath:
/primeapi/restapi/scopeItemChangeRequest/scopeItem/{scopeItemId}
- View a Scope Item Change Request
- Method: getPath:
/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: postPath:
/primeapi/restapi/segment/project/{id}
- Create a Workspace Segment
- Method: postPath:
/primeapi/restapi/segment/workspace/{id}
- Update a Project Segment
- Method: putPath:
/primeapi/restapi/segment/project
- Update a Workspace Segment
- Method: putPath:
/primeapi/restapi/segment/workspace
- View a Workspace Segment
- Method: getPath:
/primeapi/restapi/segment/{id}?type={type}
- View workspace segments by workspace or project
- Method: getPath:
/primeapi/restapi/segment/project/{id}
- View workspace segments by workspace or project
- Method: getPath:
/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: postPath:
/primeapi/restapi/specSection/batch
- Batch Delete Spec Sections
- Method: deletePath:
/primeapi/restapi/specSection/batch
- Batch Update Spec Sections
- Method: putPath:
/primeapi/restapi/specSection/batch
- Create a Spec Section
- Method: postPath:
/primeapi/restapi/specSection
- Delete a Spec Section
- Method: deletePath:
/primeapi/restapi/specSection/{id}
- Update a Spec Section.
- Method: putPath:
/primeapi/restapi/specSection
- View a Spec Section
- Method: getPath:
/primeapi/restapi/specSection/{id}
- View a Spec Section by Code
- Method: getPath:
/primeapi/restapi/specSection/code/{code}
- View a Spec Section by Project Code and Workspace Code
- Method: getPath:
/primeapi/restapi/specSection/workspace/{worksaceCode}/project/{projectCode}
Strategy
Use the Strategy service you to create, view, update, and delete strategies.
- Batch Create Strategies
- Method: postPath:
/primeapi/restapi/strategy/batch
- Batch Deletes Strategies
- Method: deletePath:
/primeapi/restapi/strategy/batch
- Batch Update Strategies
- Method: putPath:
/primeapi/restapi/strategy/batch
- Create a Strategy
- Method: postPath:
/primeapi/restapi/strategy
- Create a Strategy Configured Field
- Method: postPath:
/primeapi/restapi/strategy/configuredField
- Delete a Strategy
- Method: deletePath:
/primeapi/restapi/strategy/{id}
- Update a Strategy
- Method: putPath:
/primeapi/restapi/strategy
- View a Configured Field
- Method: getPath:
/primeapi/restapi/strategy/configuredField/{columnId}
- View a Strategy
- Method: getPath:
/primeapi/restapi/strategy/{id}
- View Strategies Measure Values by Workspace
- Method: getPath:
/primeapi/restapi/strategy/measureValue/workspace/{workspaceId}
- View Strategy Configured Fields by Workspace
- Method: getPath:
/primeapi/restapi/strategy/configuredField/workspace/{id}
- View Strategy Measure Values by Strategy
- Method: getPath:
/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: postPath:
/primeapi/restapi/strategyMeasure/batch
- Batch Delete Strategy Measures
- Method: deletePath:
/primeapi/restapi/strategyMeasure/batch
- Create a Strategy Measure
- Method: postPath:
/primeapi/restapi/strategyMeasure
- Delete a Strategy Measure
- Method: deletePath:
/primeapi/restapi/strategyMeasure/{id}
- View a Strategy Measure
- Method: getPath:
/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: postPath:
/primeapi/restapi/strategyMeasureManualValue/batch
- Batch Update Strategy Measure Manual Values
- Method: putPath:
/primeapi/restapi/strategyMeasureManualValue/batch
- Create a Strategy Measure Manual Value
- Method: postPath:
/primeapi/restapi/strategyMeasureManualValue
- Updates a Strategy Measure Manual Value
- Method: putPath:
/primeapi/restapi/strategyMeasureManualValue
- View a Strategy Measure Manual Value
- Method: getPath:
/primeapi/restapi/strategyMeasureManualValue/{id}
- View Strategy Measure Manual Value Date Sequences
- Method: getPath:
/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: getPath:
/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: postPath:
/primeapi/restapi/strategyProject/batch
- Batch Delete Strategy Projects
- Method: deletePath:
/primeapi/restapi/strategyProject/batch
- Batch Update Strategy Projects
- Method: putPath:
/primeapi/restapi/strategyProject/batch
- Create a Strategy Project
- Method: postPath:
/primeapi/restapi/strategyProject
- Delete a Strategy Project
- Method: deletePath:
/primeapi/restapi/strategyProject/{id}
- Delete a Strategy Project by Strategy and Project
- Method: deletePath:
/primeapi/restapi/strategyProject/strategy/{strategyId}/project/{projectId}
- Update a Strategy Project
- Method: putPath:
/primeapi/restapi/strategyProject
- View a Strategy Project
- Method: getPath:
/primeapi/restapi/strategyProject/{id}
- View Strategy Projects by Strategy
- Method: getPath:
/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: postPath:
/primeapi/restapi/strategyType/replicateObjectInWorkspaces/strategyType/{strategyTypeId}/workspace/{workspaceId}
- Batch Create Strategy Types
- Method: postPath:
/primeapi/restapi/strategyType/batch
- Batch Delete Strategy Types
- Method: deletePath:
/primeapi/restapi/strategyType/batch
- Batch Update Strategy Types
- Method: putPath:
/primeapi/restapi/strategyType/batch
- Create a Strategy Type
- Method: postPath:
/primeapi/restapi/strategyType
- Delete a Strategy Type
- Method: deletePath:
/primeapi/restapi/strategyType/{id}
- Update a Strategy Type
- Method: putPath:
/primeapi/restapi/strategyType
- View a Strategy Type
- Method: getPath:
/primeapi/restapi/strategyType/{id}
- View Strategy Types by Workspace
- Method: getPath:
/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: postPath:
/primeapi/restapi/submittal/batch
- Batch Delete Submittals
- Method: deletePath:
/primeapi/restapi/submittal/batch
- Batch Update Submittals
- Method: putPath:
/primeapi/restapi/submittal/batch
- Create a Submittal
- Method: postPath:
/primeapi/restapi/submittal
- Delete a Submittal
- Method: deletePath:
/primeapi/restapi/submittal/{id}
- Update a Submittal
- Method: putPath:
/primeapi/restapi/submittal
- View a Submittal
- Method: getPath:
/primeapi/restapi/submittal/{id}
- View a Submittal by Code
- Method: getPath:
/primeapi/restapi/submittal/code/{code}
- View a Submittal by Project Code and Workspace Code
- Method: getPath:
/primeapi/restapi/submittal/workspace/{worksaceCode}/project/{projectCode}
- View Submittal History by Code
- Method: getPath:
/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: postPath:
/primeapi/restapi/threshold/batch
- Batch Update Thresholds
- Method: putPath:
/primeapi/restapi/threshold/batch
- Create a Threshold
- Method: postPath:
/primeapi/restapi/threshold
- Update a Threshold
- Method: putPath:
/primeapi/restapi/threshold
- View a Threshold
- Method: getPath:
/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: postPath:
/primeapi/restapi/unitsOfMeasure/replicateObjectInWorkspaces/unitsOfMeasure/{unitsOfMeasureId}/workspace/{workspaceId}
- Batch Create Units of Measures
- Method: postPath:
/primeapi/restapi/unitsOfMeasure/batch
- Batch Delete Units of Measures
- Method: deletePath:
/primeapi/restapi/unitsOfMeasure/batch
- Batch Update Units of Measures
- Method: putPath:
/primeapi/restapi/unitsOfMeasure/batch
- Create a Unit of Measure
- Method: postPath:
/primeapi/restapi/unitsOfMeasure
- Delete a Unit of Measure
- Method: deletePath:
/primeapi/restapi/unitsOfMeasure/{id}
- Update a Unit of Measure
- Method: putPath:
/primeapi/restapi/unitsOfMeasure
- View a Unit of Measure
- Method: getPath:
/primeapi/restapi/unitsOfMeasure/{id}
- View a Unit of Measure by Code
- Method: getPath:
/primeapi/restapi/unitsOfMeasure/code/{code}
- View a Unit of Measure by Name
- Method: getPath:
/primeapi/restapi/unitsOfMeasure/name/{name}/workspace/{id}
- View a Unit of Measure by Workspace
- Method: getPath:
/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: putPath:
/primeapi/restapi/userPreferences/batch
- Update a User's Preferences
- Method: putPath:
/primeapi/restapi/userPreferences
- View All User Preferences
- Method: getPath:
/primeapi/restapi/userPreferences/allUserSettings
- View User Preferences
- Method: getPath:
/primeapi/restapi/userPreferences/{id}
- View User Preferences by Setting Name
- Method: getPath:
/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: postPath:
/primeapi/restapi/wbs
- Delete a WBS
- Method: deletePath:
/primeapi/restapi/wbs/{id}
- Delete WBS Children
- Method: deletePath:
/primeapi/restapi/wbs/children/{id}
- Update a WBS
- Method: putPath:
/primeapi/restapi/wbs
- View a WBS
- Method: getPath:
/primeapi/restapi/wbs/{id}
- View a WBS by Code
- Method: getPath:
/primeapi/restapi/wbs/project/{id}/code/{code}
- View a WBS by Name
- Method: getPath:
/primeapi/restapi/wbs/project/{id}/name/{name}
- View a WBS by Project
- Method: getPath:
/primeapi/restapi/wbs/project/{id}
- View a WBS by WBS Code, Parent WBS Code, and Project ID
- Method: getPath:
/primeapi/restapi/wbs/wbsCode/{code}/parentWbsCode/{parentCode}/projectId/{projectId}
- View All Children in a WBS Hierarchy
- Method: getPath:
/primeapi/restapi/wbs/{id}/childrenHierarchy
- View WBS by Assigned Code Value
- Method: getPath:
/primeapi/restapi/wbs/project/{id}/codeType/{typeId}/codeValue/{code}
- View WBS by Assigned Configured Field Value
- Method: getPath:
/primeapi/restapi/wbs/project/{id}/configuredField/{viewColumnName}/{value}
- View WBS Children
- Method: getPath:
/primeapi/restapi/wbs/children/{id}
- View WBS Configured Fields
- Method: getPath:
/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: postPath:
/primeapi/restapi/workPackage
- Delete a Work Package
- Method: deletePath:
/primeapi/restapi/workPackage/{id}
- Update a Work Package
- Method: putPath:
/primeapi/restapi/workPackage
- View a Work Package
- Method: getPath:
/primeapi/restapi/workPackage/{id}
- View a Work Package by Assigned Code Value
- Method: getPath:
/primeapi/restapi/workPackage/project/{id}/codeType/{typeId}/codeValue/{code}
- View a Work Package by Project and Code
- Method: getPath:
/primeapi/restapi/workPackage/project/{id}/code/{code}
- View a Work Package by Project and Name
- Method: getPath:
/primeapi/restapi/workPackage/project/{id}/name/{name}
- View a Work Package by WBS
- Method: getPath:
/primeapi/restapi/workPackage/wbs/{id}
- View Work Package Configured Fields
- Method: getPath:
/primeapi/restapi/workPackage/{id}/configuredFields
- View Work Packages by Assigned Configured Field Value
- Method: getPath:
/primeapi/restapi/workPackage/project/{id}/configuredField/{viewColumnName}/{value}
- View Work Packages by Project
- Method: getPath:
/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: postPath:
/primeapi/restapi/workManagerTask/batch
- Batch Delete Work Manager Tasks
- Method: deletePath:
/primeapi/restapi/workManagerTask/batch
- Batch Update Work Manager Tasks
- Method: putPath:
/primeapi/restapi/workManagerTask/batch
- Create a Work Manager Task
- Method: postPath:
/primeapi/restapi/workManagerTask
- Delete a Work Manager Task
- Method: deletePath:
/primeapi/restapi/workManagerTask/{id}
- Update a Work Manager Task
- Method: putPath:
/primeapi/restapi/workManagerTask
- View a Work Manager Task
- Method: getPath:
/primeapi/restapi/workManagerTask/{id}
- View a Work Manager Task by Activity
- Method: getPath:
/primeapi/restapi/workManagerTask/project/{projectId}/activity/{activityId}
- View a Work Manager Task by Code
- Method: getPath:
/primeapi/restapi/workManagerTask/code/{code}
- View a Work Manager Task by Project
- Method: getPath:
/primeapi/restapi/workManagerTask/project/{id}
- View Work Manager Tasks by Configured Field Values
- Method: getPath:
/primeapi/restapi/workManagerTask/project/{id}/configuredField/{viewColumnName}/{value}
- View Work Manger Task Activities by Assigned Code Value.
- Method: getPath:
/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: postPath:
/primeapi/restapi/workManagerTaskCommitment
- Update a Work Manager Task Commitment
- Method: putPath:
/primeapi/restapi/workManagerTaskCommitment
- View a Work Manager Task Commitment
- Method: getPath:
/primeapi/restapi/workManagerTaskCommitment/{id}
- View a Work Manager Task Commitment by Associated User
- Method: getPath:
/primeapi/restapi/workManagerTaskCommitment/user/{id}
- View a Work Manager Task Commitment by Reason
- Method: getPath:
/primeapi/restapi/workManagerTaskCommitment/reason/{id}
- View Last Work Manager Task Commitment
- Method: getPath:
/primeapi/restapi/workManagerTaskCommitment/lastCommitment/task/{id}
- View Work Manager Task Commitment by Task
- Method: getPath:
/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: getPath:
/primeapi/restapi/workManagerTaskDependency/project/{projectId}
- Returns the Work Manager Task Dependencies for the specified Task ID
- Method: getPath:
/primeapi/restapi/workManagerTaskDependency/task/{tasksId}
- Returns the Work Manager Task Dependencies for the specified Workspace and Project Codes.
- Method: getPath:
/primeapi/restapi/workManagerTaskDependency/workspace/{workspaceCode}/project/{projectCode}
- Returns the Work Manager Task Dependencies for the specified Workspace,Project and Task Codes
- Method: getPath:
/primeapi/restapi/workManagerTaskDependency/workspace/{workspaceCode}/project/{projectCode}/task/{tasksCode}
- Returns the Work Manager Task Dependency for the specified Work Manager Task Dependency ID
- Method: getPath:
/primeapi/restapi/workManagerTaskDependency/{id}
WorkPackage Aggregate
- View a Work Package Aggregate by Reference
- Method: getPath:
/primeapi/restapi/workPackageAggregate/reference/{id}?rollupType={rollupType}
- View a Work Package Aggregate by Rollup
- Method: getPath:
/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: postPath:
/primeapi/restapi/workPackageChangeRequest/batch
- Batch Delete Work Package Change Requests
- Method: deletePath:
/primeapi/restapi/workPackageChangeRequest/batch
- Batch Update Work Package Change Requests
- Method: putPath:
/primeapi/restapi/workPackageChangeRequest/batch
- Create a Work Package Change Request
- Method: postPath:
/primeapi/restapi/workPackageChangeRequest
- Delete a Work Package Change Request
- Method: deletePath:
/primeapi/restapi/workPackageChangeRequest/{id}
- Update a Work Package Change Request
- Method: putPath:
/primeapi/restapi/workPackageChangeRequest
- View a Work Package Change Request
- Method: getPath:
/primeapi/restapi/workPackageChangeRequest/{id}
Workspace
Use the Workspace service to create, update, delete, and view workspaces.
- Batch Create Workspaces
- Method: postPath:
/primeapi/restapi/workspace/batch
- Batch Delete Workspaces
- Method: deletePath:
/primeapi/restapi/workspace/batch
- Batch Update Workspaces
- Method: putPath:
/primeapi/restapi/workspace/batch
- Create a Workspace
- Method: postPath:
/primeapi/restapi/workspace
- Delete a Workspace
- Method: deletePath:
/primeapi/restapi/workspace/{id}
- Update a Workspace
- Method: putPath:
/primeapi/restapi/workspace
- View a Workspace
- Method: getPath:
/primeapi/restapi/workspace/{id}
- View a Workspace by Code
- Method: getPath:
/primeapi/restapi/workspace/code/{code}
- View a Workspace Image
- Method: getPath:
/primeapi/restapi/workspace/image/{id}
- View All Child Workspaces in a Workspace Hierarchy
- Method: getPath:
/primeapi/restapi/workspace/{id}/childrenHierarchy
- View all Workspaces
- Method: getPath:
/primeapi/restapi/workspace
- View Child Workspaces
- Method: getPath:
/primeapi/restapi/workspace/children/{id}
- View the Root Workspace
- Method: getPath:
/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: postPath:
/primeapi/restapi/workspaceResourceRate/batch
- Batch Delete Workspace Resource Rates
- Method: deletePath:
/primeapi/restapi/workspaceResourceRate/batch
- Batch Update Workspace Resource Rates
- Method: putPath:
/primeapi/restapi/workspaceResourceRate/batch
- Create a Workspace Resource Rate
- Method: postPath:
/primeapi/restapi/workspaceResourceRate
- Delete a Workspace Resource Rate
- Method: deletePath:
/primeapi/restapi/workspaceResourceRate/{id}
- Update a Workspace Resource Rate
- Method: putPath:
/primeapi/restapi/workspaceResourceRate
- View a Workspace Resource Rate
- Method: getPath:
/primeapi/restapi/workspaceResourceRate/{id}
- View a Workspace Resource Rate by Resource
- Method: getPath:
/primeapi/restapi/workspaceResourceRate/resource/{id}