Oracle Primavera Cloud REST API

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. There are several background services that may initiate jobs, such as scheduler, leveler, risk analysis, and measures. Completed scheduling, leveling, and measure jobs generate job logs that include additional details about the service.

Apply Activity Uncertainty: Method: post
Path: /api/restapi/action/applyActivityUncertainity/run
Create a Budget Plan Snapshot: Method: post
Path: /api/restapi/action/capitalPlanSnapshot
Create a Project Baseline: Method: post
Path: /api/restapi/action/baseline
Create a Project Snapshot: Method: post
Path: /api/restapi/action/projectSnapshot
Create Resource Demand from Schedule: Method: post
Path: /api/restapi/action/resourceDemand/fetchAssignment
Delete a Budget Plan Snapshot: Method: delete
Path: /api/restapi/action/capitalPlan/snapshot/{snapshotId}
Delete a Project Snapshot: Method: delete
Path: /api/restapi/action/project/snapshot/{snapshotId}
Delete Project Baseline: Method: delete
Path: /api/restapi/action/baseline/{projectBaselineId}
Delete Project Baseline By Name: Method: delete
Path: /api/restapi/action/baseline
Download a Report: Method: get
Path: /api/restapi/action/reportResult/{jobId}
Import a WBS from Project: Method: post
Path: /api/restapi/action/importWBS
Perform Project Resource Leveling: Method: post
Path: /api/restapi/action/level
Run a Report: Method: post
Path: /api/restapi/action/report/run
Run Risk Analysis: Method: post
Path: /api/restapi/action/runRiskAnalysis
Schedule a Project: Method: post
Path: /api/restapi/action/scheduleProject
Schedule Portfolio Measure Computation: Method: post
Path: /api/restapi/action/computeMeasure
Schedule Strategy Measure Computation: Method: post
Path: /api/restapi/action/computeStrategyMeasure
Synchronize Resource Availabilities and Rates for Workspace Hierarchy: Method: post
Path: /api/restapi/action/resource/workRateSync
Synchronize Role Availabilities and Rates for Workspace Hierarchy: Method: post
Path: /api/restapi/action/role/workRateSync
Update Project Baseline: Method: put
Path: /api/restapi/action/baseline
View Job Status: Method: get
Path: /api/restapi/action/jobStatus/{jobId}
View Project Baseline: Method: get
Path: /api/restapi/action/baseline/{projectBaselineId}
View Project Baseline By Name: Method: get
Path: /api/restapi/action/baseline
View Project Baseline By Parent Code: Method: get
Path: /api/restapi/action/baseline/parent
View Project Baseline By Project: Method: get
Path: /api/restapi/action/baseline/project/{id}
View Snapshots by Budget Plan ID: Method: get
Path: /api/restapi/action/snapshot/capitalPlan/{capitalPlanId}
View Snapshots by Project ID: Method: get
Path: /api/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. Update Keys : 'activityId'

Batch Create Activities: Method: post
Path: /api/restapi/activity/batch
Batch Delete Activities: Method: delete
Path: /api/restapi/activity/batch
Batch Sync Activities: Method: post
Path: /api/restapi/activity/syncBatch
Batch Update Activities: Method: put
Path: /api/restapi/activity/batch
Create an Activity: Method: post
Path: /api/restapi/activity
Delete an Activity: Method: delete
Path: /api/restapi/activity/{activityId}
Update an Activity: Method: put
Path: /api/restapi/activity
View Activities by Baseline: Method: get
Path: /api/restapi/activity/baseline/data
View Activities by Code: Method: get
Path: /api/restapi/activity/code/{activityCode}
View Activities by Configured Field: Method: get
Path: /api/restapi/activity/project/{projectId}/configuredField/{viewColumnName}/{value}
View Activities by Project, Code Type, and Code Value: Method: get
Path: /api/restapi/activity/project/{projectId}/codeType/{codeTypeId}/codeValue/{codeValueCode}
View Activities by WBS: Method: get
Path: /api/restapi/activity/wbsId/{wbsId}
View all Activities by Parent: Method: get
Path: /api/restapi/activity/byParent
View all Activities by Project: Method: get
Path: /api/restapi/activity/project/{projectId}
View an Activity: Method: get
Path: /api/restapi/activity/{activityId}
View an Activity by Code and Parent Codes: Method: get
Path: /api/restapi/activity/byItemCode
View an Activity by Project and Activity Code: Method: get
Path: /api/restapi/activity/project/{projectId}/code/{activityCode}
View User Baseline Preferences: Method: get
Path: /api/restapi/activity/userBaselinePreferences

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 Work Package Activity Aggregate by Portfolio: Method: get
Path: /api/restapi/activityAggregate/workPackage/portfolio
View a Work Package Activity Aggregate by Projects: Method: get
Path: /api/restapi/activityAggregate/workPackage/project
View an Activity Aggregate by Project: Method: get
Path: /api/restapi/activityAggregate/projects

Activity Favorite

Use the Activity Favorite service to create, view 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. Update Keys : 'activityFavoriteId'

Batch Create Activity Favorites: Method: post
Path: /api/restapi/activityFavorite/batch
Batch Delete Activity Favorites: Method: delete
Path: /api/restapi/activityFavorite/batch
Create an Activity Favorite: Method: post
Path: /api/restapi/activityFavorite
Delete an Activity Favorite: Method: delete
Path: /api/restapi/activityFavorite/{activityFavoriteId}
View Activity Favorites by User: Method: get
Path: /api/restapi/activityFavorite/userId/{applicationUser}
View All Activity Favorites by Parent: Method: get
Path: /api/restapi/activityFavorite/parentCode
View an Activity Favorite: Method: get
Path: /api/restapi/activityFavorite/{activityFavoriteId}
View an Activity Favorite by Code and Parent Codes: Method: get
Path: /api/restapi/activityFavorite/itemCode
View an Activity Favorite by User and Activity: Method: get
Path: /api/restapi/activityFavorite/userId/{applicationUser}/activityId/{activity}

Activity Relationship

Use the Activity Relationship service to create, view, update, and delete activity 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. Update Keys : 'relationshipId'

Batch Create Activity Relationships: Method: post
Path: /api/restapi/relationship/batch
Batch Delete Activity Relationships: Method: delete
Path: /api/restapi/relationship/batch
Batch Sync Activity Relationships: Method: post
Path: /api/restapi/relationship/syncBatch
Batch Update Activity Relationships: Method: put
Path: /api/restapi/relationship/batch
Create an Activity Relationship: Method: post
Path: /api/restapi/relationship
Delete an Activity Relationship: Method: delete
Path: /api/restapi/relationship/{relationshipId}
Update an Activity Relationship: Method: put
Path: /api/restapi/relationship
View all Activity Relationships Associated to an Activity: Method: get
Path: /api/restapi/relationship/activityId/{activityId}
View all Activity Relationships by Parent: Method: get
Path: /api/restapi/relationship/activityRelationshipCode
View all Project Relationships by Parent: Method: get
Path: /api/restapi/relationship/projectRelationshipCode
View an Activity Relationship: Method: get
Path: /api/restapi/relationship/{relationshipId}
View Relationships by Baseline: Method: get
Path: /api/restapi/relationship/baseline/data

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. Update Keys : 'activityRiskId'

Batch Create Activity Risks: Method: post
Path: /api/restapi/activityRisk/batch
Batch Delete Activity Risks: Method: delete
Path: /api/restapi/activityRisk/batch
Batch Sync Activity Risks: Method: post
Path: /api/restapi/activityRisk/syncBatch
Batch Update Activity Risks: Method: put
Path: /api/restapi/activityRisk/batch
Create an Activity Risk: Method: post
Path: /api/restapi/activityRisk
Delete an Activity Risk: Method: delete
Path: /api/restapi/activityRisk/{activityRiskId}
Update an Activity Risk: Method: put
Path: /api/restapi/activityRisk
View all Activity Risks by Activity: Method: get
Path: /api/restapi/activityRisk/activity/{activityId}
View all Activity Risks by Project ID: Method: get
Path: /api/restapi/activityRisk/project/{projectId}
View all Activity Risks by Project Risk ID: Method: get
Path: /api/restapi/activityRisk/projectRisk/{projectRiskId}
View an Activity Risk: Method: get
Path: /api/restapi/activityRisk/{activityRiskId}

Application User Group

Use the Application User Group service to create, view, update, and delete user groups. Update Keys : 'applicationUserGroupId'

Batch Create User Groups: Method: post
Path: /api/restapi/applicationUserGroup/batch
Batch Sync Application User Groups: Method: post
Path: /api/restapi/applicationUserGroup/syncBatch
Batch Update User Groups: Method: put
Path: /api/restapi/applicationUserGroup/batch
Create a User Group: Method: post
Path: /api/restapi/applicationUserGroup
Update a User Group: Method: put
Path: /api/restapi/applicationUserGroup
View a User Group: Method: get
Path: /api/restapi/applicationUserGroup/{applicationUserGroupId}
View a User Group by Group Name: Method: get
Path: /api/restapi/applicationUserGroup/groupName/{groupName}

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. Update Keys : 'assignmentId'

Batch Create Assignments: Method: post
Path: /api/restapi/assignment/batch
Batch Delete Assignments: Method: delete
Path: /api/restapi/assignment/batch
Batch Sync Assignments: Method: post
Path: /api/restapi/assignment/syncBatch
Batch Update Assignments: Method: put
Path: /api/restapi/assignment/batch
Create an Assignment: Method: post
Path: /api/restapi/assignment
Delete an Assignment: Method: delete
Path: /api/restapi/assignment/{assignmentId}
Update an Assignment: Method: put
Path: /api/restapi/assignment
View all Assignments by Project: Method: get
Path: /api/restapi/assignment/project/{projectId}
View an Assignment: Method: get
Path: /api/restapi/assignment/{assignmentId}
View an Assignment by Activity and Code: Method: get
Path: /api/restapi/assignment/activity/{activityId}/code/{assignmentCode}
View Assignments by Activity: Method: get
Path: /api/restapi/assignment/activityId/{activityId}
View Assignments by Baseline: Method: get
Path: /api/restapi/assignment/baseline/data
View Assignments by Code: Method: get
Path: /api/restapi/assignment/code/{assignmentCode}
View Assignments by Configured Field Values: Method: get
Path: /api/restapi/assignment/project/{projectId}/configuredField/{viewColumnName}/{value}
View Assignments by Resource: Method: get
Path: /api/restapi/assignment/resource/{resourceId}
View Assignments by Resource Code: Method: get
Path: /api/restapi/assignment/resource/code/{resourceCode}

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. Update Keys : 'assignmentFavoriteId'

Batch Create Assignment Favorites: Method: post
Path: /api/restapi/assignmentFavorite/batch
Batch Delete Assignment Favorites: Method: delete
Path: /api/restapi/assignmentFavorite/batch
Create an Assignment Favorite: Method: post
Path: /api/restapi/assignmentFavorite
Delete an Assignment Favorite: Method: delete
Path: /api/restapi/assignmentFavorite/{assignmentFavoriteId}
View all Assignment Favorites Assigned to a User: Method: get
Path: /api/restapi/assignmentFavorite/userId/{applicationUser}
View All Assignment Favorites by Parent: Method: get
Path: /api/restapi/assignmentFavorite/parentCode
View an Assignment Favorite: Method: get
Path: /api/restapi/assignmentFavorite/{assignmentFavoriteId}
View an Assignment Favorite by Code and Parent Codes: Method: get
Path: /api/restapi/assignmentFavorite/itemCode
View an Assignment Favorite by User and Assignment: Method: get
Path: /api/restapi/assignmentFavorite/userId/{applicationUser}/assignmentId/{assignmentId}

Baseline Category

The operations from the Baseline Category category.

Batch Create Baseline Categories: Method: post
Path: /api/restapi/baselineCategory/batch
Batch Delete Baseline Categories: Method: delete
Path: /api/restapi/baselineCategory/batch
Batch Sync Baseline Categories: Method: post
Path: /api/restapi/baselineCategory/syncBatch
Batch Update Baseline Categories: Method: put
Path: /api/restapi/baselineCategory/batch
Create a Baseline Category: Method: post
Path: /api/restapi/baselineCategory
Delete a Baseline Category: Method: delete
Path: /api/restapi/baselineCategory/{baselineCategoryId}
Update a Baseline Category: Method: put
Path: /api/restapi/baselineCategory
View a Baseline Category: Method: get
Path: /api/restapi/baselineCategory/{baselineCategoryId}
View all Baseline Categories by Code: Method: get
Path: /api/restapi/baselineCategory/name/{baselineCategoryName}
View all Baseline Categories by Workspace ID: Method: get
Path: /api/restapi/baselineCategory/workspace/{workspaceId}

Budget Planning Scenario

Use the Budget Planning Scenario service to create, view, update, and delete program risks. Update Keys : 'scenarioId'

Batch Create Budget Planning Scenarios: Method: post
Path: /api/restapi/budgetPlanningScenario/batch
Batch Delete Budget Planning Scenarios: Method: delete
Path: /api/restapi/budgetPlanningScenario/batch
Batch Sync Budget Planning Scenarios: Method: post
Path: /api/restapi/budgetPlanningScenario/syncBatch
Batch Update Budget Planning Scenario Status: Method: post
Path: /api/restapi/budgetPlanningScenario/batchUpdateScenarioStatus
Batch Update Budget Planning Scenarios: Method: put
Path: /api/restapi/budgetPlanningScenario/batch
Create a Budget Planning Scenario: Method: post
Path: /api/restapi/budgetPlanningScenario
Delete a Budget Planning Scenario: Method: delete
Path: /api/restapi/budgetPlanningScenario/{scenarioId}
Manage Fund Allocation of Budget Planning Scenario: Method: put
Path: /api/restapi/budgetPlanningScenario/manageFundAllocation
Manage Fund Allocation of Budget Planning Scenarios: Method: put
Path: /api/restapi/budgetPlanningScenario/manageFundAllocation/batch
Refresh a Budget Planning Scenario: Method: put
Path: /api/restapi/budgetPlanningScenario/refresh/{scenarioId}
Update a Budget Planning Scenario: Method: put
Path: /api/restapi/budgetPlanningScenario
Update Budget Planning Scenario Status: Method: post
Path: /api/restapi/budgetPlanningScenario/updateScenarioStatus
View a Budget Planning Scenario: Method: get
Path: /api/restapi/budgetPlanningScenario/{scenarioId}
View a Budget Planning Scenario Fund Data: Method: get
Path: /api/restapi/budgetPlanningScenario/fund/{scenarioId}
View all Budget Plan Projects: Method: get
Path: /api/restapi/budgetPlanningScenario/planProjects/scenario/{scenarioId}
View All Budget Planning Scenarios by Portfolio and Plan Period: Method: get
Path: /api/restapi/budgetPlanningScenario/byPortfolioId
View All Budget Planning Scenarios by Portfolio Name and Plan Period: Method: get
Path: /api/restapi/budgetPlanningScenario/byPortfolioName
View All Budget Planning Scenarios Fund Data by Portfolio and Plan Period: Method: get
Path: /api/restapi/budgetPlanningScenario/fund/byPortfolioId
View All Budget Planning Scenarios Fund Data by Portfolio Name and Plan Period: Method: get
Path: /api/restapi/budgetPlanningScenario/fund/byPortfolioName
View all Fund Plan Projects: Method: get
Path: /api/restapi/budgetPlanningScenario/fund/planProjects/scenario/{scenarioId}

