The Activity service enables you to manage aspects of a project related to an activity. An activity is a unit of work performed during the course of a project. Activities have the following characteristics:
Activity codes are user-defined codes to classify and categorize activities according to the organization's and project's needs. They can be defined by project as well as globally across all projects. Activity codes are hierarchical objects.
For example, if your organization has more than one location, you can create a Location code type with values such as New York, Los Angeles, and Chicago. You can then associate activities with a specific location, such as New York.
You can define three types of activity codes, global activity codes, EPS activity codes, and project activity codes. You can assign global activity codes and values to activities in all projects. You can assign EPS activity codes and values to activities only in projects in the EPS for which the codes were created. You can assign project activity codes and values to activities only in the project for which the codes were created. Each activity code can have an unlimited number of values.
" }, { "name":"ActivityCodeAssignment", "description":"An activity code assignment business object represents the assignment of an activity code to an activity. For each activity code type, an activity may have zero or one activity codes assigned.
Note that this business object has a multi-part object ID; its object ID is a combination of its activity object ID and its activity code object ID.
" }, { "name":"ActivityCodeType", "description":"Activity code types provide a way of classifying activity codes. Activity codes are user-defined codes to classify and categorize activities according to the organization's and project's needs. For example, if your organization has more than one location, you can create a Location code type with values such as New York, Los Angeles, and Chicago. You can then associate activities with a specific location, such as New York. You can define activity codes at three different scopes: global activity codes, EPS activity codes, and project activity codes. You can assign global activity codes and values to activities in all projects. You can assign EPS and project activity codes and values to activities only in the EPS and project for which the codes were created. Each ActivityCode can have an unlimited number of values. You can change the scope of an ActivityCodeType from project to EPS, project to Global, and EPS to global. However, you cannot change the scope from EPS to project or from global to anything else. Within the EPS scope, you can always move an ActivityCodeType to a higher level in the EPS structure. However, moving it to a lower level or outside of the EPS hierarchy is possible only if the ActivityCodeType's values are not assigned to any activities. If the ActivityCodeType value assignment exists, an exception will be thrown.
" }, { "name":"ActivityComment", "description":"An activity comment business object represents a comment made on an activity.
" }, { "name":"ActivityExpense", "description":"Activity expenses are non-resource costs associated with a project and assigned to a project's activities. They are typically one-time expenditures for non-reusable items. Examples of expenses include materials, facilities, travel, overhead, and training.
You can categorize expenses, indicate a unit of measure for expenses, and specify whether an expense accrues at the start or end of an activity or uniformly over its duration. Each expense has a planned cost, actual cost, and estimated remaining cost.
Expenses are not the same as resources. Resources are time-based and generally extend across multiple activities and/or multiple projects. Examples of resources are personnel and equipment. Unlike resources, expenses are project-specific and they are not time-based. Expenses are not included when resources are leveled.
The ActivityExpense service supports user defined fields (UDFs). To assign UDFs to an activity expense, use the UDFValue service.
" }, { "name":"ActivityFilter", "description":"An activity filter business object represents a filter made for an activity.
" }, { "name":"ActivityNote", "description":"Use activity notes to specify one or more notes for an activity. You can specify one note on each activity for every notebook topic that exists. Notes can only be set as HTML.
" }, { "name":"ActivityOwner", "description":"Activity owner objects provide a way to specify a user to be in charge of an activity for statusing in P6. Instead of assigning resources to activities, a user is able to assign a specific user to the activity. The activity owner, in conjunction with Contributor module access, gives users similar capabilities as a resource with Contributor module access.
Note that this business object has a multi-part object ID; its object ID is a combination of its activity object ID and its user object ID.
" }, { "name":"ActivityPeriodActual", "description":"Activity period actuals represent the actual values on an activity during a financial period.
The following rules apply to activity period actuals:
Note that this business object has a multi-part object ID, which is a combination of its financial period object ID and its activity object ID.
" }, { "name":"ActivityRisk", "description":"The activity risk object stores the relationship between a single Activity and a single Risk.
Note that this business object has a multi-part object ID; its object ID is a combination of its activity object ID and its risk object ID.
" }, { "name":"ActivityStep", "description":"Activity steps provide a way to break activities down into smaller units and track the completion of those units. For example, the activity Prepare for System Integration and Testing might contain the following steps:
You can add as many steps to an activity as you need: some activities will require more steps to complete than others and some activities may require no additional steps at all. If progress occurs on the step, enter a percent complete or set the IsCompleted flag if the step is 100% complete. You can also assign additional information to steps, such as cost, start and finish dates, and text.
Weighted steps
Weighted steps enable you to track the progress of an activity based on the number of steps completed. When activity percent complete is specified to be based on activity steps, and physical is chosen as the activity's percent complete type, activity percent complete is updated based on the weight you assign to each activity step.
For example, in the activity Prepare for System Integration and Testing mentioned above, the steps are assigned weights of 3.0, 2.0, and 1.0 respectively. When you specify the step Establish Test Cases and Test Procedures to be complete, the activity's physical percent complete is updated to 50 percent (because the total weight for the steps in this activity is 6.0 and the weight for this step is 3.0; therefore, half the work on this activity, according to the weight of the steps, has been completed).
The ActivityStep service supports user defined fields (UDFs). Use the UDFValue service to assign UDFs.
" }, { "name":"ActivityStepTemplate", "description":"Activity step templates enable you to define a group of steps common to multiple activities, and then assign the template to activities. Your organization may have several activities that repeat within a project or across projects. For example, every time you start a project, several specifications must be written and approved. Developing a specification is a multi-step process that never changes.
As an example, the \"Write Specifications\" activity could have the following steps:
These steps may apply to many or all \"Write Specifications\" activities in a project or across all projects. Rather than manually inputting these steps into each \"Write Specifications\" activity, you can create an activity step template containing these steps and assign the template to each applicable activity at once. One activity step template may contain several activity steps. Each activity template step is represented by the ActivityStepTemplateItem business object.
This is a read-only business object.
" }, { "name":"ActivityStepTemplateItem", "description":"An activity step template item is one of the defined steps in the associated activity template. See the ActivityStepTemplate Service for more information about activity step templates. This is a read-only service.
The ActivityStepTemplateItem service supports user defined fields (UDFs). Use the UDFValue Service to read the associated UDF assignments.
" }, { "name":"BaselineProject", "description":"A baseline is a complete copy of a project plan that you can compare to the current schedule to evaluate progress. Baselines can be used to perform cost and schedule analysis. Before you update a schedule for the first time, you should create a baseline plan in the Project Management application.
The simplest baseline plan is a complete copy, or snapshot, of the original schedule. This snapshot provides a target against which you can track a project's cost, schedule, and performance. When you create a baseline, you can save a copy of the current project to use as the baseline or you can choose to convert another project in the EPS hierarchy to a baseline for the current project.
You can save an unlimited number of baselines per project; however, the number of baselines you can actually save per project is determined by administrative preference settings, which are typically controlled by the project controls coordinator or administrator. Regardless of the number of baselines you save for a project, at any given time you can select only up to three baselines for comparison purposes. The Baselines feature includes an option for you to specify which baselines you want to use for comparison. You must select a primary baseline. The primary baseline is used for project/activity usage spreadsheets and profiles, as well as earned value calculations. Second and third baselines are not required.
BaselineProjects may not be directly summarized by the summarizer job service. Baseline projects will have summary data if the summarizer job service was used to summarize the project that was used to create the baseline before the baseline was created. The StartDate and FinishDate fields are based on summary data.
This business object supports user defined fields (UDFs) and codes. Use the UDFValue business object to assign UDFs, and the ProjectCodeAssignment business object to assign ProjectCodes
" }, { "name":"BaselineType", "description":"Since the large number of baselines per project could be challenging to maintain, baseline types are introduced to help categorize, or track, multiple baselines for a single project. By assigning a type to a baseline that reflects its purpose, baseline types help you to maintain or track a large number of baselines in a project. For example, you could use the baseline types 'initial planning', 'what-if', and 'midproject' to organize a project's baselines. The BaselineType service enables you to create new baseline types or maintain (update, delete) existing ones. The BaselineType Service also allows you to load multiple associated BaselineProject objects from the database.
" }, { "name":"CBS", "description":"You can use Primavera Unifier to perform advanced cost, cash flow and earned value analysis on your P6 projects.
If your P6 deployment is integrated with Primavera Unifier, you can send P6 data to Primavera Unifier and import some data from Primavera Unifier back into P6. Once the link between a P6 project and a Primavera Unifier project and schedule sheet or summary sheet is set up, P6 will retrieve the Cost Breakdown Structure (CBS) from the Primavera Unifier project regularly.
" }, { "name":"CBSDurationSummary", "description":"Provides a summary of the actual, planned, and remaining: duration, finish date, start date, and percent complete for an activity in a CBS.
" }, { "name":"Calendar", "description":"Calendars defined the available work hours in each calendar day. Three types exist: global, resource, and project. Either resource or global calendars can be assigned to resources, and either global or project calendars can be assigned to activities.
You can specify national holidays, your organization's holidays, project-specific work/nonworkdays, and resource vacation days. Calendar assignments are used for activity scheduling, tracking, and resource leveling. Whether an activity uses its assigned calendar or the calendar of an assigned resource depends on the activity type you specify.
You can link resource and project calendars to global calendars. Then, if you make changes to a global calendar, your changes apply to all resource and project calendars that are linked to the modified global calendar.
" }, { "name":"CostAccount", "description":"Cost accounts contain the organization's cost account IDs. Available across all projects, they support tracking of costs and earned value based on the organization's cost account IDs. Cost accounts are hierarchical objects.
You can specify a project's default cost account. This cost account is used for resource assignments to activities and project expenses in the open project.
" }, { "name":"Currency", "description":"Currencies allow you to specify the types of currencies you want to use for costs. A currency type is set for every database. The user is able to specify the currency, its symbol, decimal symbol, number of decimal places, the positive and negative currency format and the digit grouping symbol.
" }, { "name":"Document", "description":"Documents are guidelines, procedures, standards, plans, design templates, worksheets, or other information related to a project. A document, or work product, can provide standards and guidelines for performing project work, or it can be formally identified as a project standard. Documents can be identified as project deliverables that will be given to the end user or customer at the end of the project. Documents can be assigned to activities and to work breakdown structure (WBS) elements. You can maintain general information about documents, such as revision date, location, and author. Documents are hierarchical objects.
The Document service supports user defined fields (UDFs). Use the UDFValue service to assign UDFs.
Note: This service provides create, read, update, and delete operations that apply to WP and Docs. You cannot assign external documents to an activity or WBS using this service.
" }, { "name":"DocumentCategory", "description":"Document categories are used to organize and standardize documents across projects.
" }, { "name":"DocumentStatusCode", "description":"Document status codes are used to identify and track the current state of work products and documents.
" }, { "name":"EPS", "description":"EPS (Enterprise Project Structure) is the hierarchical structure of projects in the database. It is used to perform top-down budgeting, manage multiple projects, implement coding standards, and maintain security throughout the enterprise. EPSs are hierarchical objects. EPS objects can only be deleted from the database if they and their EPS children have no child projects. To delete an EPS, you must first move or delete all projects that are children of that EPS or of that EPS node's EPS children.
The EPS service supports user defined fields (UDFs). Use the UDFValue service to assign UDFs.
" }, { "name":"EPSBudgetChangeLog", "description":"The EPS budget change log is used to track changes made from the original budget. You can set the status of the change as pending, approve or not approved, assign a responsible person, and specify the amount of the change. The EPS budget change log applies to EPS.
" }, { "name":"EPSFunding", "description":"An EPS funding represents the assignment of a funding source to a particular EPS. The assigned funding source has an amount and fund share, or percentage.
" }, { "name":"EPSNote", "description":"EPS notes are used as a way of specifying one or more notes on an EPS element. You may specify one note on each EPS for every notebook topic that exists.
" }, { "name":"EPSSpendingPlan", "description":"EPS spending plans represent monthly spending amounts for an EPS.
" }, { "name":"ExpenseCategory", "description":"Expense categories are used to categorize project expenses. They are used for standardizing expenses and for rolling up expenses across projects.
" }, { "name":"Export", "description":"This service lets you export one or more projects to XML. The ExportProject operation exports one project to XML, and the ExportProjects operation exports one or more projects to XML. For each project, the export includes the project and all related business objects supported by the exporter and in use in the project. For example, the project's activities, resource assignments, and associated resources are included. The Export service uses MTOM (Message Transmission Optimization Mechanism) to send the output files as attachments.
" }, { "name":"FinancialPeriod", "description":"Use customized financial periods to provide accurate display and reporting of actual units and costs. Rather than spreading costs evenly throughout the length of a project, users can view how actual costs were incurred by defining customized financial periods with a StartDate and EndDate. The minimum financial period duration is one day. Financial periods cannot overlap each other and do not have to be contiguous.
Past period actuals are stored at the activity and resource/role assignment level using the ActivityPeriodActual and ResourceAssignmentPeriodActual services.
You can not delete a financial period if there are existing activity or resource assignment period actual values stored. To delete a financial period with stored actual values, first use the ReadResourceAssignmentPeriodActuals operation of the ResourceAssignmentPeriodActual Service to load all resource assignment period actuals for that financial period, then delete each instance. Repeat the process for activity period actuals using the ReadActivityPeriodActuals operation of the ActivityPeriodActual Service.
" }, { "name":"FundingSource", "description":"Funding sources are hierarchical objects used to specify the names and descriptions of nonprofit, government-allocated, or other funding sources. You can assign funding sources to budgets as you develop projects.
" }, { "name":"GlobalPreferences", "description":"Global preferences are generally established by an administrator. There is only one global preferences object in the database and it cannot be deleted.
" }, { "name":"GlobalProfile", "description":"A global profile defines a set of privileges for access to global, or application-wide, information such as cost accounts, resources, and roles. To control user access to global information, you create global profiles, and then assign specific profiles to individual users. All users are required to have a global profile.
To allow complete access to all global information and all projects, a global profile called Admin Superuser is provided. You can assign the Admin Superuser profile to as many users as you like. However, since the Admin Superuser profile enables access to all information, you would typically restrict the number of users to whom you assign this profile.
" }, { "name":"GlobalReplace", "description":"P6 provides a way to replace data in multiple activities, WBS elements, and projects. You can configure a Global Search & Replace template to determine the data which will be replaced.
You can create a template to filter the data to be changed and specify what changes to make. You can save templates to be used later, and modify or delete templates. You can apply the changes and review the data before committing to the change. At the review stage, you can exclude certain rows from being changed and modify data in one or more rows before applying the change
" }, { "name":"Import", "description":"This service lets you import one or more projects from XML. The CreateProject operation imports one project from XML, and the ImportProjects operation imports one or more projects from XML. For each project, the import includes the project and all related business objects supported by the importer and in use in the project. For example, the project's activities, resource assignments, and associated resources are included.
" }, { "name":"ImportOptionsTemplate", "description":"Import options templates
" }, { "name":"IssueHistory", "description":"Issue histories represent the commentary recorded for a project issue. Separate entry comments are referenced by date and user who recorded the comment. Issue histories may only be added in the Project Management application.
" }, { "name":"Job", "description":"The Job service enables you to initiate and process specialized jobs asynchronously. You can check the status of a job by using the ReadJobStatus operation. To cancel a job, use the CancelJob operation. Note that cancelling the job has no effect if the job has already run.
" }, { "name":"JobService", "description":"You can import the byte array and data for the following job types:
Use lean tasks to integrate P6 with Oracle Primavera Cloud for lean task integration.
" }, { "name":"Location", "description":"The location dictionary is used to store address locations including latitude and longitude. These locations can be assigned to resources, projects and/or activities.
" }, { "name":"Login", "description":"Login Description" }, { "name":"Logout", "description":"Logout Description" }, { "name":"MSPTemplate", "description":"Import options templates.
" }, { "name":"NotebookTopic", "description":"Notebook topics are used to categorize notes on EPS, project, WBS, and activity objects. Notebook topics are defined globally, and are usually specified by an administrator.
" }, { "name":"OBS", "description":"The Organizational Breakdown Structure (OBS) is a hierarchical arrangement of an organization's management structure. User access and privileges to nodes and projects within the Enterprise Project Structure (EPS) hierarchy are implemented via a responsible manager defined in the enterprise-wide OBS hierarchy.
" }, { "name":"OverheadCode", "description":"Overhead codes are used to log timesheet hours for activities, which are not associated with any current projects.
" }, { "name":"Project", "description":"A project is a temporary endeavor undertaken to create a unique product, service, or result. Projects usually contain a work breakdown structure (WBS) and activities.
The Project service supports user defined fields (UDFs) and codes. Use the UDFValue Service to assign UDFs, and the ProjectCodeAssignment Service to assign project codes.
" }, { "name":"ProjectBudgetChangeLog", "description":"The project budget change log is used to track changes made from the original budget. You can set the status of the change as pending, approve or not approved, assign a responsible person, and specify the amount of the change. The project budget change log applies to each WBS and project.
" }, { "name":"ProjectCode", "description":"Project codes are user-defined codes to classify and categorize projects across the enterprise. They are defined globally. Project codes are hierarchical objects.
You can organize the projects in your EPS in groups according to specific categories, such as location and manager, using project codes. You can define unlimited hierarchical project codes to fulfill the filtering, sorting, and reporting requirements for your projects, and arrange them hierarchically for easier management and assignment.
The Project Codes dictionary is global to the entire enterprise. Assign a project code value to projects for each project code you create.
Use project codes to group projects, consolidate large amounts of information, and to distinguish one project from another. All projects assigned a value for a code are grouped by their corresponding values when you group and sort by project code in the Project Management application.
" }, { "name":"ProjectCodeAssignment", "description":"A project code assignment business object represents the assignment of a project code to a project. For each project code type, a project may have zero or one project codes assigned.
Note that this business object has a multi-part object ID; its object ID is a combination of its project object ID and its project code object ID.
" }, { "name":"ProjectCodeType", "description":"Project code types provide a way of classifying project codes. Project codes are user-defined codes to classify and categorize projects across the enterprise. They are defined globally.
You can organize the projects in your EPS in groups according to specific categories, such as location and manager, using project codes. You can define unlimited hierarchical project codes to fulfill the filtering, sorting, and reporting requirements for your projects, and arrange them hierarchically for easier management and assignment.
The Project Codes dictionary is global to the entire enterprise. Assign a project code value to projects for each project code you create.
Use project codes to group projects, consolidate large amounts of information, and to distinguish one project from another. All projects assigned a value for a code are grouped by their corresponding values when you group and sort by project code in the Project Management application.
" }, { "name":"ProjectDeployment", "description":"ProjectDeployment Description" }, { "name":"ProjectDocument", "description":"Documents are guidelines, procedures, standards, plans, design templates, worksheets, or other information related to a project. A document, or work product, can provide standards and guidelines for performing project work, or it can be formally identified as a project standard. Documents can be identified as project deliverables that will be given to the end user or customer at the end of the project. Documents can be assigned to activities and to work breakdown structure (WBS) elements. You can maintain general information about documents, such as revision date, location, and author. Documents are hierarchical objects.
This business object supports user defined fields (UDFs). Use the UDFValue business object to assign UDFs.
" }, { "name":"ProjectFunding", "description":"An project funding represents the assignment of a funding source to a particular project. The assigned funding source has an amount and fund share, or percentage.
" }, { "name":"ProjectIssue", "description":"Issues are known problems within a project plan that require attention or corrective action. You can manually create issues, or you can generate issues in the Project Management application by defining project thresholds. You can associate these issues with work breakdown structure (WBS) elements, activities, or resources.
When you add an issue, you can assign a priority level, tracking layout, and responsible manager to the issue. An issue's tracking layout assignment is helpful when you want to quickly open the tracking layout that best displays the problem area. An issue's responsible manager assignment identifies the person responsible for addressing the issue. You can record historical details for the issue and e-mail issue details, along with your notes and the issue's history, to any member of the project's staff.
This business object supports user defined fields (UDFs). Use the UDFValue business object to assign UDFs.
" }, { "name":"ProjectNote", "description":"Project notes are used as a way of specifying one or more notes on a project or WBS element. You may specify one note on each project or WBS for every notebook topic that exists.
" }, { "name":"ProjectPortfolio", "description":"A project portfolio consists of projects grouped together in some way that is meaningful to you. For example, one portfolio might contain projects that are the responsibility of a specific business unit, while another portfolio contains only projects budgeted for the next fiscal year.
There are two types of project portfolios: \"Manual\" and \"Filtered\". Manual portfolios contain zero or more projects that were specifically added. Filtered portfolios contain zero or more projects based on a filter that was specified in Primavera's Web application. The list of projects in a filtered portfolio is based on the results of the filter when it was first created. Only manual portfolios can be created through the Integration API, and their list of projects cannot be altered.
" }, { "name":"ProjectProfile", "description":"A project profile defines a set of privileges for access to project-specific information. Project profiles are assigned to users based on the OBS hierarchy. To control access to project-specific information, you create project profiles, and then assign specific OBS elements and associated project profiles to individual users. The assigned OBS element determines the EPS and WBS elements for which the user can access project information. The assigned project profile determines the type of access privileges the user has to that project information.
All WBS elements are required to have an assigned responsible OBS. If a user's project profile assignment includes a WBS element's responsible OBS, then the user can access all activities, risks, and issues related to that WBS element. Similarly, all thresholds and project issues also have an assigned responsible OBS. If a user's project profile assignment includes a threshold or issue's responsible OBS, then the user can access that threshold or issue.
A user is not required to have a profile for every project. However, unless a user's global profile is Admin Superuser, that user cannot access a project without a project profile. To allow complete access to a project/OBS assignment, a project profile is included named Project Superuser. You can apply the Project Superuser profile to as many users and for as many projects as you like.
" }, { "name":"ProjectResource", "description":"Primavera's resource planning feature allows you to do high-level project planning for future project or project that does not require resource assignments at the activity level. The resource planning feature allows you to allocate and manage resources at the project and WBS levels. If the LifeOfProjectFlag is true, the resource assignment is for the duration of the project, and so, if the project dates are pushed out, the resource assignment dates are pushed as well
If the LifeOfProjectFlag is false, the dates on the ProjectResource will be calculated from the dates on the child ProjectResourceQuantity objects.
" }, { "name":"ProjectResourceCategory", "description":"Project resource categories are used to categorize resource planning assignments.
" }, { "name":"ProjectResourceQuantity", "description":"The ProjectResourceQuantity object provides access to resource allocation hours per week for resources assigned to a project at the Project or WBS level. Usually there is one ProjectResourceQuantity object per week, and it corresponds to a record in the wbsrsrc_qty table. However, when a week contains days from more than one month, two ProjectResourceQuantity objects (and so, two records) will exist based on the two week fragments. They both have the same WeekStartDate but their MonthStartDate and week fragment data are different: The first ProjectResourceQuantity object holds data for the first week fragment, and its MonthStartDate has the same month as the WeekStartDate. The second ProjectResourceQuantity object holds data for the second week fragment, and its MonthStartDate is that of the next month.
Note that this business object has a multi-part object ID; its object ID is a combination of its project resource object ID, its week start date, its month start date, and its quantity.
" }, { "name":"ProjectSpendingPlan", "description":"Project spending plans represent monthly spending amounts for a project or WBS.
" }, { "name":"ProjectThreshold", "description":"Project thresholds are used as a project management technique to monitor values within a specified tolerance range so that project issues can be identified and reported. For example, a threshold could be used to monitor Start Date variance or Total Float values.
" }, { "name":"Relationship", "description":"A relationship defines how an activity relates to the start or finish of another activity or assignment. Add relationships between activities to create a path through your schedule from the first activity to the last activity. These relationships, which form the logic of the project network, are used together with activity durations to determine schedule dates. An activity can have as many relationships as necessary to model the work that must be done. You can also identify relationships between activities that are in different projects; this type of relationship is referred to as an external relationship.
" }, { "name":"Resource", "description":"Resources include the personnel and equipment that perform work on activities across all projects. Resources are always time-based and are generally reused between activities and/or projects. You can create a resource pool that reflects your organization's resource structure and supports the assignment of resources to activities. You can also distinguish between labor and nonlabor resources. You can create and assign resource calendars and define a resource's roles, contact information, and time-varying prices. If a resource uses Timesheets, you can also assign a login name and password to the resource.
A resource may be specified as a primary resource when assigning to activities. An activity's primary resource is typically the resource who is responsible for coordinating an activity's work. Using Timesheets, the primary resource also updates the activity's start date, finish date, and expected end date. In addition, if an activity has any nonlabor resources, the primary resource may also be responsible for reporting the nonlabor resource's hours/units as well. With the exception of nonlabor resources, all other resources are responsible for reporting their own hours for assigned activities.
" }, { "name":"ResourceAccess", "description":"Resource access allows you to restrict a user's ability to access resources. If the User.AllResourceAccessFlag is True, the user has access to all resources and resource access does not apply. If the User.AllResourceAccessFlag is False, the user has restricted resource access. In this case, the user is assigned to a resource in the resource hierarchy and that resource becomes the user's root resource access node. The position of the user's root resource access node in the hierarchy determines the user's resource access. The user has access to that root resource access node and all of its children, but no other resources above in the hierarchy. If the user is not assigned to any resources, that user does not have access to resources. Admin Superusers always have all resource access.
Note that project access overrides resource access. If a user can access a project, the user is able to see all resources assigned to that project. The user can then assign these resources anywhere but will only be able to edit them if the user has resource access to them.
Resource Access business objects may not be updated. To change the values on a Resource Access object, create a new object with the desired values and delete the old object.
" }, { "name":"ResourceAssignment", "description":"Resource assignments track the work of resources or roles that are performing various activities. A resource may be assigned to the same activity more than once, but performing in different roles.
The ResourceAssignment services supports user defined fields (UDFs). Use the UDFValue Service to assign UDFs.
" }, { "name":"ResourceAssignmentCode", "description":"Resource and role assignment codes are user-defined codes to classify and categorize resource and role assignments across the enterprise. They are defined globally.
With potentially hundreds of resources and roles being assigned to activities across an enterprise of projects, assignment codes provide another method for filtering the assignments you need to access quickly, or for grouping assignments for analysis and summarization in layouts. You can also use assignment codes to group, sort, and filter assignments in profiles and spreadsheets.
" }, { "name":"ResourceAssignmentCodeAssignment", "description":"An assignment code assignment business object represents the assignment of an assignment code to a resource or role assignment. For each assignment code type, an assignment may have zero or one assignment codes assigned.
Note that this business object has a multi-part object ID; its object ID is a combination of its resource assignment object ID and its resource assignment code object ID.
" }, { "name":"ResourceAssignmentCodeType", "description":"Resource and role assignment code types provide a way of classifying assignment codes. Assignment codes are user-defined codes to classify and categorize resource and role assignments across the enterprise. They are defined globally.
" }, { "name":"ResourceAssignmentCreate", "description":"Create resource assignments to track the work of resources or roles that perform various activities. The pending number of units, finish date, start date, and duration of a resource assignment may need approval to be overridden so that the resource assignment can reflect its actual values.,
" }, { "name":"ResourceAssignmentPeriodActual", "description":"Resource assignment period actuals represent the actual values on a resource assignment during a financial period.
The following rules apply for resource assignment period actuals:
Note that this business object has a multi-part object ID; its object ID is a combination of its financial period object ID and its resource assignment object ID.
" }, { "name":"ResourceAssignmentUpdate", "description":"Resource assignments track the work of resources or roles that are performing various activities. The pending number of units, finish date, start date, and duration of a resource assignment may need approval to be overridden so that the resource assignment can reflect its actual values.
" }, { "name":"ResourceCode", "description":"Resource codes are user-defined codes to classify and categorize resources across the enterprise. They are defined globally.
With potentially hundreds of resources being used across an enterprise of projects, codes provide another method for filtering the resources you need to access quickly, or for grouping resources for analysis and summarization in layouts. You can also use resource codes to group, sort, and filter resources in profiles and spreadsheets.
" }, { "name":"ResourceCodeAssignment", "description":"A resource code assignment business object represents the assignment of a resource code to a resource. For each resource code type, a resource may have zero or one resource codes assigned.
Note that this business object has a multi-part object ID; its object ID is a combination of its resource object ID and its resource code object ID.
" }, { "name":"ResourceCodeType", "description":"Resource code types provide a way of classifying resource codes. Resource codes are user-defined codes to classify and categorize resources across the enterprise. They are defined globally.
With potentially hundreds of resources being used across an enterprise of projects, codes provide another method for filtering the resources you need to access quickly, or for grouping resources for analysis and summarization in layouts. You can also use resource codes to group, sort, and filter resources in profiles and spreadsheets.
" }, { "name":"ResourceCurve", "description":"Resource curves enable you to specify how you want resource units or costs spread over the duration of an activity. Resource units and costs are distributed evenly during an activity unless you specify nonlinear distribution using curves.
You can assign a resource curve to any resource or role assignment on activities with a duration type of Fixed Duration and Units/Time or Fixed Duration and Units.
If timesheet data exists for the actuals, curves are ignored for the actuals and are spread using the timesheet data. Activities with timesheet data continue to spread the remaining units using the curve.
Notes
A resource hour corresponds to an entry on a timesheet edited in Timesheets. Resource hours may not be exported directly by the XMLExporter, but all child resource hours are exported automatically when exporting timesheets. Resource hours are read only.
" }, { "name":"ResourceLocation", "description":"The resource location is used to store the current location information including latitude and longitude for the resource. The current location of the Resource could be different from the Location indicated by the LocationObjectId field in Resource for a mobile resource. There can be only one resource location for each Resource for now.
" }, { "name":"ResourceRate", "description":"Resource rates provide a way of specifying multiple resource prices and maximum units per time values that vary over time.
" }, { "name":"ResourceRole", "description":"A resource role object represents an association between a resource object and a role object. A proficiency may be assigned to a resource role.
Note that this business object has a multi-part object ID; its object ID is a combination of its resource object ID and its role object ID.
" }, { "name":"ResourceTeam", "description":"A resource team consists of resources grouped together in some way that is meaningful to you.
" }, { "name":"Risk", "description":"The risk object represents a probabilistic event or condition which if it occurs has an impact (e.g. schedule, cost, quality, safety) on the project. Risks with negative impacts are threats; risks with positive impacts on the project are opportunities.
This business object supports user defined fields (UDFs). To assign UDFs to an activity expense, use the UDFValue service.
" }, { "name":"RiskCategory", "description":"The risk category object is used to categorize and organize project risks. A risk can only be associated with a single category. Categories help ensure a comprehensive and systematic way of identifying risks to a consistent level of detail and completeness. Technical, Operational, External are examples of risk categories that might apply to a typical project. Categories are global objects and are usually defined by an administrator.
" }, { "name":"RiskImpact", "description":"The risk impact object stores the pre-response qualitative value assigned to a risk for each of the risk thresholds.
Note that this business object has a multi-part object ID; its object ID is a combination of its risk object ID and its risk threshold object ID. The risk threshold object ID is set based on the value used in risk threshold level object ID.
" }, { "name":"RiskMatrix", "description":"The risk matrix object contains the name and description of each probability and impact diagram (PID). The Risk Matrix is then used to qualitatively assess each risk and assign a score.
" }, { "name":"RiskMatrixScore", "description":"The risk matrix score object stores the score values from the probability and impact diagram (PID) of the risk score matrix.
" }, { "name":"RiskMatrixThreshold", "description":"The risk matrix threshold object creates a relationship between a RiskThreshold object and a RiskMatrix object. This allows a single RiskThreshold object to be associated with multiple RiskMatrix objects.
Note that this business object has a multi-part object ID; its object ID is a combination of its risk threshold object ID and its risk score matrix object ID.
" }, { "name":"RiskResponseAction", "description":"The risk response action impact object is a post-risk response action qualitative value that is assigned to a risk for each of the risk thresholds.
Note that this business object has a multi-part object ID; its object ID is a combination of its risk response action object ID and its risk threshold object ID. The risk threshold object ID is set based on the value used in risk threshold level object ID.
" }, { "name":"RiskResponseActionImpact", "description":"The risk response action object contains the detailed steps that need to occur to complete the risk response plan.
Multiple actions can be associated with one response plan and each action can be linked to an activity in the project.
" }, { "name":"RiskResponsePlan", "description":"The risk response plan object communicates how the project team plans to address the identified risk. A risk that is categorized as a threat has four types of response plans: accept, avoid, reduce, and transfer. A risk that is an opportunity has four different types of response plans: enhance, exploit, facilitate, and reject. The response plan can be comprised of multiple detailed actions or steps.
" }, { "name":"RiskThreshold", "description":"The risk threshold object contains the name, description, and type of each risk threshold. Risk thresholds provide a mechanism for setting up the criteria that is used to assess the risk.
" }, { "name":"RiskThresholdLevel", "description":"The risk threshold level object stores the level information (e.g. Low, Medium, High) for each risk threshold.
" }, { "name":"Role", "description":"Roles are project personnel job titles or skills, such as mechanical engineer, inspector, or carpenter. They represent a type of resource with a certain level of proficiency rather than a specific individual. Roles can also be assigned to specific resources to further identify that resource's skills. For example, a resource may have a role of a engineer and manager.
You can create a set of roles to assign to resources and activities in all projects in the enterprise. You can establish an unlimited number of roles and organize them in a hierarchy for easier management and assignment. The set of roles you assign to an activity defines the activity's skill requirements.
You can temporarily assign roles during the planning stages of the project to see how certain resources affect the schedule. Once you finalize your plans, you can replace the roles with resources that fulfill the role skill levels. Five proficiency levels can be assigned to roles: Master, Expert, Skilled, Proficient and Inexperienced.
Roles are hierarchical objects.
" }, { "name":"RoleCode", "description":"Role codes are user-defined codes to classify and categorize roles across the enterprise. They are defined globally.
With potentially hundreds of roles being used across an enterprise of projects, codes provide another method for filtering the roles you need to access quickly, or for grouping roles for analysis and summarization in layouts. You can also use role codes to group, sort, and filter roles in profiles and spreadsheets.
" }, { "name":"RoleCodeAssignment", "description":"A role code assignment business object represents the assignment of a role code to a role. For each role code type, a role may have zero or one role codes assigned.
Note that this business object has a multi-part object ID; its object ID is a combination of its role object ID and its role code object ID.
" }, { "name":"RoleCodeType", "description":"Role code types provide a way of classifying role codes. Role codes are user-defined codes to classify and categorize roles across the enterprise. They are defined globally.
With potentially hundreds of roles being used across an enterprise of projects, codes provide another method for filtering the roles you need to access quickly, or for grouping roles for analysis and summarization in layouts. You can also use role codes to group, sort, and filter roles in profiles and spreadsheets.
" }, { "name":"RoleRate", "description":"Role rates enable you to select a predefined price per unit for cost calculating when assigning the role to an activity. Roles are project personnel job titles or skills, such as mechanical engineer, inspector, or carpenter. They represent a type of resource with a certain level of proficiency rather than a specific individual. As resources, now roles can have different rates assigned to provide more flexibility for cost calculation. See also RateType, RateSource, and RateSourcePreference for more details on how rates can be used in cost calculation.
" }, { "name":"ScheduleCheckOption", "description":"View potential issues in a schedule. For example, the report might identify missing logic or a large number of constraints in the schedule.
" }, { "name":"ScheduleOptions", "description":"Specifies how the associated project is to be scheduled.
Note that this business object has a multi-part object ID; its object ID is a combination of its user object ID and its project object ID.
You may not create or delete schedule options; they may only be loaded and updated.
" }, { "name":"Shift", "description":"Shifts are used to define shift calendars for resources. A shift is comprised of one or more shift periods. The total duration of all shift periods in a shift always adds up to 24 hours, with one hour being the minimum shift period.
Shift hours are considered when calculating units and prices during leveling. The resource calendar is used to determine when the resource can work; the limits for that period are determined from the shift definition for that resource. The minimum resource availability for every shift must satisfy the minimum demand for the resource so that the resource can be leveled properly. Limits defined outside the boundaries of the shift definition are ignored. Since shifts are defined at the resource level, all projects are leveled using that resource according to the shift definition.
" }, { "name":"Spread", "description":"You use the Spread service to read time-phased unit and cost data. This enables you to track resource usage and availability. There are two primary types of spreads: Summarized and Live. Summarized spreads are based on the data calculated during the last time the Summarizer job service ran on the particular EPS or Project being accessed. Summarized spreads include EPS, project, WBS, project resource, and project role spreads. Live spreads do not have a dependency on the Summarizer job service and are always calculated from the current data. Live spreads include activity spreads and resource assignment spreads.
" }, { "name":"SyncService", "description":"The Sync Service provides seamless integration between Oracle Primavera P6 EPPM and external systems through data synchronization. It supports read and write operations for key project data such as activities, projects, resources, and assignments.
" }, { "name":"ThresholdParameter", "description":"A threshold parameter is a measurement that is applied to activities or work breakdown structure (WBS) elements in a project to identify potential issues. To identify issues that you want to track, you can monitor a specific threshold parameter in the Project Management application and specify a lower and/or upper threshold value against which project data is evaluated. When a threshold parameter is equal to or less than the lower threshold value, or equal to or greater than the upper threshold value, an issue is automatically generated.
You use this service to read the parameters relating to a specific threshold.
" }, { "name":"Timesheet", "description":"Timesheets are used to allow resources to enter status.
This business object has a multi-part object ID; its object ID is a combination of its timesheet period object ID and its resource object ID.
" }, { "name":"TimesheetAudit", "description":"The timesheet audit class facilitates reading the timesheet audit records, added to the PM database as triggered by user activity, one record at a time. Fields that can be loaded on the TimesheetAudit object include information about the approval and rejection history (e.g., reviewers and review dates), information about the timesheets (e.g., number of overhead, overtime, and project hours), and information about the audit (e.g, the date the timesheet audit was created). Timesheet audits are readonly.
" }, { "name":"TimesheetDelegate", "description":"Timesheet delegates provide resource and project managers the ability to assign a user to process their timesheets as a delegate. After selecting a delegate for their resources or projects, the resource or project manager can activate and disable the delegate's approval rights at any time. Timesheet delegates for resource managers can review timesheets for resources to whom the resource manager has been assigned as a timesheet approval manager. Timesheet delegates for a project manager can review timesheets for resources who are assigned to activities within the project(s) for which the project manager has been granted approval rights. A project manager can delegate approval rights to different users for each project.
TimesheetDelegates are readonly.
" }, { "name":"TimesheetPeriod", "description":"Timesheet periods indicate both the start date and duration of a group of assigned timesheets. Timesheet periods are read only.
" }, { "name":"UDFCode", "description":"UDF codes, also known as issue codes, allow you to organize and categorize project issues in a way that is meaningful to you. Their UDF type is 'Code.' For example, you can create a UDF Code, Severity, and subsequently create code values: 'High', 'Medium', and 'Low'. You can assign each of these code values to project issues across multiple projects, enabling you to categorize each project issue according how severe it is. UDF codes are stored in a non-hierarchical list.
" }, { "name":"UDFType", "description":"User-defined fields (UDFs) enable users to add custom fields and values to the project database. For example, additional activity data, such as delivery dates and purchase order numbers, can be tracked. Business objects that support UDFs are Activity, ActivityExpense, ActivityStep, ActivityStepTemplateItem, Document, Project, ProjectIssue, ProjectRisk, Resource, ResourceAssignment, and WBS. Note that UDFs with a data type of Code may only be assigned to ProjectIssues.
Use the UDFValue Service to assign a UDF to a particular business object.
" }, { "name":"UDFValue", "description":"A user defined field value represents the value of a particular user defined field when assigned to another business object. The ForeignObjectId field represents the ObjectId of the business object to which the UDF is assigned. Note that the type of the foreign business object must match the subject area of the associated UDFType.
" }, { "name":"UnitOfMeasure", "description":"The unit of measure provides definitions of units of measure for material resources. There are three types of resources. The unit of measure for labor and nonlabor resources is time. The unit of measure for material resources is defined by the UnitOfMeasure object.
" }, { "name":"UpdateBaselineOption", "description":"As a project progresses, you may want to update baseline data without restoring the baseline or creating a new baseline. When a project is in progress, creating a new baseline may not yield accurate comparison results. When you update a baseline, only the data types you select will be updated.
" }, { "name":"User", "description":"The set of application users who are allowed to use the system. Each user is assigned a global security profile and project security profile.
Note that the Password and MailServerPassword fields are writable fields only; these fields may not be loaded from the database and are therefore not included in the AllFields array. A user may only change his own password, and only if the old password is specified. An administrator may change any user's password and does not have to specify the user's old password when doing so.
" }, { "name":"UserFieldTitle", "description":"User fields enable you to add your own custom fields and values to the project database. For example, you can track additional activity data, such as delivery dates and purchase order numbers, or resource and cost-related data, such as profit, variances, and revised budgets.
In the Project Management application you can display custom user fields in the columns of the Activity Table and then print the layout. You can also group, sort, filter, and summarize by user field, as well as add user fields to reports you create. Use Global Change to assign values to Activity and Activity Resource Assignments type user fields.
You may not create or delete user field titles; they may only be loaded and updated.
" }, { "name":"UserInterfaceView", "description":"A user interface view is a customized view of P6 Web Access that enables and disables access to P6 Web Access functionality. You can assign a single user interface view to multiple users. However, every user has exactly one user interface view. The system assigns a default user interface view if one has not been specified for the user.
If you set the EnableUserToModifyViewSettingsFlag field in the User object to true, users can modify their copy of the user interface view. When a user changes the user interface view settings, the changes do not affect the settings of other users assigned to the same view.
When you assign a user interface view to a user, the new view replaces the user's current user interface view, including any modifications they may have made to the view.
" }, { "name":"UserLicense", "description":"A user license grants access to applications within the Primavera suite.
UserLicense business objects may not be updated. To change the values on a UserLicense object, create a new object with the desired values and delete the old object.
" }, { "name":"UserOBS", "description":"A UserOBS object represents an association between a user object and an OBS object. Users are assigned to global OBS elements to define the scope of project and EPS security for the users. For a user to have access to a project or EPS, the user must be assigned to an OBS element within that project or EPS. (Or, the user must have Admin Superuser privileges.) This gives the user access to any WBS areas their assigned OBS is responsible for.
" }, { "name":"WBS", "description":"The project work breakdown structure (WBS) is a hierarchical arrangement of the products and services produced during and by a project. Each element of a WBS may contain more-detailed WBS elements, activities, or both. WBS are hierarchical objects.
This business object supports user defined fields (UDFs). Use the UDFValue business object to assign UDFs.
" }, { "name":"WBSCategory", "description":"As their name implies, WBS categories are used to categorize WBS elements. They are defined globally.
" }, { "name":"WBSMilestone", "description":"WBS milestones are weighted milestones assigned at the WBS level that can be used for calculating performance percent complete
For each WBS element, set the EarnedValueComputeType to be WBS_MILESTONES_PERCENT_COMPLETE, then define as many milestones as you need and assign a level of significance or weight to each of them. As progress occurs and you mark each milestone complete, the WBS element's performance percent complete is calculated based on the weight of the milestone, independent of its lower-level activities.
" }, { "name":"WbsReviewers", "description":"The WBS Reviewers endpoint enables users to add or update reviewers for specific WBS elements within a project. It supports assigning users independently of project-level reviewers, facilitating distinct review workflows at the WBS level.
" } ], "paths":{ "/activityCodeAssignment":{ "get":{ "tags":[ "ActivityCodeAssignment" ], "summary":"Read ActivityCodeAssignments", "description":"Reads ActivityCodeAssignment objects from the database.", "operationId":"getActivityCodeAssignments", "parameters":[ { "name":"Filter", "in":"query", "description":"Supported Filter Operators - :gt:, :lt:, :eq:, :gte:, :lte:, :and:, :or:", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "example":"ObjectId IN(1,2) :and: CreateDate:gte:'2021-04-20' :and: LastUpdateDate:lt:'2022-04-20' :and: Name :like: 'abc%'" }, { "name":"Fields", "in":"query", "description":"Fields to load", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "example":"Name,ObjectId" }, { "name":"OrderBy", "in":"query", "description":"OrderBy condition", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "example":"ObjectId desc" }, { "name":"Authorization", "in":"header", "description":"OAuth token", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "200":{ "description":"OK.", "content":{ "application/json":{ "schema":{ "title":"ListA list of activityCodeAssignment objects.
Required fields: You must supply both the ActivityCodeTypeObjectId and ActivityObjectId fields when you use the Update ActivityCodeAssignments operation. All other fields are optional.
", "content":{ "application/json":{ "schema":{ "title":"ListA list of activityCodeAssignment objects.
Required fields: You must supply both the ActivityCodeTypeObjectId and ActivityObjectId fields when you use the Delete ActivityCodeAssignments operation. All other fields are optional.
", "content":{ "application/json":{ "schema":{ "title":"ListA list of activityPeriodActuals objects.
Required fields: You must supply both the ActivityObjectId and FinancialPeriodObjectId fields when you use the Update ActivityPeriodActuals operation. All other fields are optional.
", "content":{ "application/json":{ "schema":{ "title":"ListA list of activityPeriodActuals objects.
Required fields: You must supply both the ActivityObjectId and FinancialPeriodObjectId fields when you use the Delete ActivityPeriodActuals operation. All other fields are optional.
", "content":{ "application/json":{ "schema":{ "title":"ListA list of ActivityRisk objects.
Required fields: You must supply both the ActivityObjectId and RiskObjectId fields when you use the Delete ActivityRisk operation. All other fields are optional.
", "content":{ "application/json":{ "schema":{ "title":"ListA list of projectcodeassignment objects.
Required fields: You must supply both the ProjectCodeObjectId and ProjectObjectId fields when you use the Update projectcodeassignment operation. All other fields are optional.
", "content":{ "application/json":{ "schema":{ "title":"ListA list of projectcodeassignment objects.
Required fields: You must supply both the ProjectCodeObjectId and ProjectObjectId fields when you use the Delete projectcodeassignment operation. All other fields are optional.
", "content":{ "application/json":{ "schema":{ "title":"ListA list of projectResourceQuantity objects.
Required fields: You must supply both the ProjectResourceObjectId, WeekStartDate and Quantity fields when you use the Update ProjectResourceQuantity operation. All other fields are optional.
", "content":{ "application/json":{ "schema":{ "title":"ListA list of projectResourceQuantity objects.
Required fields: You must supply both the ProjectResourceObjectId, WeekStartDate and Quantity fields when you use the Delete ProjectResourceQuantity operation. All other fields are optional.
", "content":{ "application/json":{ "schema":{ "title":"List