CBS

The operations from the CBS category.

Batch Integrate CBSs with an External Data Source: Method: post
Path: /api/restapi/cbs/project/syncBatch
Create a Project CBS: Method: post
Path: /api/restapi/cbs/createprojectCBS
Create a Project Costing Source: Method: post
Path: /api/restapi/cbs/project/{projectId}/projectCostingSource
Create a Workspace CBS: Method: post
Path: /api/restapi/cbs/createworkspaceCBS
Delete a Project CBS Code by Project CBS ID: Method: delete
Path: /api/restapi/cbs/project/{cbsSheetCodeId}
Delete a Workspace CBS Code by Workspace CBS ID: Method: delete
Path: /api/restapi/cbs/workspace/{cbsTemplateCodeId}
Import a Workspace CBS to a Program: Method: put
Path: /api/restapi/cbs/import/workspaceCbs/{cbsTemplateCodeId}/program/{programId}
Integrate a CBS with an External Data Source: Method: post
Path: /api/restapi/cbs/project/sync
Push Down all Workspace CBS Code to Project: Method: put
Path: /api/restapi/cbs/import/workspace/{workspaceCode}/project/{projectCode}
Reset all Program CBS Template Codes: Method: delete
Path: /api/restapi/cbs/resetProgramCBS/program/{programId}
Reset all Project Cost Sheet Code: Method: delete
Path: /api/restapi/cbs/resetCostSheet/workspace/{workspaceCode}/project/{projectCode}
Reset Workspace CBS Template: Method: delete
Path: /api/restapi/cbs/resetCBSTemplate/workspace/{workspaceCode}
Update a Project CBS Code by CBS: Method: put
Path: /api/restapi/cbs/project
Update a Project Costing Source: Method: put
Path: /api/restapi/cbs/project/{projectId}/projectCostingSource
Update a Workspace CBS Code: Method: put
Path: /api/restapi/cbs/workspace
View a CBS Sheet Code by Project and CBS Code: Method: get
Path: /api/restapi/cbs/project/{projectId}/code/{cbsCode}
View a CBS Sheet Total Cost Row by Project: Method: get
Path: /api/restapi/cbs/project/{projectId}/totalCost
View a Project CBS: Method: get
Path: /api/restapi/cbs/projectCbs/{cbsSheetCodeId}
View a Project Costing Source: Method: get
Path: /api/restapi/cbs/project/{projectId}/projectCostingSource
View a Workspace CBS: Method: get
Path: /api/restapi/cbs/workspaceCbs/{cbsTemplateCodeId}
View a workspace CBS by code: Method: get
Path: /api/restapi/cbs/workspace/byItemCode
View a Workspace Total Item by ID and Template Type: Method: get
Path: /api/restapi/cbs/aggregate/reference/{referenceObjectId}
View all Project CBS Assigned to a Project: Method: get
Path: /api/restapi/cbs/project/{projectId}
View all project CBSs by parent code: Method: get
Path: /api/restapi/cbs/project/byParent
View all Workspace CBS Codes Assigned to a Workspace: Method: get
Path: /api/restapi/cbs/workspace/{workspaceId}
View all workspace CBSs by parent code: Method: get
Path: /api/restapi/cbs/workspace/byParent
View Integrated CBSs: Method: get
Path: /api/restapi/cbs/project/externallySourced

CBS Segment

Use the Cost Breakdown Structure Segment service to create, view, update, and delete CBS segments for workspaces and projects. CBS Segments determine the hierarchical depth of a CBS and designate how CBS codes are concatenated. Update Keys : 'segmentId'

Batch Sync Project Segments: Method: post
Path: /api/restapi/segment/projectSegment/syncBatch
Batch Sync Workspace Segments: Method: post
Path: /api/restapi/segment/workspaceSegment/syncBatch
Create a Project CBS Segment: Method: post
Path: /api/restapi/segment/projectSegment
Create a Workspace CBS Segment: Method: post
Path: /api/restapi/segment/workspaceSegment
Create Multiple Project CBS Segments: Method: post
Path: /api/restapi/segment/projectSegment/batch
Update a Project CBS Segment: Method: put
Path: /api/restapi/segment/project
Update a Workspace CBS Segment: Method: put
Path: /api/restapi/segment/workspace
Update Multiple Project CBS Segments: Method: put
Path: /api/restapi/segment/project/batch
Update Multiple Workspace CBS Segments: Method: put
Path: /api/restapi/segment/workspace/batch
View a Project CBS Segment: Method: get
Path: /api/restapi/segment/projectSegment/{cbsSheetSegmentId}
View a Workspace CBS Segment: Method: get
Path: /api/restapi/segment/workspaceSegment/{cbsTemplateSegmentId}
View all Project CBS Segments by Project ID: Method: get
Path: /api/restapi/segment/project/{projectId}
View all Workspace CBS Segments by Workspace ID: Method: get
Path: /api/restapi/segment/workspace/{workspaceId}

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. Update Keys : 'calendarId'

Batch Create Calendars: Method: post
Path: /api/restapi/calendar/batch
Batch Delete Calendars: Method: delete
Path: /api/restapi/calendar/batch
Batch Sync Calendars: Method: post
Path: /api/restapi/calendar/syncBatch
Batch Update Calendars: Method: put
Path: /api/restapi/calendar/batch
Create a Calendar: Method: post
Path: /api/restapi/calendar
Delete a Calendar: Method: delete
Path: /api/restapi/calendar/{calendarId}
Promote Project Calendars To Workspace: Method: put
Path: /api/restapi/calendar/promote
Update a Calendar: Method: put
Path: /api/restapi/calendar
View a Calendar: Method: get
Path: /api/restapi/calendar/{calendarId}
View a Calendar by Code and Workspace ID: Method: get
Path: /api/restapi/calendar/workspace/{workspaceId}/code/{calendarCode}
View a Workspace Calendar by Code and Parent Code: Method: get
Path: /api/restapi/calendar/byItemCode
View all Workspace Calendars by Parent: Method: get
Path: /api/restapi/calendar/byParent
View Calendar Exceptions: Method: get
Path: /api/restapi/calendar/exception/{calendarId}
View Calendars by Code: Method: get
Path: /api/restapi/calendar/code/{calendarCode}
View Calendars by Project: Method: get
Path: /api/restapi/calendar/project/{projectId}
View Calendars by Project and Workspace Code: Method: get
Path: /api/restapi/calendar/project/code
View Calendars by Workspace: Method: get
Path: /api/restapi/calendar/workspace/{workspaceId}
View Default Workspace Calendar: Method: get
Path: /api/restapi/calendar/defaultCalendar/workspace/{workspaceId}

Calendar Exception

The operations from the Calendar Exception category.

Batch Delete Calendar Exceptions: Method: delete
Path: /api/restapi/calendarExceptions/batch
Delete a Calendar Exception: Method: delete
Path: /api/restapi/calendarExceptions/{calendarExceptionId}

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. Update Keys : 'capitalPortfolioMemberId'

Batch Create Capital Portfolio Members: Method: post
Path: /api/restapi/capitalPortfolioMember/batch
Create a Capital Portfolio Member: Method: post
Path: /api/restapi/capitalPortfolioMember
View a Capital Portfolio Member: Method: get
Path: /api/restapi/capitalPortfolioMember/{capitalPortfolioMemberId}
View all Capital Portfolio Members by Parent: Method: get
Path: /api/restapi/capitalPortfolioMember/parentCode
View all Capital Portfolio Members by Portfolio ID: Method: get
Path: /api/restapi/capitalPortfolioMember/portfolio/{capitalPortfolioId}

Change Request

Use the Change Requests service to create, view, update, and delete change requests. Change requests track changes to work packages and scope assignments after an original project baseline is set.

Batch Create Change Requests: Method: post
Path: /api/restapi/changeRequest/batch
Batch Delete Change Requests: Method: delete
Path: /api/restapi/changeRequest/batch
Batch Sync Change Requests: Method: post
Path: /api/restapi/changeRequest/syncBatch
Batch Update Change Requests: Method: put
Path: /api/restapi/changeRequest/batch
Create a Change Request: Method: post
Path: /api/restapi/changeRequest
Delete a Change Request: Method: delete
Path: /api/restapi/changeRequest/{changeRequestId}
Update a Change Request: Method: put
Path: /api/restapi/changeRequest
View a Change Request: Method: get
Path: /api/restapi/changeRequest/{changeRequestId}
View a Change Request by Code: Method: get
Path: /api/restapi/changeRequest/itemCode
View All Change Requests by Parent: Method: get
Path: /api/restapi/changeRequest/parentCode

Code Type

Use the Code Type service to create, view, update, and delete code types. Codes are user-defined data used to organize 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. Update Keys : 'codeTypeId'

Batch Create Code Types: Method: post
Path: /api/restapi/codeType/batch
Batch Delete Code Types: Method: delete
Path: /api/restapi/codeType/batch
Batch Sync Code Types: Method: post
Path: /api/restapi/codeType/syncBatch
Batch Update Code Types: Method: put
Path: /api/restapi/codeType/batch
Create a Code Type: Method: post
Path: /api/restapi/codeType
Delete a Code Type: Method: delete
Path: /api/restapi/codeType/{codeTypeId}
Delete Code Type Assignments: Method: delete
Path: /api/restapi/codeType/{codeTypeId}/assignments
Promote Project Code Types To Workspace: Method: put
Path: /api/restapi/codeType/promote
Update a Code Type: Method: put
Path: /api/restapi/codeType
View a Code Type: Method: get
Path: /api/restapi/codeType/{codeTypeId}
View a Code Type by Code: Method: get
Path: /api/restapi/codeType/byItemCode
View Code Types by Associated Object: Method: get
Path: /api/restapi/codeType
View Code Types by Project: Method: get
Path: /api/restapi/codeType/project/{projectId}
View Code Types by Project and Workspace: Method: get
Path: /api/restapi/codeType/project
View Code Types by Workspace: Method: get
Path: /api/restapi/codeType/workspace/{workspaceId}
View Code Types by Workspace Code: Method: get
Path: /api/restapi/codeType/byParent

Code Value

Use the Code Value service to create, view, update, and delete code values. Codes are user-defined data used to organize and filter objects. Codes are defined as combinations of types and values. For example, you can define a "Priority" code type that contains text values, and create a set of potential values for the type for use across projects.

Batch Create Code Values: Method: post
Path: /api/restapi/codeValue/batch
Batch Delete Code Values: Method: delete
Path: /api/restapi/codeValue/batch
Batch Sync Code Values: Method: post
Path: /api/restapi/codeValue/syncBatch
Batch Update Code Values: Method: put
Path: /api/restapi/codeValue/batch
Create a Code Value: Method: post
Path: /api/restapi/codeValue
Delete a Code Value: Method: delete
Path: /api/restapi/codeValue/{codeValueId}
Delete Code Value Assignments from an Object: Method: delete
Path: /api/restapi/codeValue/objectType/{codeValueObjectType}
Update a Code Value: Method: put
Path: /api/restapi/codeValue
View a Code Value: Method: get
Path: /api/restapi/codeValue/{codeValueId}
View All Child Code Values in a Code Value Hierarchy: Method: get
Path: /api/restapi/codeValue/{codeValueId}/childrenHierarchy
View All Code Values by Code: Method: get
Path: /api/restapi/codeValue/byItemCode
View All Code Values by Parent: Method: get
Path: /api/restapi/codeValue/byParent
View Code Values by Code Type: Method: get
Path: /api/restapi/codeValue/codeType/{codeTypeId}
View Code Values by Code Type and Code: Method: get
Path: /api/restapi/codeValue/code/{codeValueCode}/codeType/{codeTypeId}
View Code Values by Code Type Name: Method: get
Path: /api/restapi/codeValue/codeType/name/{codeTypeName}
View Code Values by Project, Workspace and CodeType: Method: get
Path: /api/restapi/codeValue/projectCodeTypes

Company

The Company service enables you to create, view, update, or delete companies. Multiple companies can work together using the same environment. For example, if the owning company hires a design firm and a subcontractor to work on the same project, the owning company can add both of the other companies as partner companies. The owning company can also add users to the partner companies and give them access to workspaces, projects, and portfolios. Two types of companies are supported: Owning Company: Represents the company with ownership of the application instance. Owning companies cannot be deleted. Partner Company: A separate entity from the owning company that needs access to the application. Partner companies represent vendors, resellers, subcontractors, owners, suppliers, and other consultants.

Batch Integrate Companies with an External Data Source: Method: post
Path: /api/restapi/company/syncBatch
Delete a Company: Method: delete
Path: /api/restapi/company/{companyId}
Integrate a Company with an External Data Source: Method: post
Path: /api/restapi/company/sync
View a Company: Method: get
Path: /api/restapi/company/{companyId}
View a Company by Name: Method: get
Path: /api/restapi/company/name/{companyName}
View all Companies: Method: get
Path: /api/restapi/company/list
View Companies by Tenant Owner: Method: get
Path: /api/restapi/company/tenantOwner
View Integrated Companies: Method: get
Path: /api/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. Update Keys : 'columnDefinitionId'

Assign or Promote a Configured Field: Method: post
Path: /api/restapi/configuredField/replicateObjectInWorkspaces/configuredField/{columnDefinitionId}/workspace/{workspaceId}
Batch Delete Configured Fields: Method: delete
Path: /api/restapi/configuredField/batch
Create a Configured Field: Method: post
Path: /api/restapi/configuredField
Delete a Configured Field: Method: delete
Path: /api/restapi/configuredField/{columnDefinitionId}
Update a Configured Field: Method: put
Path: /api/restapi/configuredField
View a Configured Field: Method: get
Path: /api/restapi/configuredField/{columnDefinitionId}
View all Configured Fields under a Workspace: Method: get
Path: /api/restapi/configuredField/workspace/{workspaceId}
View File Configured Fields under a Workspace: Method: get
Path: /api/restapi/configuredField/document/workspace/{workspaceId}
View Idea Configured Fields under a Workspace: Method: get
Path: /api/restapi/configuredField/idea/workspace/{workspaceId}
View Program Configured Fields under a Workspace: Method: get
Path: /api/restapi/configuredField/program/workspace/{workspaceId}
View Strategy Configured Fields under a Workspace: Method: get
Path: /api/restapi/configuredField/strategy/workspace/{workspaceId}

Constraint

Use the constraint service to create, view, update, and delete constraints. Update Keys : 'constraintId'

Batch Create Constraints: Method: post
Path: /api/restapi/constraint/batch
Batch Delete Constraints: Method: delete
Path: /api/restapi/constraint/batch
Batch Sync Constraints: Method: post
Path: /api/restapi/constraint/syncBatch
Batch Update Constraints: Method: put
Path: /api/restapi/constraint/batch
Create a Constraint: Method: post
Path: /api/restapi/constraint
Delete a Constraint: Method: delete
Path: /api/restapi/constraint/{constraintId}
Update a Constraint: Method: put
Path: /api/restapi/constraint
View a Constraint: Method: get
Path: /api/restapi/constraint/{constraintId}
View a Constraint by Workspace and Project Code: Method: get
Path: /api/restapi/constraint/workspace/{workspaceCode}/project/{projectCode}
View all Constraints by Code: Method: get
Path: /api/restapi/constraint/code/{constraintCode}
View all Constraints by Project: Method: get
Path: /api/restapi/constraint/project/{projectId}
View all Constraints by Work Manager Task: Method: get
Path: /api/restapi/constraint/workManagerTask/{workManagerTaskId}

Cost Category

Use the Cost Category service to create, view, update, and delete cost categories. Cost categories define types used to organize costs. Update Keys : 'costCategoryId'

Batch Create Cost Categories: Method: post
Path: /api/restapi/costCategory/batch
Batch Delete Cost Categories: Method: delete
Path: /api/restapi/costCategory/batch
Batch Sync Cost Categories: Method: post
Path: /api/restapi/costCategory/syncBatch
Batch Update Cost Categories: Method: put
Path: /api/restapi/costCategory/batch
Create a Cost Category: Method: post
Path: /api/restapi/costCategory
Delete a Cost Category: Method: delete
Path: /api/restapi/costCategory/{costCategoryId}
Update a Cost Category: Method: put
Path: /api/restapi/costCategory
View a Cost Category: Method: get
Path: /api/restapi/costCategory/{costCategoryId}
View a Cost Category by Name: Method: get
Path: /api/restapi/costCategory/name/{costCategoryName}
View a Cost Category by Name and Workspace: Method: get
Path: /api/restapi/costCategory/workspace/{workspaceId}/name/{costCategoryName}
View a Cost Category Row: Method: get
Path: /api/restapi/costCategory/categoryRow/costCategory/{costCategoryId}
View a Cost Category Row by Cost Sheet: Method: get
Path: /api/restapi/costCategory/categoryRow/costSheet/{costSheetId}
View Cost Categories by Cost Category Type: Method: get
Path: /api/restapi/costCategory
View Cost Categories by Workspace: Method: get
Path: /api/restapi/costCategory/workspace/{workspaceId}
View Cost Category Rows by CBS Sheet Code: Method: get
Path: /api/restapi/costCategory/categoryRow/sheetCode/{cbsSheetCodeId}
View Cost Category Rows by Cost Category Name and Project: Method: get
Path: /api/restapi/costCategory/categoryRow/costCategory/{costCategoryName}/project/{projectId}

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. Update Keys : 'currencyId'

Create a Currency: Method: post
Path: /api/restapi/currency
Delete a Currency: Method: delete
Path: /api/restapi/currency/{currencyId}
Update a Currency: Method: put
Path: /api/restapi/currency
View a Currency: Method: get
Path: /api/restapi/currency/{currencyId}
View a Currency by Code: Method: get
Path: /api/restapi/currency/code/{currencyCode}
View a Currency by Name: Method: get
Path: /api/restapi/currency/name/{currencyName}
View a Currency Seed: Method: get
Path: /api/restapi/currency/currencySeed
View Currencies by Workspace: Method: get
Path: /api/restapi/currency/workspace/{workspaceId}

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. Update Keys : 'curveId'

Batch Create Curves: Method: post
Path: /api/restapi/curve/batch
Batch Delete Curves: Method: delete
Path: /api/restapi/curve/batch
Batch Sync Curves: Method: post
Path: /api/restapi/curve/syncBatch
Batch Update Curves: Method: put
Path: /api/restapi/curve/batch
Create a Curve: Method: post
Path: /api/restapi/curve
Delete a Curve: Method: delete
Path: /api/restapi/curve/{curveId}
Update a Curve: Method: put
Path: /api/restapi/curve
View a Curve: Method: get
Path: /api/restapi/curve/{curveId}
View a Curve by Name: Method: get
Path: /api/restapi/curve/name/{curveName}
View a Curve by Workspace: Method: get
Path: /api/restapi/curve/workspace/{workspaceId}
View a Curve by Workspace and Name: Method: get
Path: /api/restapi/curve/workspace/{workspaceId}/name/{curveName}

Custom Log Item

The Custom Log service enables you to send requests related to custom logs. Update Keys : 'customLogTypeObjectId, customLogItemCode' or 'customLogItemId' or 'workspaceCode, projectCode, customLogTypeObjectName, customLogItemCode' or 'projectId, customLogTypeObjectName, customLogItemCode'

Batch Create Custom Log Items: Method: post
Path: /api/restapi/customLogItem/batch
Batch Delete Custom Log Items: Method: delete
Path: /api/restapi/customLogItem/batch
Batch Sync Custom Log Items: Method: post
Path: /api/restapi/customLogItem/syncBatch
Batch Update Custom Log Items: Method: put
Path: /api/restapi/customLogItem/batch
Create a Custom Log Item: Method: post
Path: /api/restapi/customLogItem
Delete a Custom Log Item: Method: delete
Path: /api/restapi/customLogItem/{customLogItemId}
Update a Custom Log Item: Method: put
Path: /api/restapi/customLogItem
View a Custom Log Item: Method: get
Path: /api/restapi/customLogItem/{customLogItemId}
View a Custom Log Item by Parent: Method: get
Path: /api/restapi/customLogItem/workspace/{workspaceCode}/project/{projectCode}/customLogObject/{customLogTypeObjectName}
View a Custom Log Item by Parent and Code: Method: get
Path: /api/restapi/customLogItem/workspace/{workspaceCode}/project/{projectCode}/customLogObject/{customLogTypeObjectName}/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, customLogObjectName' or 'customLogTypeObjectId' or 'workspaceCode, scope, scopeCode, customLogObjectName'

Assign a Custom Log Type Object to Workspaces, Programs and Projects: Method: post
Path: /api/restapi/customLogTypeObject/assign
Assign Permission Profiles To User: Method: post
Path: /api/restapi/customLogTypeObject/assignUser
Batch Assign Custom Log Type Objects to a Workspaces, Programs and Projects: Method: post
Path: /api/restapi/customLogTypeObject/assign/batch
Batch Create Custom Log Type Objects: Method: post
Path: /api/restapi/customLogTypeObject/batch
Batch Delete Custom Log Type Object Code Types: Method: delete
Path: /api/restapi/customLogTypeObject/codeTypes/workspace/{workspaceCode}/scope/{scopeCode}/name/{customLogTypeObjectName}
Batch Delete Custom Log Type Object Configured Fields: Method: delete
Path: /api/restapi/customLogTypeObject/udfs/workspace/{workspaceCode}/scope/{scopeCode}/name/{customLogTypeObjectName}
Batch Delete Custom Log Type Objects: Method: delete
Path: /api/restapi/customLogTypeObject/batch
Batch Sync Custom Log Type Objects: Method: post
Path: /api/restapi/customLogTypeObject/syncBatch
Batch Unassign Custom Log Type Objects to a Workspaces, Programs and Projects: Method: delete
Path: /api/restapi/customLogTypeObject/unassign/batch
Batch Update Custom Log Type Objects: Method: put
Path: /api/restapi/customLogTypeObject/batch
Create a Custom Log Type Object: Method: post
Path: /api/restapi/customLogTypeObject
Delete a Custom Log Type Object: Method: delete
Path: /api/restapi/customLogTypeObject/{customLogTypeObjectId}
Unassign a Custom Log Type Object to Workspaces, Programs and Projects: Method: delete
Path: /api/restapi/customLogTypeObject/unassign
Update a Custom Log Type Object: Method: put
Path: /api/restapi/customLogTypeObject
View a Custom Log Type Object: Method: get
Path: /api/restapi/customLogTypeObject/{customLogTypeObjectId}
View a Custom Log Type Object by Name and Workspace or Program or Project Codes: Method: get
Path: /api/restapi/customLogTypeObject/byItemCode
View Custom Log Type Objects by Program: Method: get
Path: /api/restapi/customLogTypeObject/program/{programId}
View Custom Log Type Objects by Project: Method: get
Path: /api/restapi/customLogTypeObject/project/{projectId}
View Custom Log Type Objects by Workspace: Method: get
Path: /api/restapi/customLogTypeObject/workspace/{workspaceId}
View Custom Log Type Objects by Workspace or Program or Project Codes: Method: get
Path: /api/restapi/customLogTypeObject/byParent
View User Permission Sets for Custom Log Type Object: Method: get
Path: /api/restapi/customLogTypeObject/permissionSets

Dictionary

The operations from the Dictionary category.

Manage the Shared Data of Dictionary Objects: Method: post
Path: /api/restapi/dictionary/manageSharedData

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'

Assign Permission Profiles To User: Method: post
Path: /api/restapi/document/assignUser
Batch Delete Files: Method: delete
Path: /api/restapi/document/batch/files
Batch Delete Folders: Method: delete
Path: /api/restapi/document/batch/folders
Batch Rescan Files: Method: post
Path: /api/restapi/document/file/rescan/batch
Check in a File: Method: post
Path: /api/restapi/document/file/{id}/checkin
Check out a File: Method: get
Path: /api/restapi/document/file/{id}/checkout
Copy a Template to a Folder: Method: post
Path: /api/restapi/document/templateCopy/sourceTemplate/{id}/targetFolder/{folderId}
Create a Folder: Method: post
Path: /api/restapi/document/folder
Create Zip for the List of Files under a Scope: Method: post
Path: /api/restapi/document/file/zip/files
Delete a File: Method: delete
Path: /api/restapi/document/file/{id}
Delete a Folder: Method: delete
Path: /api/restapi/document/folder/{id}
Download a File: Method: get
Path: /api/restapi/document/file/{id}/download
Download the Zip File: Method: get
Path: /api/restapi/document/file/zip/zipRequest/{zipRequestId}
Link a File to another Object: Method: get
Path: /api/restapi/document/{id}/scope/{scope}/scopeId/{scopeId}/linkDocument
Rescan a File: Method: post
Path: /api/restapi/document/file/rescan
Unlink a File: Method: get
Path: /api/restapi/document/{id}/scope/{scope}/scopeId/{scopeId}/unlinkDocument
Update a File: Method: put
Path: /api/restapi/document/file
Update a Folder: Method: put
Path: /api/restapi/document/folder
Upload a File: Method: post
Path: /api/restapi/document/uploadFile/parent/{folderId}/fileName/{fileName}
View a File: Method: get
Path: /api/restapi/document/file/{id}
View a Folder: Method: get
Path: /api/restapi/document/folder/{id}
View a Folder by Name and Template: Method: get
Path: /api/restapi/document/{name}/folderTemplate/{id}
View all File Versions: Method: get
Path: /api/restapi/document/file/{id}/version
View all Files and Folders under a Folder: Method: get
Path: /api/restapi/document/folder/{id}/allChildren
View all Files and Folders under a Template: Method: get
Path: /api/restapi/document/template/{id}/allChildren
View all Files of a Folder: Method: get
Path: /api/restapi/document/folder/{id}/files
View all Files of a Template: Method: get
Path: /api/restapi/document/template/{id}/files
View all Folders of a Template: Method: get
Path: /api/restapi/document/template/{id}/childFolders
View all Folders under a Folder: Method: get
Path: /api/restapi/document/folder/{id}/childFolders
View all References of a File: Method: get
Path: /api/restapi/document/file/{id}/references
View Annotations of a Version of a File: Method: get
Path: /api/restapi/document/file/{id}/version/{version}/annotations
View the ID for a File or Folder by Path: Method: get
Path: /api/restapi/document/workspace/{workspaceCode}/{type}/search
View the Root Folder of a Portfolio: Method: get
Path: /api/restapi/document/portfolio/{portfolioId}/root
View the Root Folder of a Project: Method: get
Path: /api/restapi/document/project/{projectId}/root
View the Root Folder of a Template: Method: get
Path: /api/restapi/document/template/{id}/root
View the Zip Request Details by Zip Request ID: Method: get
Path: /api/restapi/document/file/zip/status/zipRequest/{zipRequestId}
View User Permission Sets for File: Method: get
Path: /api/restapi/document/permissionSets

Document Folder Structure Template

Use the Document Folder Structure Template Service to create, view, update, or delete document folder structure templates. Update Keys : 'documentFolderStructureTemplateId'

Batch Create Document Folder Structure Templates: Method: post
Path: /api/restapi/folderTemplate/batch
Batch Delete Document Folder Structure Templates: Method: delete
Path: /api/restapi/folderTemplate/batch
Batch Sync Document Folder Structure Templates: Method: post
Path: /api/restapi/folderTemplate/syncBatch
Batch Update Document Folder Structure Templates: Method: put
Path: /api/restapi/folderTemplate/batch
Create a Document Folder Structure Template: Method: post
Path: /api/restapi/folderTemplate
Delete a Document Folder Structure Template: Method: delete
Path: /api/restapi/folderTemplate/{documentFolderStructureTemplateId}
Update a Document Folder Structure Template: Method: put
Path: /api/restapi/folderTemplate
View a Document Folder Structure Template: Method: get
Path: /api/restapi/folderTemplate/{documentFolderStructureTemplateId}
View all Document Folder Structure Templates by Workspace: Method: get
Path: /api/restapi/folderTemplate/workspace/{workspaceId}
View Document Folder Structure Templates by Name: Method: get
Path: /api/restapi/folderTemplate/name/{templateName}

Evaluation Categories

Use the Evaluation Category service to view evaluation matrix, and update evaluation rank. Update Keys : 'evaluationMatrixId'

Update an Evaluation Rank: Method: put
Path: /api/restapi/evaluationMatrix/evaluationRank
View Evaluation Matrix by Workspace: Method: get
Path: /api/restapi/evaluationMatrix/workspace/{workspaceId}

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. Update Keys : 'exchangeRateId'

Create an Exchange Rate: Method: post
Path: /api/restapi/exchangeRate
View an Exchange Rate: Method: get
Path: /api/restapi/exchangeRate/{exchangeRateId}
View Exchange Rates by Currency: Method: get
Path: /api/restapi/exchangeRate/currency/{currencyId}

Fund Actual

The operations from the Fund Actual category.

Batch Create Fund Actuals: Method: post
Path: /api/restapi/fundActual/batch
Batch Delete Fund Actuals: Method: delete
Path: /api/restapi/fundActual/batch
Batch Sync Fund Actuals: Method: post
Path: /api/restapi/fundActual/syncBatch
Batch Update Fund Actuals: Method: put
Path: /api/restapi/fundActual/batch
Create an Fund Actual: Method: post
Path: /api/restapi/fundActual
Delete an Fund Actual: Method: delete
Path: /api/restapi/fundActual/{fundActualId}
Update an Fund Actual: Method: put
Path: /api/restapi/fundActual
View an Fund Actual: Method: get
Path: /api/restapi/fundActual/{fundActualId}
View an Fund Actual by Project Actual: Method: get
Path: /api/restapi/fundActual/projectActuals/{projectActualsId}

Funds

Use the fund service to create, update, delete, and view funds.

Allocates a Workspace Fund to the Child Workspace: Method: post
Path: /api/restapi/funds/workspace/workspace/allocation
Allocates a Workspace Fund to the Portfolio: Method: post
Path: /api/restapi/funds/workspace/portfolio/allocation
Allocates a Workspace Fund to the Project: Method: post
Path: /api/restapi/funds/workspace/project/allocation
Assign an Allocation Rule to a Fund: Method: put
Path: /api/restapi/funds/allocationRuleAssignment
Assign List of Allocation Rules to a Fund: Method: put
Path: /api/restapi/funds/allocationRuleAssignment/batch
Batch Create Allocation Rules: Method: post
Path: /api/restapi/funds/allocationRule/batch
Batch Create Portfolio Funds: Method: post
Path: /api/restapi/funds/portfolio/batch
Batch Create Project Funds: Method: post
Path: /api/restapi/funds/project/batch
Batch Create Workspace Funds: Method: post
Path: /api/restapi/funds/workspace/batch
Batch Delete Allocation Rules: Method: delete
Path: /api/restapi/funds/allocationRule/batch
Batch Update Allocation Rules: Method: put
Path: /api/restapi/funds/allocationRule/batch
Create a Portfolio Fund: Method: post
Path: /api/restapi/funds/portfolio
Create a Project Fund: Method: post
Path: /api/restapi/funds/project
Create a Workspace Fund: Method: post
Path: /api/restapi/funds/workspace
Create an Allocation Rule: Method: post
Path: /api/restapi/funds/allocationRule
Delete an Allocation Rule: Method: delete
Path: /api/restapi/funds/allocationRule/{filterId}
Delete Funds: Method: delete
Path: /api/restapi/funds/batch
Deletes a Fund: Method: delete
Path: /api/restapi/funds/{fundId}
Un-assign a list of Allocation Rule from a Fund: Method: delete
Path: /api/restapi/funds/allocationRuleAssignment/batch
Un-assign Allocation Rule from a Fund: Method: delete
Path: /api/restapi/funds/allocationRuleAssignment
Update an Allocation Rule: Method: put
Path: /api/restapi/funds/allocationRule
Update Portfolio Funds: Method: put
Path: /api/restapi/funds/portfolio/batch
Update Project Funds: Method: put
Path: /api/restapi/funds/project/batch
Update Workspace Funds: Method: put
Path: /api/restapi/funds/workspace/batch
Updates a Portfolio Fund: Method: put
Path: /api/restapi/funds/portfolio
Updates a Project Fund: Method: put
Path: /api/restapi/funds/project
Updates a Workspace Fund: Method: put
Path: /api/restapi/funds/workspace
View a Fund: Method: get
Path: /api/restapi/funds/{fundId}
View Allocation Rules by Fund: Method: get
Path: /api/restapi/funds/allocationRule
View Allocation Rules by Workspace: Method: get
Path: /api/restapi/funds/allocationRule/workspace
View an Allocation Rule: Method: get
Path: /api/restapi/funds/allocationRule/{filterId}
View Fund Totals by Portfolio Code and Workspace Code: Method: get
Path: /api/restapi/funds/portfolio/fundtotal
View Fund Totals by Workspace Code: Method: get
Path: /api/restapi/funds/workspace/fundtotal
View Funds by Portfolio Code and Workspace Code: Method: get
Path: /api/restapi/funds/portfolio/list
View Funds by Project Code: Method: get
Path: /api/restapi/funds/project/list
View Funds by Project Code and Fund Code: Method: get
Path: /api/restapi/funds/project/byFundCode
View Funds by Project Code and Fund Name: Method: get
Path: /api/restapi/funds/project/byFundName
View Funds by Workspace Code: Method: get
Path: /api/restapi/funds/workspace/list
View Funds by Workspace Code and Fund Code: Method: get
Path: /api/restapi/funds/workspace/byFundCode
View Funds by Workspace Code and Fund Name: Method: get
Path: /api/restapi/funds/workspace/byFundName

Gateway App Instance (Deprecated since 24.2)

The operations from the Gateway App Instance (Deprecated since 24.2) category.

Create a Gateway App Instance (Deprecated since 24.2): Method: post
Path: /api/restapi/pims/appInstances
Delete a Gateway App Instance (Deprecated since 24.2): Method: delete
Path: /api/restapi/pims/appInstances/{id}
Test a Gateway Deployment Connection (Deprecated since 24.2): Method: post
Path: /api/restapi/pims/appInstances/testConnection
Update a Gateway App Instance (Deprecated since 24.2): Method: put
Path: /api/restapi/pims/appInstances/{id}
View a Gateway App Instance (Deprecated since 24.2): Method: get
Path: /api/restapi/pims/appInstances/{id}
View All Gateway App Instances (Deprecated since 24.2): Method: get
Path: /api/restapi/pims/appInstances/list
View All Gateway Deployments (Deprecated since 24.2): Method: get
Path: /api/restapi/pims/appInstances/deployments

Gateway App Instance Configurations (Deprecated since 24.2)

The operations from the Gateway App Instance Configurations (Deprecated since 24.2) category.

View a Gateway App Instance Configuration (Deprecated since 24.2): Method: get
Path: /api/restapi/pims/appInstanceConfigurations/{id}
View All Gateway App Instance Configurations (Deprecated since 24.2): Method: get
Path: /api/restapi/pims/appInstanceConfigurations/list

Gateway Flow Definition Apps (Deprecated since 24.2)

The operations from the Gateway Flow Definition Apps (Deprecated since 24.2) category.

View all Gateway Business Flow Definitions (Deprecated since 24.2): Method: get
Path: /api/restapi/pims/flowDefinitionApps/list

Gateway Flow Field Map Templates (Deprecated since 24.2)

The operations from the Gateway Flow Field Map Templates (Deprecated since 24.2) category.

View a Gateway Flow Field Mapping Template (Deprecated since 24.2): Method: get
Path: /api/restapi/pims/flowFieldMapTemplates/{id}
View All Gateway Flow Field Mapping Templates (Deprecated since 24.2): Method: get
Path: /api/restapi/pims/flowFieldMapTemplates/list

Gateway Flow Instances (Deprecated since 24.2)

The operations from the Gateway Flow Instances (Deprecated since 24.2) category.

View a Gateway Business Flow Instance (Deprecated since 24.2): Method: get
Path: /api/restapi/pims/flowInstances/{id}
View All Gateway Business Flow Instances (Deprecated since 24.2): Method: get
Path: /api/restapi/pims/flowInstances/list
View All of the Child Business Flow Instances of a Gateway Business Flow (Deprecated since 24.2): Method: get
Path: /api/restapi/pims/flowInstances/childrenOf/{id}

Gateway Flow Load Objects (Deprecated since 24.2)

The operations from the Gateway Flow Load Objects (Deprecated since 24.2) category.

View all Gateway Business Flow Loads (Deprecated since 24.2): Method: get
Path: /api/restapi/pims/flowLoadObjects/list

Gateway Flow Parameters (Deprecated since 24.2)

The operations from the Gateway Flow Parameters (Deprecated since 24.2) category.

View a Gateway Flow Parameter (Deprecated since 24.2): Method: get
Path: /api/restapi/pims/flowParameters/{id}
View All Gateway Flow Parameters (Deprecated since 24.2): Method: get
Path: /api/restapi/pims/flowParameters/list

Gateway Flow Step Instance Messages (Deprecated since 24.2)

The operations from the Gateway Flow Step Instance Messages (Deprecated since 24.2) category.

Download Business Flow Step Details (Deprecated since 24.2): Method: get
Path: /api/restapi/pims/flowStepInstanceMessages/download/{id}
View Business Flow Step Messages (Deprecated since 24.2): Method: get
Path: /api/restapi/pims/flowStepInstanceMessages/{id}

Gateway Flow Step Instances (Deprecated since 24.2)

The operations from the Gateway Flow Step Instances (Deprecated since 24.2) category.

View All Business Flow Step Details (Deprecated since 24.2): Method: get
Path: /api/restapi/pims/flowStepInstances/list
View Business Flow Step Details (Deprecated since 24.2): Method: get
Path: /api/restapi/pims/flowStepInstances/{id}

Gateway Flows (Deprecated since 24.2)

The operations from the Gateway Flows (Deprecated since 24.2) category.

Create a Gateway Business Flow (Deprecated since 24.2): Method: post
Path: /api/restapi/pims/flows
Delete a Gateway Business Flow (Deprecated since 24.2): Method: delete
Path: /api/restapi/pims/flows/{id}
Update a Gateway Business Flow (Deprecated since 24.2): Method: put
Path: /api/restapi/pims/flows/{id}
View a Gateway Business Flow (Deprecated since 24.2): Method: get
Path: /api/restapi/pims/flows/{id}
View all Gateway Business Flows (Deprecated since 24.2): Method: get
Path: /api/restapi/pims/flows/list

Gateway Parameter Values (Deprecated since 24.2)

The operations from the Gateway Parameter Values (Deprecated since 24.2) category.

Returns all parameterValue business objects. (Deprecated since 24.2): Method: get
Path: /api/restapi/pims/parameterValues/list
Returns the parameterValue business object for the specified parameterValue ID. (Deprecated since 24.2): Method: get
Path: /api/restapi/pims/parameterValues/{id}
Returns the parameterValue business objects for the specified Job ID. (Deprecated since 24.2): Method: get
Path: /api/restapi/pims/parameterValues/byJobId

Gateway Services (Deprecated since 24.2)

The operations from the Gateway Services (Deprecated since 24.2) category.

Initiate a Gateway Job (Deprecated since 24.2): Method: post
Path: /api/restapi/pims/services/createJobProcess/{id}
Initiate a Gateway Job with a Parameter (Deprecated since 24.2): Method: post
Path: /api/restapi/pims/services/createJobProcessWithParameters/{id}

Gateway Synchronizations (Deprecated since 24.2)

The operations from the Gateway Synchronizations (Deprecated since 24.2) category.

Create a Business Flow Schedule (Deprecated since 24.2): Method: post
Path: /api/restapi/pims/synchronizations
Delete a Business Flow Schedule (Deprecated since 24.2): Method: delete
Path: /api/restapi/pims/synchronizations/{id}
Update a Business Flow Schedule (Deprecated since 24.2): Method: put
Path: /api/restapi/pims/synchronizations/{id}
View a Business Flow Schedule (Deprecated since 24.2): Method: get
Path: /api/restapi/pims/synchronizations/{id}
View All Business Flow Schedules (Deprecated since 24.2): Method: get
Path: /api/restapi/pims/synchronizations/list

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. Update Keys : 'holidayId'

Batch Delete Holidays: Method: delete
Path: /api/restapi/holiday/batch
Delete a Holiday: Method: delete
Path: /api/restapi/holiday/{holidayId}

Holiday List

Use the Holiday List service to create, view, update, and delete holiday lists. Holiday lists are collections of public or company holidays. Update Keys : 'holidayListId'

Batch Create Holiday Lists: Method: post
Path: /api/restapi/holidayList/batch
Batch Delete Holiday Lists: Method: delete
Path: /api/restapi/holidayList/batch
Batch Sync Holiday Lists: Method: post
Path: /api/restapi/holidayList/syncBatch
Batch Update Holiday Lists: Method: put
Path: /api/restapi/holidayList/batch
Create a Holiday List: Method: post
Path: /api/restapi/holidayList
Delete a Holiday List: Method: delete
Path: /api/restapi/holidayList/{holidayListId}
Update a Holiday List: Method: put
Path: /api/restapi/holidayList
View a Holiday List: Method: get
Path: /api/restapi/holidayList/{holidayListId}
View a Holiday List by Name: Method: get
Path: /api/restapi/holidayList/name/{holidayGroupName}

Idea

Use the idea service you to create, view, update, and delete idea. Update Keys : 'workspaceCode, ideaName' or 'ideaId'

Assign Permission Profiles To User: Method: post
Path: /api/restapi/idea/assignUser
Batch Create Ideas: Method: post
Path: /api/restapi/idea/batch
Batch Delete Ideas: Method: delete
Path: /api/restapi/idea/batch
Batch Sync Ideas: Method: post
Path: /api/restapi/idea/syncBatch
Batch Update Ideas: Method: put
Path: /api/restapi/idea/batch
Count Ideas with a Status: Method: get
Path: /api/restapi/idea/status/{status}
Create an Idea: Method: post
Path: /api/restapi/idea
Delete an Idea: Method: delete
Path: /api/restapi/idea/{ideaId}
Update an Idea: Method: put
Path: /api/restapi/idea
View an Idea: Method: get
Path: /api/restapi/idea/{ideaId}
View Idea by Name and Workspace Code: Method: get
Path: /api/restapi/idea/{ideaName}/workspace/code/{workspaceCode}
View Ideas by Name and Workspace: Method: get
Path: /api/restapi/idea/{ideaName}/workspace/{workspaceId}
View Ideas by Status and Workspace: Method: get
Path: /api/restapi/idea/status/{status}/workspace/{workspaceId}
View Ideas under a Workspace: Method: get
Path: /api/restapi/idea/workspace/{workspaceId}
View Ideas under a Workspace using Code: Method: get
Path: /api/restapi/idea/workspace/code/{workspaceCode}
View User Permission Sets for Idea: Method: get
Path: /api/restapi/idea/permissionSets

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. Update Keys : 'locationId'

Batch Create Locations: Method: post
Path: /api/restapi/location/batch
Batch Delete Locations: Method: delete
Path: /api/restapi/location/batch
Batch Sync Location: Method: post
Path: /api/restapi/location/syncBatch
Batch Update Locations: Method: put
Path: /api/restapi/location/batch
Create a Location: Method: post
Path: /api/restapi/location
Delete a Location: Method: delete
Path: /api/restapi/location/{locationId}
Update a Location: Method: put
Path: /api/restapi/location
View a Location: Method: get
Path: /api/restapi/location/{locationId}
View a Location by Code: Method: get
Path: /api/restapi/location/code/{locationCode}
View a Location by Code and Workspace: Method: get
Path: /api/restapi/location/workspace/{workspaceId}/code/{locationCode}
View a Location by Name: Method: get
Path: /api/restapi/location/name/{locationName}
View a Location by Workspace: Method: get
Path: /api/restapi/location/workspace/{workspaceId}

Measure

The Measure service enable you to create, update, view, and delete measures. Update Keys : 'measureId'

Batch Create Measures: Method: post
Path: /api/restapi/measure/batch
Batch Delete Measures: Method: delete
Path: /api/restapi/measure/batch
Batch Sync Measures: Method: post
Path: /api/restapi/measure/syncBatch
Batch Update Measures: Method: put
Path: /api/restapi/measure/batch
Create a Measure: Method: post
Path: /api/restapi/measure
Delete a Measure: Method: delete
Path: /api/restapi/measure/{measureId}
Update a Measure: Method: put
Path: /api/restapi/measure
View a Measure: Method: get
Path: /api/restapi/measure/{measureId}
View a Measure by Workspace and Name: Method: get
Path: /api/restapi/measure/workspace/{workspaceId}/measureName/{measureName}
View all Measures by Workspace: Method: get
Path: /api/restapi/measure/workspace/{workspaceId}

Measure Threshold

Use the Measure Threshold service to create, view, update, and delete measure thresholds. Update Keys : 'measureThresholdId'

Batch Create Measure Thresholds: Method: post
Path: /api/restapi/measureThreshold/batch
Batch Delete Measure Thresholds: Method: delete
Path: /api/restapi/measureThreshold/batch
Batch Sync Measure Thresholds: Method: post
Path: /api/restapi/measureThreshold/syncBatch
Batch Update Measure Thresholds: Method: put
Path: /api/restapi/measureThreshold/batch
Create a Measure Threshold: Method: post
Path: /api/restapi/measureThreshold
Delete a Measure Threshold: Method: delete
Path: /api/restapi/measureThreshold/{measureThresholdId}
Update a Measure Threshold: Method: put
Path: /api/restapi/measureThreshold
View a Measure Threshold: Method: get
Path: /api/restapi/measureThreshold/{measureThresholdId}
View a Measure Threshold by Measure: Method: get
Path: /api/restapi/measureThreshold/measure/{measureId}

Monte Carlo Activity Delta

Use the Monte Carlo Activity Delta service to view Monte Carlo activity delta data.

View a Monte Carlo Activity Delta: Method: get
Path: /api/restapi/monteCarloActivityDelta/{monteCarloActivityDeltaId}
View a Monte Carlo Activity Delta by Activity: Method: get
Path: /api/restapi/monteCarloActivityDelta/activity/{activityId}

Monte Carlo Activity Deterministic Values

Use the Monte Carlo Activity Deterministic Values service to view Monte Carlo Activity Deterministic Values.

View All Monte Carlo Activity Deterministic Values by Parent: Method: get
Path: /api/restapi/monteCarloActivityDeterministicValues/parentCode
View Monte Carlo Activity Deterministic Values: Method: get
Path: /api/restapi/monteCarloActivityDeterministicValues/{monteCarloActivityDeterministicValuesId}
View Monte Carlo Activity Deterministic Values by Activity and Scenario: Method: get
Path: /api/restapi/monteCarloActivityDeterministicValues/activity/{activityId}/scenario/{scenario}
View Monte Carlo Activity Deterministic Values by Project and Scenario: Method: get
Path: /api/restapi/monteCarloActivityDeterministicValues/project/{projectId}/scenario/{scenario}

Monte Carlo Activity Iteration Values

Use the Monte Carlo Activity Iteration Values service to view Monte Carlo Activity Iteration Values.

View All Monte Carlo Activity Iteration Values by Activity ID and Scenario: Method: get
Path: /api/restapi/monteCarloActivityIterationValues/activity/{activityId}/scenario/{scenario}
View All Monte Carlo Activity Iteration Values by Parent Codes: Method: get
Path: /api/restapi/monteCarloActivityIterationValues/parentCode
View All Monte Carlo Activity Iteration Values by Project ID and Scenario: Method: get
Path: /api/restapi/monteCarloActivityIterationValues/project/{projectId}/scenario/{scenario}

Monte Carlo Activity Result

Use the Monte Carlo Activity Result service to view Monte Carlo Activity Result data.

View Monte Carlo Activity Result: Method: get
Path: /api/restapi/monteCarloActivityResult/{monteCarloActivityResultId}
View Monte Carlo Activity Results by Activity: Method: get
Path: /api/restapi/monteCarloActivityResult/activity/{activityId}
View Monte Carlo Activity Results by Project: Method: get
Path: /api/restapi/monteCarloActivityResult/project/{projectId}

Monte Carlo Activity Risk Result

Use the Monte Carlo Activity Risk Result service to send view Monte Carlo Activity Risk Result data.

View Monte Carlo Activity Risk Results: Method: get
Path: /api/restapi/monteCarloActivityRiskResult/{monteCarloActivityRiskResultId}
View Monte Carlo Activity Risk Results by Project Risk: Method: get
Path: /api/restapi/monteCarloActivityRiskResult/projectRisk/{projectRiskId}

Monte Carlo Project Delta

Use the MonteCarlo Project Delta service to view MonteCarlo Project Delta data.

View a Monte Carlo Project Delta: Method: get
Path: /api/restapi/monteCarloProjectDelta/{monteCarloProjectDeltaId}
View All Monte Carlo Project Deltas by Parent: Method: get
Path: /api/restapi/monteCarloProjectDelta/parentCode
View Monte Carlo Project Delta by Project and Scenario: Method: get
Path: /api/restapi/monteCarloProjectDelta/project/{projectId}/deltaScenario/{scenario}

Monte Carlo Project Deterministic Values

Use the Monte Carlo Project Deterministic Values service to view Monte Carlo Project Deterministic Values.

View All Monte Carlo Project Deterministic Values by Parent: Method: get
Path: /api/restapi/monteCarloProjectDeterministicValues/parentCode
View Monte Carlo Project Deterministic Values: Method: get
Path: /api/restapi/monteCarloProjectDeterministicValues/{id}
View Monte Carlo Project Deterministic Values by Project and Scenario: Method: get
Path: /api/restapi/monteCarloProjectDeterministicValues/project/{projectId}/scenario/{scenario}

Monte Carlo Project Iteration Values

Use the Monte Carlo Project Iteration Values service to view Monte Carlo Project Iteration Values.

View All Monte Carlo Project Iteration Values by Parent Codes: Method: get
Path: /api/restapi/monteCarloProjectIterationValues/parentCode
View All Monte Carlo Project Iteration Values by Project ID and Scenario: Method: get
Path: /api/restapi/monteCarloProjectIterationValues/project/{projectId}/scenario/{scenario}

Monte Carlo Project Result

Use the Monte Carlo Project Result service to view Monte Carlo Project Result data.

View a Monte Carlo Project Result: Method: get
Path: /api/restapi/monteCarloProjectResult/{monteCarloProjectResultId}
View a Monte Carlo Project Result by Project and Scenario: Method: get
Path: /api/restapi/monteCarloProjectResult/project/{projectId}/scenario/{scenario}
View All Monte Carlo Project Results by Parent: Method: get
Path: /api/restapi/monteCarloProjectResult/parentCode

Monte Carlo Risk Result

Use the Monte Carlo Risk Result service to view Monte Carlo Risk Result data.

View a Monte Carlo Risk Result: Method: get
Path: /api/restapi/monteCarloRiskResult/{monteCarloRiskResultId}
View a Monte Carlo Risk Result by Project and Scenario: Method: get
Path: /api/restapi/monteCarloRiskResult/project/{projectId}/scenario/{scenario}
View a Monte Carlo Risk Result by Project Risk and Scenario: Method: get
Path: /api/restapi/monteCarloRiskResult/projectRisk/{projectRiskId}/scenario/{scenario}

Monte Carlo Run Settings

Use the Monte Carlo Run Settings service to view Monte Carlo Run Settings.

View All Monte Carlo Run Settings by Parent: Method: get
Path: /api/restapi/monteCarloRunSettings/parentCode
View Monte Carlo Run Settings: Method: get
Path: /api/restapi/monteCarloRunSettings/{monteCarloRunSettingsId}
View Monte Carlo Run Settings by Project and Scenario: Method: get
Path: /api/restapi/monteCarloRunSettings/project/{projectId}/scenario/{scenario}

Monte Carlo Settings

Use the Monte Carlo Settings service to create, view, and update Monte Carlo Settings.

Batch Update Monte Carlo Settings: Method: put
Path: /api/restapi/monteCarloSettings/batch
Create Default Monte Carlo Settings for a Project: Method: post
Path: /api/restapi/monteCarloSettings/createDefault/{projectId}
Update Monte Carlo Settings: Method: put
Path: /api/restapi/monteCarloSettings
View All Monte Carlo Settings by Parent: Method: get
Path: /api/restapi/monteCarloSettings/parentCode
View Monte Carlo Settings: Method: get
Path: /api/restapi/monteCarloSettings/{monteCarloSettingsId}
View Monte Carlo Settings by Project: Method: get
Path: /api/restapi/monteCarloSettings/project/{projectId}

Office

The Office service enables you to create, view, update, or delete offices.

Batch Create Offices: Method: post
Path: /api/restapi/office/batch
Batch Delete Offices: Method: delete
Path: /api/restapi/office/batch
Batch Sync Offices: Method: post
Path: /api/restapi/office/syncBatch
Batch Update Offices: Method: put
Path: /api/restapi/office/batch
Create an Office: Method: post
Path: /api/restapi/office
Delete an Office: Method: delete
Path: /api/restapi/office/{officeId}
Update an Office: Method: put
Path: /api/restapi/office
View an Office: Method: get
Path: /api/restapi/office/{officeId}
View Offices for a specified company: Method: get
Path: /api/restapi/office/company/{companyName}/{postalCode}/{countryCode}
View Offices for a specified name: Method: get
Path: /api/restapi/office/name/{officeName}

P6 Import Export

The operations from the P6 Import Export category.

Download a P6 XML/XER: Method: get
Path: /api/restapi/action/download/job/{jobId}
Export a P6 XER: Method: post
Path: /api/restapi/action/exportP6xer
Export a P6 XML: Method: post
Path: /api/restapi/action/exportP6xml
Import a Decoded P6 XML: Method: post
Path: /api/restapi/action/importDecodedP6xml
Import a P6 XER file: Method: post
Path: /api/restapi/action/importP6xer
Import a P6 XML: Method: post
Path: /api/restapi/action/importP6xml
View Job Status: Method: get
Path: /api/restapi/action/jobStatus/{jobId}

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. Update Keys : 'pbsId'

Create a PBS: Method: post
Path: /api/restapi/pbs
Delete a PBS: Method: delete
Path: /api/restapi/pbs/{pbsId}
Delete all Children in a PBS Hierarchy: Method: delete
Path: /api/restapi/pbs/children/{pbsId}
Update a PBS: Method: put
Path: /api/restapi/pbs
View a Child in a PBS Hierarchy: Method: get
Path: /api/restapi/pbs/children/{pbsId}
View a PBS: Method: get
Path: /api/restapi/pbs/{pbsId}
View a PBS by Code and Project: Method: get
Path: /api/restapi/pbs/project/{projectId}/code/{pbsCode}
View a PBS by Name and Project: Method: get
Path: /api/restapi/pbs/project/{projectId}/name/{pbsName}
View a PBS by Project: Method: get
Path: /api/restapi/pbs/project/{projectId}
View All Children in a PBS Hierarchy: Method: get
Path: /api/restapi/pbs/{pbsId}/childrenHierarchy

Period Closeout Record

Use the Period Closeout service to view period closeouts.

View a Period Closeout: Method: get
Path: /api/restapi/periodCloseoutRecord/{periodCloseOutRecordId}
View a Scope Item Assignment Period Closeout: Method: get
Path: /api/restapi/periodCloseoutData/{scopeAssignmentPeriodCloseOutId}
View all Period Closeout by Project: Method: get
Path: /api/restapi/periodCloseoutRecord/project/{projectId}
View all Scope Item Assignment Period Closeout by Period Item: Method: get
Path: /api/restapi/periodCloseoutData/periodItem/{periodItemId}
View all Scope Item Assignment Period Closeout by Scope Item Assignment: Method: get
Path: /api/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. Update Keys : 'capitalPortfolioId'

Assign Permission Profiles To User: Method: post
Path: /api/restapi/portfolio/assignUser
Batch Create Portfolios: Method: post
Path: /api/restapi/portfolio/batch
Batch Delete Portfolios: Method: delete
Path: /api/restapi/portfolio/batch
Batch Sync Portfolios: Method: post
Path: /api/restapi/portfolio/syncBatch
Batch Update Portfolios: Method: put
Path: /api/restapi/portfolio/batch
Create a Portfolio: Method: post
Path: /api/restapi/portfolio
Delete a Portfolio: Method: delete
Path: /api/restapi/portfolio/{capitalPortfolioId}
Refresh a Portfolio: Method: get
Path: /api/restapi/portfolio/refresh/{portfolioId}
Update a Portfolio: Method: put
Path: /api/restapi/portfolio
View a Portfolio: Method: get
Path: /api/restapi/portfolio/{portfolioId}
View a Portfolio by Name and Workspace: Method: get
Path: /api/restapi/portfolio/workspaceId/{workspaceId}/name/{name}
View a Portfolio Image: Method: get
Path: /api/restapi/portfolio/image/{portfolioId}
View all Portfolios by Name: Method: get
Path: /api/restapi/portfolio/name/{name}
View Portfolios by Workspace: Method: get
Path: /api/restapi/portfolio/workspace/{workspaceId}
View User Permission Sets for Portfolio: Method: get
Path: /api/restapi/portfolio/permissionSets

Portfolio Measure

Use the Portfolio Measure service to create, view, update, and delete portfolio measures. Portfolio measures represent associations between measures and portfolios. Update Keys : 'portfolioMeasureId'

Batch Create Portfolio Measures: Method: post
Path: /api/restapi/portfolioMeasure/batch
Batch Delete Portfolio Measures: Method: delete
Path: /api/restapi/portfolioMeasure/batch
Batch Sync Portfolio Measures: Method: post
Path: /api/restapi/portfolioMeasure/syncBatch
Batch Update Portfolio Measures: Method: put
Path: /api/restapi/portfolioMeasure/batch
Create a Portfolio Measure: Method: post
Path: /api/restapi/portfolioMeasure
Delete a Portfolio Measure: Method: delete
Path: /api/restapi/portfolioMeasure/{portfolioMeasureId}
Update a Portfolio Measure: Method: put
Path: /api/restapi/portfolioMeasure
View a Portfolio Measure: Method: get
Path: /api/restapi/portfolioMeasure/{portfolioMeasureId}
View a Portfolio Measure by Measure: Method: get
Path: /api/restapi/portfolioMeasure/measure/{measureId}
View a Portfolio Measure by Portfolio: Method: get
Path: /api/restapi/portfolioMeasure/portfolio/{portfolioId}
View All Portfolio Measures Owned by a User: Method: get
Path: /api/restapi/portfolioMeasure/currentUserPortfolios

Portfolio Measure Manual Value

The Portfolio Measure Manual Value resource enables you to create, view, update, and delete portfolio measure manual values.

Batch Create Portfolio Measure Manual Values: Method: post
Path: /api/restapi/portfolioMeasureManualValue/batch
Batch Delete Portfolio Measure Manual Values: Method: delete
Path: /api/restapi/portfolioMeasureManualValue/batch
Batch Sync Portfolio Measure Manual Values: Method: post
Path: /api/restapi/portfolioMeasureManualValue/syncBatch
Batch Update Portfolio Measure Manual Values: Method: put
Path: /api/restapi/portfolioMeasureManualValue/batch
Create a Portfolio Measure Manual Value: Method: post
Path: /api/restapi/portfolioMeasureManualValue
Delete a Portfolio Measure Manual Value: Method: delete
Path: /api/restapi/portfolioMeasureManualValue/{portfolioMeasureManualValueId}
Update a Portfolio Measure Manual Value: Method: put
Path: /api/restapi/portfolioMeasureManualValue
View a Portfolio Measure Manual Value: Method: get
Path: /api/restapi/portfolioMeasureManualValue/{portfolioMeasureManualValueId}
View a Portfolio Measure Manual Value by Measure: Method: get
Path: /api/restapi/portfolioMeasureManualValue/measure/{measureId}
View a Portfolio Measure Manual Value by Measure and Portfolio: Method: get
Path: /api/restapi/portfolioMeasureManualValue/measure/{measureId}/portfolio/{capitalPortfolioId}
View a Portfolio Measure Manual Value by Portfolio: Method: get
Path: /api/restapi/portfolioMeasureManualValue/portfolio/{capitalPortfolioId}

Portfolio Measure Value

Use the Portfolio Measure Value service to view portfolio measure values.

View a Porfolio Measure Value: Method: get
Path: /api/restapi/portfolioMeasureValue/{portfolioMeasureValueId}
View a Porfolio Measure Value by Measure: Method: get
Path: /api/restapi/portfolioMeasureValue/measure/{measureId}
View a Porfolio Measure Value by Measure and Portfolio: Method: get
Path: /api/restapi/portfolioMeasureValue/measure/{measureId}/portfolio/{capitalPortfolioId}
View Porfolio Measure Value by Portfolio: Method: get
Path: /api/restapi/portfolioMeasureValue/portfolio/{capitalPortfolioId}

Portfolio Project

Use the Portfolio Project service to create, view, update, and delete portfolio projects. Portfolio projects are references to projects that belong to a portfolio. Portfolio projects contain the system-generated identifiers of the project, as well as the identifier of the portfolio the project belongs to.

View a Portfolio Project: Method: get
Path: /api/restapi/portfolioProject/{capitalPortfolioProjectId}
View Portfolio Projects by Portfolio: Method: get
Path: /api/restapi/portfolioProject/portfolio/{capitalPortfolioId}

Program

Use the Program service to create, view, update, and delete programs. Update Keys : 'workspaceId, programCode' or 'programId' or 'workspaceCode, programCode'

Assign Permission Profiles To User: Method: post
Path: /api/restapi/program/assignUser
Batch Create Programs: Method: post
Path: /api/restapi/program/batch
Batch Delete Programs: Method: delete
Path: /api/restapi/program/batch
Batch Sync Programs: Method: post
Path: /api/restapi/program/syncBatch
Batch Update Programs: Method: put
Path: /api/restapi/program/batch
Create a Program: Method: post
Path: /api/restapi/program
Delete a Program: Method: delete
Path: /api/restapi/program/{programId}
Update a Program: Method: put
Path: /api/restapi/program
View a Program: Method: get
Path: /api/restapi/program/{programId}
View a Program by Code and Workspace Code: Method: get
Path: /api/restapi/program/byItemCode
View all Program Financial and Settings by Portfolio: Method: get
Path: /api/restapi/program/financialsAndSettings/portfolio/{portfolioId}
View all Program Financial and Settings by Portfolio Name: Method: get
Path: /api/restapi/program/financialsAndSettings/portfolio/name/{name}
View all Program Financial and Settings by Project: Method: get
Path: /api/restapi/program/financialsAndSettings/project/{projectId}
View all Program Financial and Settings by Workspace: Method: get
Path: /api/restapi/program/financialsAndSettings/workspace/{workspaceId}
View all Programs by Assigned Code Value: Method: get
Path: /api/restapi/program/codeType/{codeTypeId}/codeValue/{codeValueCode}
View all Programs by Name: Method: get
Path: /api/restapi/program/name/{programName}
View all Programs by Portfolio ID: Method: get
Path: /api/restapi/program/portfolio/{portfolioId}
View all Programs by Portfolio Name: Method: get
Path: /api/restapi/program/portfolio/name/{portfolioName}
View all Programs by Program Code: Method: get
Path: /api/restapi/program/code/{programCode}
View all Programs by Project: Method: get
Path: /api/restapi/program/project/{projectId}
View all Programs by Workspace: Method: get
Path: /api/restapi/program/workspace/{workspaceId}
View User Permission Sets for Program: Method: get
Path: /api/restapi/program/permissionSets

Program Budget

The operations from the Program Budget category.

Batch Create Program Budgets: Method: post
Path: /api/restapi/programBudget/batch
Change a Program Budget Status: Method: put
Path: /api/restapi/programBudget/program/{programId}/changeBudgetStatus
Create a Program Budget: Method: post
Path: /api/restapi/programBudget
View a Program Budget: Method: get
Path: /api/restapi/programBudget/{programBudgetId}
View a Program Budget by Program: Method: get
Path: /api/restapi/programBudget/program/{programId}
View all Program Budget Status Transition History by Program: Method: get
Path: /api/restapi/programBudget/program/{programId}/statusTransitionHistory
View Linked Project Budget Item Transactions by Program Budget ID: Method: get
Path: /api/restapi/programBudget/{programBudgetId}/linkedProjectTransactions
View Linked Project Budget Item Transactions by Program ID: Method: get
Path: /api/restapi/programBudget/program/{programId}/linkedProjectTransactions
View Program Budget Transactions By Program Budget ID: Method: get
Path: /api/restapi/programBudget/{programBudgetId}/transactions
View Program Budget Transactions By Program ID: Method: get
Path: /api/restapi/programBudget/program/{programId}/transactions
View Program Budgets by Portfolio Name: Method: get
Path: /api/restapi/programBudget/portfolio/name/{portfolioName}
View Program Budgets by Workspace Code: Method: get
Path: /api/restapi/programBudget/workspace/code/{workspaceCode}

Program Budget Change

The Budget Change service enables you to create, view, update, and delete program budget change requests. Program Budget change requests represent potential modifications to program budgets. Update Keys : 'programBudgetChangeId'

Batch Create Program Budget Changes: Method: post
Path: /api/restapi/programBudgetChange/batch
Batch Delete Program Budget Changes: Method: delete
Path: /api/restapi/programBudgetChange/batch
Batch Sync Program Budget Changes: Method: post
Path: /api/restapi/programBudgetChange/syncBatch
Batch Update Program Budget Changes: Method: put
Path: /api/restapi/programBudgetChange/batch
Change Program Budget Change Status: Method: put
Path: /api/restapi/programBudgetChange/{programBudgetChangeId}/changeProgramBudgetChangeStatus
Create a Program Budget Change: Method: post
Path: /api/restapi/programBudgetChange
Delete a Program Budget Change: Method: delete
Path: /api/restapi/programBudgetChange/{programBudgetChangeId}
Update a Program Budget Change: Method: put
Path: /api/restapi/programBudgetChange
View a Program Budget Change: Method: get
Path: /api/restapi/programBudgetChange/{programBudgetChangeId}
View a Program Budget Change by Code and Parent Codes: Method: get
Path: /api/restapi/programBudgetChange/byItemCode
View Program Budget Change Status Transition History Records by Program: Method: get
Path: /api/restapi/programBudgetChange/program/{programId}/statusTransitionHistory
View Program Budget Change Status Transition History Records by Program Budget Change: Method: get
Path: /api/restapi/programBudgetChange/{programBudgetChangeId}/statusTransitionHistory
View Program Budget Changes by Parent: Method: get
Path: /api/restapi/programBudgetChange/byParent
View Program Budget Changes by Program: Method: get
Path: /api/restapi/programBudgetChange/program/{programId}
View Program Budget Changes by Program Budget: Method: get
Path: /api/restapi/programBudgetChange/programBudget/{programBudgetId}

Program Budget Item

The operations from the Program Budget Item category.

Batch Create Program Budget Items: Method: post
Path: /api/restapi/programBudgetItem/batch
Batch Delete Program Budget Items: Method: delete
Path: /api/restapi/programBudgetItem/batch
Batch Sync Program Budget Items: Method: post
Path: /api/restapi/programBudgetItem/syncBatch
Batch Update Program Budget Items: Method: put
Path: /api/restapi/programBudgetItem/batch
Create a Program Budget Item: Method: post
Path: /api/restapi/programBudgetItem
Delete a Program Budget Item: Method: delete
Path: /api/restapi/programBudgetItem/{programBudgetItemId}
Update a Program Budget Item: Method: put
Path: /api/restapi/programBudgetItem
View a Program Budget Item by Code and Parent Codes: Method: get
Path: /api/restapi/programBudgetItem/byItemCode
View Program Budget Items by Program: Method: get
Path: /api/restapi/programBudgetItem/program/{programId}
View Program Budget Items by Program Budget: Method: get
Path: /api/restapi/programBudgetItem/programBudget/{programBudgetId}

Program Budget Transfer

Use the Program Budget Transfer service to create, view, update, delete program budget transfers. Program Budget transfers represent adjustments to program budget line item costs, and capture costs that were moved from one line item to another. Update Keys : 'programBudgetTransferId'

Batch Create Program Budget Transfers: Method: post
Path: /api/restapi/programBudgetTransfer/batch
Batch Delete Program Budget Transfers: Method: delete
Path: /api/restapi/programBudgetTransfer/batch
Batch Sync Program Budget Transfers: Method: post
Path: /api/restapi/programBudgetTransfer/syncBatch
Batch Update Program Budget Transfers: Method: put
Path: /api/restapi/programBudgetTransfer/batch
Change a Program Budget Transfer Status: Method: put
Path: /api/restapi/programBudgetTransfer/{programBudgetTransferId}/changeProgramBudgetTransferStatus
Create a Program Budget Transfer: Method: post
Path: /api/restapi/programBudgetTransfer
Delete a Program Budget Transfer: Method: delete
Path: /api/restapi/programBudgetTransfer/{programBudgetTransferId}
Update a Program Budget Transfer: Method: put
Path: /api/restapi/programBudgetTransfer
View a Program Budget Transfer: Method: get
Path: /api/restapi/programBudgetTransfer/{programBudgetTransferId}
View a Program Budget Transfer by Code and Parent Codes: Method: get
Path: /api/restapi/programBudgetTransfer/byItemCode
View all Program Budget Transfers by Parent: Method: get
Path: /api/restapi/programBudgetTransfer/byParent
View Program Budget Transfers by Program: Method: get
Path: /api/restapi/programBudgetTransfer/program/{programId}
View Program Budget Transfers by Program Budget: Method: get
Path: /api/restapi/programBudgetTransfer/programBudget/{programBudgetId}
View Status Transition History Records by Program: Method: get
Path: /api/restapi/programBudgetTransfer/program/{programId}/statusTransitionHistory
View Status Transition History Records by Program Budget Transfer: Method: get
Path: /api/restapi/programBudgetTransfer/{programBudgetTransferId}/statusTransitionHistory

Program Measure Value

The operations from the Program Measure Value category.

View a Program Measure Value: Method: get
Path: /api/restapi/programMeasureValue/{programMeasureValueId}
View all Program Measure Values by Measure: Method: get
Path: /api/restapi/programMeasureValue/measure/{measureId}
View all Program Measure Values by Measure Name and Workspace Code: Method: get
Path: /api/restapi/programMeasureValue/measure
View all Program Measure Values by Program: Method: get
Path: /api/restapi/programMeasureValue/program/{programId}
View all Program Measure Values by Program Code and Workspace Code: Method: get
Path: /api/restapi/programMeasureValue/program

Program Risk

Use the Program Risk service to create, view, update, and delete program risks. Update Keys : 'programRiskId'

Batch Create Program Risks: Method: post
Path: /api/restapi/programRisk/batch
Batch Delete Program Risks: Method: delete
Path: /api/restapi/programRisk/batch
Batch Sync Program Risks: Method: post
Path: /api/restapi/programRisk/syncBatch
Batch Update Program Risks: Method: put
Path: /api/restapi/programRisk/batch
Create a Program Risk: Method: post
Path: /api/restapi/programRisk
Delete a Program Risk: Method: delete
Path: /api/restapi/programRisk/{programRiskId}
Update a Program Risk: Method: put
Path: /api/restapi/programRisk
View a Program Risk: Method: get
Path: /api/restapi/programRisk/{programRiskId}
View a Program Risk by Program and Risk Code: Method: get
Path: /api/restapi/programRisk/program/{programId}/riskCode/{riskCode}
View all Program Risks by Assigned CodeValue: Method: get
Path: /api/restapi/programRisk/codeType/{codeTypeId}/codeValue/{codeValueCode}
View all Program Risks by Name: Method: get
Path: /api/restapi/programRisk/name/{riskName}
View all Program Risks by Program: Method: get
Path: /api/restapi/programRisk/programId/{programId}
View all Program Risks in a Workspace: Method: get
Path: /api/restapi/programRisk/workspace/{workspaceId}

Program Risk Mitigation

The Program Risk Mitigation service enables you to create, update, view, and delete program risk mitigations. Program Risk Mitigation is also referred to as Program Risk Response Action. Update Keys : 'programRiskMitigationId'

Batch Create Program Risk Mitigations: Method: post
Path: /api/restapi/programRiskMitigation/batch
Batch Delete Program Risk Mitigations: Method: delete
Path: /api/restapi/programRiskMitigation/batch
Batch Sync Program Risk Mitigations: Method: post
Path: /api/restapi/programRiskMitigation/syncBatch
Batch Update Program Risk Mitigations: Method: put
Path: /api/restapi/programRiskMitigation/batch
Create a Program Risk Mitigation: Method: post
Path: /api/restapi/programRiskMitigation
Delete a Program Risk Mitigation: Method: delete
Path: /api/restapi/programRiskMitigation/{programRiskMitigationId}
Update a Program Risk Mitigation: Method: put
Path: /api/restapi/programRiskMitigation
View a Program Risk Mitigation: Method: get
Path: /api/restapi/programRiskMitigation/{programRiskMitigationId}
View all Program Risk Mitigations by Code: Method: get
Path: /api/restapi/programRiskMitigation/code/{programRiskMitigationCode}
View all Program Risk Mitigations by Program ID: Method: get
Path: /api/restapi/programRiskMitigation/program/{programId}
View all Program Risk Mitigations by Program Risk ID: Method: get
Path: /api/restapi/programRiskMitigation/programRisk/{programRiskId}

Program Risk Weather Period

The Program Risk Weather Period service enables you to create, update, view, and delete program risk weather periods. Update Keys : 'programRiskWeatherPeriodId'

Batch Create Program Risk Weather Periods: Method: post
Path: /api/restapi/programRiskWeatherPeriod/batch
Batch Delete Program Risk Weather Periods: Method: delete
Path: /api/restapi/programRiskWeatherPeriod/batch
Batch Sync Program Risk Weather Periods: Method: post
Path: /api/restapi/programRiskWeatherPeriod/syncBatch
Batch Update Program Risk Weather Periods: Method: put
Path: /api/restapi/programRiskWeatherPeriod/batch
Create a Program Risk Weather Period: Method: post
Path: /api/restapi/programRiskWeatherPeriod
Delete a Program Risk Weather Period: Method: delete
Path: /api/restapi/programRiskWeatherPeriod/{programRiskWeatherPeriodId}
Update a Program Risk Weather Period: Method: put
Path: /api/restapi/programRiskWeatherPeriod
View a Program Risk Mitigation by Program Risk ID: Method: get
Path: /api/restapi/programRiskWeatherPeriod/programRisk/{programRiskId}
View a Program Risk Weather Period: Method: get
Path: /api/restapi/programRiskWeatherPeriod/{programRiskWeatherPeriodId}
View all Program Risk Weather Periods by Period Name: Method: get
Path: /api/restapi/programRiskWeatherPeriod/code/{periodName}
View all Program Risk Weather Periods by Program ID: Method: get
Path: /api/restapi/programRiskWeatherPeriod/program/{programId}

Project

Use the Project service to create, view, update, and delete projects. Projects are company initiatives and goals you manage Update Keys : 'projectId'

Assign Permission Profiles To User: Method: post
Path: /api/restapi/project/assignUser
Batch Create Projects: Method: post
Path: /api/restapi/project/batch
Batch Delete Projects: Method: delete
Path: /api/restapi/project/batch
Batch Integrate Projects with an External Data Source: Method: post
Path: /api/restapi/project/syncBatch
Batch Update Projects: Method: put
Path: /api/restapi/project/batch
Create a Project: Method: post
Path: /api/restapi/project
Delete a Project: Method: delete
Path: /api/restapi/project/{projectId}
Integrate a Project with an External Data Source: Method: post
Path: /api/restapi/project/sync
Update a Project: Method: put
Path: /api/restapi/project
View a Project: Method: get
Path: /api/restapi/project/{projectId}
View a Project by Code and Parent Code: Method: get
Path: /api/restapi/project/byItemCode
View a Project by Code and Workspace: Method: get
Path: /api/restapi/project/workspace/{workspaceId}/code/{projectCode}
View a Project Image: Method: get
Path: /api/restapi/project/image/{projectId}
View all Integrated Projects: Method: get
Path: /api/restapi/project/externallySourced
View all Projects by Assigned Code Value: Method: get
Path: /api/restapi/project/codeType/{codeTypeId}/codeValue/{codeValueCode}
View all Projects by Assigned Configured Field Value: Method: get
Path: /api/restapi/project/configuredField/{viewColumnName}/{value}
View all Projects by Name: Method: get
Path: /api/restapi/project/name/{projectName}
View all Projects by Parent Code: Method: get
Path: /api/restapi/project/byParent
View all Projects by Project Code: Method: get
Path: /api/restapi/project/code/{projectCode}
View all Projects by Specified Name Pattern: Method: get
Path: /api/restapi/project/nameLike/{projectName}
View all Projects by Workspace: Method: get
Path: /api/restapi/project/workspace/{workspaceId}
View User Groups for Project: Method: get
Path: /api/restapi/project/userGroups
View User Permission Sets for Project: Method: get
Path: /api/restapi/project/permissionSets

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 : 'projectActualsId'

Batch Create Project Actuals: Method: post
Path: /api/restapi/projectActuals/batch
Batch Delete Project Actuals: Method: delete
Path: /api/restapi/projectActuals/batch
Batch Integrate Project Actuals Data with an External Data Source: Method: post
Path: /api/restapi/projectActuals/syncBatch
Batch Sync Project Actuals: Method: post
Path: /api/restapi/projectActuals/sync/batch
Batch Update Project Actuals: Method: put
Path: /api/restapi/projectActuals/batch
Change Project Actual Status: Method: put
Path: /api/restapi/projectActuals/changeStatus
Create a Project Actual: Method: post
Path: /api/restapi/projectActuals
Delete a Project Actual: Method: delete
Path: /api/restapi/projectActuals/{projectActualsId}
Integrate Project Actuals Data with an External Data Source: Method: post
Path: /api/restapi/projectActuals/sync
Update a Project Actual: Method: put
Path: /api/restapi/projectActuals
View a Project Actual: Method: get
Path: /api/restapi/projectActuals/{projectActualsId}
View a Project Actual by Code: Method: get
Path: /api/restapi/projectActuals/code/{projectActualsCode}
View a Project Actual by Code and Parent Codes: Method: get
Path: /api/restapi/projectActuals/byItemCode
View a Project Actual by Code and Project: Method: get
Path: /api/restapi/projectActuals/project/{projectId}/code/{projectActualsCode}
View all Integrated Project Actuals: Method: get
Path: /api/restapi/projectActuals/externallySourced
View all Project Actuals by Assigned Configured Field Value: Method: get
Path: /api/restapi/projectActuals/project/{projectId}/configuredField/{viewColumnName}/{value}
View all Project Actuals by Parent: Method: get
Path: /api/restapi/projectActuals/byParent
View all Project Actuals by Project: Method: get
Path: /api/restapi/projectActuals/project/{projectId}

Project Actuals Line Item

The operations from the Project Actuals Line Item category.

Batch Create Project Actuals Line Items: Method: post
Path: /api/restapi/projectActualsLineItem/batch
Batch Delete Project Actuals Line Items: Method: delete
Path: /api/restapi/projectActualsLineItem/batch
Batch Integrate Project Actuals Line Items with an External Data Source: Method: post
Path: /api/restapi/projectActualsLineItem/syncBatch
Batch Sync Project Actuals Line Items: Method: post
Path: /api/restapi/projectActualsLineItem/sync/batch
Batch Update Project Actuals Line Items: Method: put
Path: /api/restapi/projectActualsLineItem/batch
Create a Project Actuals Line Item: Method: post
Path: /api/restapi/projectActualsLineItem
Delete a Project Actuals Line Item: Method: delete
Path: /api/restapi/projectActualsLineItem/{projectActualsLineItemId}
Integrate a Project Actuals Line Item with an External Data Source: Method: post
Path: /api/restapi/projectActualsLineItem/sync
Update a Project Actuals Line Item: Method: put
Path: /api/restapi/projectActualsLineItem
View a Project Actual Line Item: Method: get
Path: /api/restapi/projectActualsLineItem/{projectActualsLineItemId}
View a Project Actual Line Item by Code and Parent Codes: Method: get
Path: /api/restapi/projectActualsLineItem/byItemCode
View a Project Actuals Line Item by Code: Method: get
Path: /api/restapi/projectActualsLineItem/code/{projectActualsLineItemCode}
View a Project Actuals Line Item by Code and Project Actual ID: Method: get
Path: /api/restapi/projectActualsLineItem/projectActual/{projectActualsId}/code/{projectActualsLineItemCode}
View all Integrated Project Actuals Line Items: Method: get
Path: /api/restapi/projectActualsLineItem/externallySourced
View all Project Actual Line Items by Parent: Method: get
Path: /api/restapi/projectActualsLineItem/byParent
View all Project Actual Line Items by Project Actual: Method: get
Path: /api/restapi/projectActualsLineItem/projectActuals/{projectActualsId}

Project Budget

Use the Project Budget services to view project budgets.

Change a Project Budget Status: Method: put
Path: /api/restapi/projectBudget/project/{projectId}/changeBudgetStatus
View a Project Budget: Method: get
Path: /api/restapi/projectBudget/{projectBudgetId}
View a Project Budget by Parent Code: Method: get
Path: /api/restapi/projectBudget/byParent
View a Project Budget by Project: Method: get
Path: /api/restapi/projectBudget/project/{projectId}
View all Project Budget Status Transition History by Project: Method: get
Path: /api/restapi/projectBudget/project/{projectId}/statusTransitionHistory
View Budget Transactions by Project: Method: get
Path: /api/restapi/projectBudget/project/{projectId}/transactions
View Budget Transactions by Project Budget: Method: get
Path: /api/restapi/projectBudget/{projectBudgetId}/transactions

Project Budget Change

The Project Budget Change service enables you to create, view, update, and delete project budget change requests. Project Budget Change requests represent potential modifications to project budgets. Update Keys : 'budgetChangeId'

Batch Create Project Budget Changes: Method: post
Path: /api/restapi/budgetChange/batch
Batch Delete Project Budget Changes: Method: delete
Path: /api/restapi/budgetChange/batch
Batch Sync Project Budget Changes: Method: post
Path: /api/restapi/budgetChange/syncBatch
Batch Update Project Budget Changes: Method: put
Path: /api/restapi/budgetChange/batch
Change Project Budget Change Status: Method: put
Path: /api/restapi/budgetChange/{id}/changeBudgetChangeStatus
Create a Project Budget Change: Method: post
Path: /api/restapi/budgetChange
Delete a Project Budget Change: Method: delete
Path: /api/restapi/budgetChange/{budgetChangeId}
Update a Project Budget Change: Method: put
Path: /api/restapi/budgetChange
View a Project Budget Change: Method: get
Path: /api/restapi/budgetChange/{budgetChangeId}
View a Project Budget Change by Code and Parent Codes: Method: get
Path: /api/restapi/budgetChange/byItemCode
View a Project Budget Change by Code and Project: Method: get
Path: /api/restapi/budgetChange/project/{projectId}/code/{budgetChangeCode}
View a Project Budget Change by Code and Project Budget: Method: get
Path: /api/restapi/budgetChange/projectBudget/{projectBudgetId}/code/{budgetChangeCode}
View a Project Budget Change by Project and Assigned Configured Field: Method: get
Path: /api/restapi/budgetChange/project/{projectId}/configuredField/{viewColumnName}/{value}
View a Project Budget Change by Project Budget and Assigned Configured Field: Method: get
Path: /api/restapi/budgetChange/projectBudget/{projectBudgetId}/configuredField/{viewColumnName}/{value}
View all Project Budget Changes by Parent: Method: get
Path: /api/restapi/budgetChange/byParent
View Budget Transactions by Project Budget Change: Method: get
Path: /api/restapi/budgetChange/{budgetChangeId}/transactions
View Project Budget Changes by Project: Method: get
Path: /api/restapi/budgetChange/project/{projectId}
View Project Budget Changes by Project Budget: Method: get
Path: /api/restapi/budgetChange/projectBudget/{projectBudgetId}
View Status Transition History Record by Project: Method: get
Path: /api/restapi/budgetChange/project/{projectId}/statusTransitionHistory
View Status Transition History Record by Project Budget Change: Method: get
Path: /api/restapi/budgetChange/{budgetChangeId}/statusTransitionHistory

Project Budget Item

Use the Project Budget Item service to create, view, update, and delete project budget items. Project Budget Items represent costs associated with labor or other project expenses. Update Keys : 'budgetItemId'

Batch Create Project Budget Items: Method: post
Path: /api/restapi/budgetItem/batch
Batch Delete Project Budget Items: Method: delete
Path: /api/restapi/budgetItem/batch
Batch Integrate Budget Items with an External Data Source: Method: post
Path: /api/restapi/budgetItem/syncBatch
Batch Sync Project Budget Items: Method: post
Path: /api/restapi/budgetItem/sync/batch
Batch Update Project Budget Items: Method: put
Path: /api/restapi/budgetItem/batch
Create a Project Budget Item: Method: post
Path: /api/restapi/budgetItem
Delete a Project Budget Item: Method: delete
Path: /api/restapi/budgetItem/{budgetItemId}
Integrate a Budget Item with an External Data Source: Method: post
Path: /api/restapi/budgetItem/sync
Update a Project Budget Item: Method: put
Path: /api/restapi/budgetItem
View a Project Budget Item by Code and Parent Codes: Method: get
Path: /api/restapi/budgetItem/byItemCode
View a Project Budget Item by Project and Assigned Configured Field: Method: get
Path: /api/restapi/budgetItem/project/{projectId}/configuredField/{viewColumnName}/{value}
View a Project Budget Item by Project Budget and Assigned Configured Field: Method: get
Path: /api/restapi/budgetItem/projectBudget/{projectBudgetId}/configuredField/{viewColumnName}/{value}
View all Project Budget Items by Parent: Method: get
Path: /api/restapi/budgetItem/byParent
View Budget Transactions by Assigned Configured Field: Method: get
Path: /api/restapi/budgetItem/{budgetItemId}/transactions/configuredField/{viewColumnName}/{value}
View Budget Transactions by Project Budget Item: Method: get
Path: /api/restapi/budgetItem/{budgetItemId}/transactions
View Integrated Budget Items: Method: get
Path: /api/restapi/budgetItem/externallySourced
View Project Budget Item by Code and Project: Method: get
Path: /api/restapi/budgetItem/project/{projectId}/code/{budgetItemCode}
View Project Budget Item by Code and Project Budget: Method: get
Path: /api/restapi/budgetItem/projectBudget/{projectBudgetId}/code/{budgetItemCode}
View Project Budget Items by Name: Method: get
Path: /api/restapi/budgetItem/name/{itemName}
View Project Budget Items by Project: Method: get
Path: /api/restapi/budgetItem/project/{projectId}
View Project Budget Items by Project Budget: Method: get
Path: /api/restapi/budgetItem/projectBudget/{projectBudgetId}

Project Budget Transfer

Use the Project Budget Transfer service to create, view, update, delete, and status project 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 Project Budget Transfers: Method: post
Path: /api/restapi/budgetTransfer/batch
Batch Delete Project Budget Transfers: Method: delete
Path: /api/restapi/budgetTransfer/batch
Batch Sync Project Budget Transfers: Method: post
Path: /api/restapi/budgetTransfer/syncBatch
Batch Update Project Budget Transfers: Method: put
Path: /api/restapi/budgetTransfer/batch
Change a Project Budget Transfer Status: Method: put
Path: /api/restapi/budgetTransfer/{id}/changeBudgetTransferStatus
Create a Project Budget Transfer: Method: post
Path: /api/restapi/budgetTransfer
Delete a Project Budget Transfer: Method: delete
Path: /api/restapi/budgetTransfer/{budgetTransferId}
Update a Project Budget Transfer: Method: put
Path: /api/restapi/budgetTransfer
View a Project Budget Transfer: Method: get
Path: /api/restapi/budgetTransfer/{budgetTransferId}
View a Project Budget Transfer by Code and Parent Codes: Method: get
Path: /api/restapi/budgetTransfer/byItemCode
View a Project Budget Transfer by Code and Project: Method: get
Path: /api/restapi/budgetTransfer/project/{projectId}/code/{budgetTransferCode}
View all Project Budget Transfers by Parent: Method: get
Path: /api/restapi/budgetTransfer/byParent
View Budget Transactions by Project Budget Transfer: Method: get
Path: /api/restapi/budgetTransfer/{budgetTransferId}/transactions
View Project Budget Transfer by Assigned Configured Field: Method: get
Path: /api/restapi/budgetTransfer/project/{projectId}/configuredField/{viewColumnName}/{value}
View Project Budget Transfer by Assigned Configured Field: Method: get
Path: /api/restapi/budgetTransfer/projectBudget/{projectBudgetId}/configuredField/{viewColumnName}/{value}
View Project Budget Transfer by Code and Project Budget: Method: get
Path: /api/restapi/budgetTransfer/projectBudget/{projectBudgetId}/code/{budgetTransferCode}
View Project Budget Transfers by Project: Method: get
Path: /api/restapi/budgetTransfer/project/{projectId}
View Project Budget Transfers by Project Budget: Method: get
Path: /api/restapi/budgetTransfer/projectBudget/{projectBudgetId}
View Status Transition History Records by Project: Method: get
Path: /api/restapi/budgetTransfer/project/{projectId}/statusTransitionHistory
View Status Transition History Records by Project Budget Transfer: Method: get
Path: /api/restapi/budgetTransfer/{budgetTransferId}/statusTransitionHistory

Project Company

Use the Project Company service to view companies associated with projects. Update Keys : 'projectCompanyId'

Batch Create Project Companies: Method: post
Path: /api/restapi/projectCompany/batch
Batch Delete Project Companies: Method: delete
Path: /api/restapi/projectCompany/batch
Batch Sync Project Companies: Method: post
Path: /api/restapi/projectCompany/syncBatch
Batch Update Project Companies: Method: put
Path: /api/restapi/projectCompany/batch
Create a Project Company: Method: post
Path: /api/restapi/projectCompany
Delete a Project Company by Work Manager Task: Method: delete
Path: /api/restapi/projectCompany/{projectCompanyId}
Update a Project Company: Method: put
Path: /api/restapi/projectCompany
View a Project Company: Method: get
Path: /api/restapi/projectCompany/{projectCompanyId}
View all Project Companies by Code: Method: get
Path: /api/restapi/projectCompany/workspace/{workspaceCode}/project/{projectCode}
View all Project Companies by Company Name and Postal Code: Method: get
Path: /api/restapi/projectCompany/company/{companyName}/{postalCode}
View all Project Companies by Project: Method: get
Path: /api/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. Update Keys : 'projectDependencyId'

Batch Create Project Dependencies: Method: post
Path: /api/restapi/projectDependency/batch
Batch Delete Project Dependencies: Method: delete
Path: /api/restapi/projectDependency/batch
Batch Sync Project Dependencies: Method: post
Path: /api/restapi/projectDependency/syncBatch
Batch Update Project Dependencies: Method: put
Path: /api/restapi/projectDependency/batch
Create a Project Dependency: Method: post
Path: /api/restapi/projectDependency
Delete a Project Dependency: Method: delete
Path: /api/restapi/projectDependency/{projectDependencyId}
Update a Project Dependency: Method: put
Path: /api/restapi/projectDependency
View a Project Dependency: Method: get
Path: /api/restapi/projectDependency/{projectDependencyId}
View a Project Dependency by Codes: Method: get
Path: /api/restapi/projectDependency/itemCode
View all Project Dependencies by Parent: Method: get
Path: /api/restapi/projectDependency/supportedBy
View all Project Dependencies that Depend on a Specific Project: Method: get
Path: /api/restapi/projectDependency/dependsOn/project/{projectId}
View all Project Dependencies that Support a Specific Project: Method: get
Path: /api/restapi/projectDependency/supports/project/{projectId}

Project Measure Value

The Project Measure Value service enables you to send and retrieve information related to Project Measure Values.

View a Project Measure Value: Method: get
Path: /api/restapi/projectMeasureValue/{projectMeasureValueId}
View all Project Measure Values by Measure: Method: get
Path: /api/restapi/projectMeasureValue/measure/{measureId}
View all Project Measure Values by Project: Method: get
Path: /api/restapi/projectMeasureValue/project/{projectId}

Project Rank

The Project Rank service enables you to send and retrieve information related to a project's rank. Update Keys : 'projectRankId'

Batch Create Project Ranks: Method: post
Path: /api/restapi/projectRank/batch
Batch Sync Project Ranks: Method: post
Path: /api/restapi/projectRank/syncBatch
Batch Update Project Ranks: Method: put
Path: /api/restapi/projectRank/batch
Create a Project Rank: Method: post
Path: /api/restapi/projectRank
Update a Project Rank: Method: put
Path: /api/restapi/projectRank
View a Project Rank: Method: get
Path: /api/restapi/projectRank/{projectRankId}
View all Project Ranks by Project: Method: get
Path: /api/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. Update Keys : 'projectResourceWorkRateId'

Batch Create Project Resource Work Rates: Method: post
Path: /api/restapi/projectResourceWorkRate/batch
Batch Sync Project Resource Work Rates: Method: post
Path: /api/restapi/projectResourceWorkRate/syncBatch
Batch Update Project Resource Work Rates: Method: put
Path: /api/restapi/projectResourceWorkRate/batch
Create a Project Resource Work Rate: Method: post
Path: /api/restapi/projectResourceWorkRate
Update a Project Resource Work Rate: Method: put
Path: /api/restapi/projectResourceWorkRate
View a Project Resource Work Rate: Method: get
Path: /api/restapi/projectResourceWorkRate/{projectResourceWorkRateId}
View All Project Resource Work Rates by Parent: Method: get
Path: /api/restapi/projectResourceWorkRate/parentCode
View all Project Resource Work Rates by Project and Resource: Method: get
Path: /api/restapi/projectResourceWorkRate/project/{projectId}/resource/{resourceId}
View all Project Resource Work Rates by Project Resource: Method: get
Path: /api/restapi/projectResourceWorkRate/projectResource/{projectResourceId}
View Project Resource Work Rates by Project: Method: get
Path: /api/restapi/projectResourceWorkRate/project/{projectId}
View Project Resource Work Rates by Project and Workspace Code: Method: get
Path: /api/restapi/projectResourceWorkRate/workspace/{workspaceCode}/project/{projectCode}

Project Risk

Use the Project Risk service to create, view, update, and delete project risks. Update Keys : 'projectRiskId'

Batch Create Project Risks: Method: post
Path: /api/restapi/projectRisk/batch
Batch Delete Project Risks: Method: delete
Path: /api/restapi/projectRisk/batch
Batch Sync Project Risks: Method: post
Path: /api/restapi/projectRisk/syncBatch
Batch Update Project Risks: Method: put
Path: /api/restapi/projectRisk/batch
Create a Project Risk: Method: post
Path: /api/restapi/projectRisk
Delete a Project Risk: Method: delete
Path: /api/restapi/projectRisk/{projectRiskId}
Update a Project Risk: Method: put
Path: /api/restapi/projectRisk
View a Project Risk: Method: get
Path: /api/restapi/projectRisk/{projectRiskId}
View a Project Risk by Project and Risk Code: Method: get
Path: /api/restapi/projectRisk/project/{projectId}/riskCode/{riskCode}
View all Project Risks by Assigned CodeValue: Method: get
Path: /api/restapi/projectRisk/codeType/{codeTypeId}/codeValue/{codeValueCode}
View all Project Risks by Configured Field Value: Method: get
Path: /api/restapi/projectRisk/project/{projectId}/configuredField/{viewColumnName}/{value}
View all Project Risks by Name: Method: get
Path: /api/restapi/projectRisk/name/{riskName}
View all Project Risks by Project: Method: get
Path: /api/restapi/projectRisk/projectId/{projectId}
View all Project Risks in a Workspace: Method: get
Path: /api/restapi/projectRisk/workspace/{workspaceId}
View Project Risk Mitigation by Project Risk: Method: get
Path: /api/restapi/projectRisk/mitigation/{projectRiskId}
View Project Risk Weather Periods by Project Risk: Method: get
Path: /api/restapi/projectRisk/weatherPeriod/{projectRiskId}

Project Risk Mitigation

The Project Risk Mitigation service enables you to create, update, view, and delete project risk mitigations. Project Risk Mitigation is also referred to as Project Risk Response Action. Update Keys : 'riskMitigationId'

Batch Create Project Risk Mitigations: Method: post
Path: /api/restapi/riskMitigation/batch
Batch Delete Project Risk Mitigations: Method: delete
Path: /api/restapi/riskMitigation/batch
Batch Sync Project Risk Mitigations: Method: post
Path: /api/restapi/riskMitigation/syncBatch
Batch Update Project Risk Mitigations: Method: put
Path: /api/restapi/riskMitigation/batch
Create a Project Risk Mitigation: Method: post
Path: /api/restapi/riskMitigation
Delete a Project Risk Mitigation: Method: delete
Path: /api/restapi/riskMitigation/{riskMitigationId}
Update a Project Risk Mitigation: Method: put
Path: /api/restapi/riskMitigation
View a Project Risk Mitigation: Method: get
Path: /api/restapi/riskMitigation/{riskMitigationId}
View a Project Risk Mitigation by Code and Project Risk: Method: get
Path: /api/restapi/riskMitigation/projectRisk/{projectRiskId}/code/{riskMitigationCode}
View all Project Risk Mitigations by Code: Method: get
Path: /api/restapi/riskMitigation/code/{riskMitigationCode}
View all Project Risk Mitigations by Project ID: Method: get
Path: /api/restapi/riskMitigation/project/{projectId}

Project Risk Weather Period

The Project Risk Weather Period service enables you to create, update, view, and delete project risk weather periods. Update Keys : 'riskWeatherPeriodId'

Batch Create Project Risk Weather Periods: Method: post
Path: /api/restapi/riskWeatherPeriod/batch
Batch Delete Project Risk Weather Periods: Method: delete
Path: /api/restapi/riskWeatherPeriod/batch
Batch Sync Project Risk Weather Periods: Method: post
Path: /api/restapi/riskWeatherPeriod/syncBatch
Batch Update Project Risk Weather Periods: Method: put
Path: /api/restapi/riskWeatherPeriod/batch
Create a Project Risk Weather Period: Method: post
Path: /api/restapi/riskWeatherPeriod
Delete a Project Risk Weather Period: Method: delete
Path: /api/restapi/riskWeatherPeriod/{riskWeatherPeriodId}
Update a Project Risk Weather Period: Method: put
Path: /api/restapi/riskWeatherPeriod
View a Project Risk Weather Period: Method: get
Path: /api/restapi/riskWeatherPeriod/{riskWeatherPeriodId}
View all Project Risk Weather Periods by Period Name: Method: get
Path: /api/restapi/riskWeatherPeriod/code/{periodName}
View all Project Risk Weather Periods by Project ID: Method: get
Path: /api/restapi/riskWeatherPeriod/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: post
Path: /api/restapi/projectsAggregate/capitalPlan
View a Project Aggregate by Reference ID and Rollup Type: Method: get
Path: /api/restapi/projectsAggregate/reference/{referenceObjectId}/rollupType/{rollupType}
View a Project Aggregate by Rollup: Method: get
Path: /api/restapi/projectsAggregate/rollupId/{rollupId}

Reason

Use the Reason service to create, view, update, and delete reasons. Reasons provide justifications for recommitting to a task. Update Keys : 'reasonId'

Batch Create Reasons: Method: post
Path: /api/restapi/reason/batch
Batch Delete Reasons: Method: delete
Path: /api/restapi/reason/batch
Batch Sync Reasons: Method: post
Path: /api/restapi/reason/syncBatch
Batch Update Reasons: Method: put
Path: /api/restapi/reason/batch
Create a Reason: Method: post
Path: /api/restapi/reason
Delete a Reason: Method: delete
Path: /api/restapi/reason/{reasonId}
Update a Reason: Method: put
Path: /api/restapi/reason
View a Reason: Method: get
Path: /api/restapi/reason/{reasonId}
View a Reason by Workspace and Name: Method: get
Path: /api/restapi/reason/workspace/{workspaceId}/name/{reasonName}
View all Reasons by Workspace: Method: get
Path: /api/restapi/reason/workspace/{workspaceId}