p6 eppm web services reference guide - oracle...p6 eppm web services reference guide activityowner...

PP66 EEPPPPMM WWeebb SSeerrvviicceess RReeffeerreennccee GGuuiiddee 1166 RR11

MMaarrcchh 22001166

Contents Activity Services ...................................................................................... 21 Activity Service ........................................................................................ 22

CreateActivities Operation .................................................................... 23 ReadActivities Operation ...................................................................... 23 UpdateActivities Operation ................................................................... 24 DeleteActivities Operation .................................................................... 24 CopyActivity Operation ........................................................................ 25 ReadAllActivitiesByWBS Operation ........................................................... 26 DissolveActivity Operation ..................................................................... 26 Activity Fields ................................................................................... 27

ActivityCodeAssignment Service ..................................................................... 60 CreateActivityCodeAssignments Operation ................................................. 61 ReadActivityCodeAssignments Operation ................................................... 61 UpdateActivityCodeAssignments Operation ................................................. 62 DeleteActivityCodeAssignments Operation ................................................. 62 ActivityCodeAssignment Fields................................................................ 63

ActivityComment Service ............................................................................. 65 CreateActivityComments Operation ......................................................... 66 ReadActivityComments Operation ............................................................ 66 ActivityComment Fields ........................................................................ 67

ActivityExpense Service ............................................................................... 69 CreateActivityExpenses Operation ........................................................... 70 ReadActivityExpenses Operation ............................................................. 70 UpdateActivityExpenses Operation ........................................................... 71 DeleteActivityExpenses Operation ........................................................... 71 ReadAllActivityExpensesByWBS Operation .................................................. 72 ActivityExpense Fields ......................................................................... 73

ActivityNote Service ................................................................................... 79 CreateActivityNotes Operation ............................................................... 79 ReadActivityNotes Operation ................................................................. 80 UpdateActivityNotes Operation ............................................................... 80 DeleteActivityNotes Operation ............................................................... 81 ActivityNote Fields ............................................................................. 82

ActivityOwner Service ................................................................................. 84 CreateActivityOwners Operation ............................................................. 85 ReadActivityOwners Operation ............................................................... 85 UpdateActivityOwners Operation ............................................................. 86 DeleteActivityOwners Operation ............................................................. 86

3

P6 EPPM Web Services Reference Guide

ActivityOwner Fields ........................................................................... 87 ActivityPeriodActual Service ......................................................................... 88

CreateActivityPeriodActuals Operation ...................................................... 89 ReadActivityPeriodActuals Operation ........................................................ 90 UpdateActivityPeriodActuals Operation ..................................................... 90 DeleteActivityPeriodActuals Operation ...................................................... 91 ActivityPeriodActual Fields .................................................................... 92

ActivityStep Service ................................................................................... 94 CreateActivitySteps Operation ................................................................ 95 ReadActivitySteps Operation .................................................................. 96 UpdateActivitySteps Operation ............................................................... 96 DeleteActivitySteps Operation ................................................................ 97 ActivityStep Fields .............................................................................. 98

ActivityStepTemplateItem Service ................................................................. 100 ReadActivityStepTemplateItems Operation ................................................ 101 ActivityStepTemplateItem Fields ............................................................ 102

ActivityStepTemplate Service ...................................................................... 103 ReadActivityStepTemplates Operation ..................................................... 104 ActivityStepTemplate Fields ................................................................. 105

Relationship Service .................................................................................. 106 CreateRelationships Operation .............................................................. 107 ReadRelationships Operation................................................................. 107 UpdateRelationships Operation .............................................................. 108 DeleteRelationships Operation ............................................................... 108 Relationship Fields ............................................................................. 109

ResourceAssignment Service ........................................................................ 113 CreateResourceAssignments Operation ..................................................... 114 ReadResourceAssignments Operation ....................................................... 114 UpdateResourceAssignments Operation .................................................... 115 DeleteResourceAssignments Operation ..................................................... 115 ReadAllResourceAssignmentsByWBS Operation ............................................ 116 ResourceAssignment Fields ................................................................... 117

ResourceAssignmentUpdate Service ............................................................... 137 CreateResourceAssignmentUpdates Operation ............................................ 138 ReadResourceAssignmentUpdates Operation .............................................. 138 UpdateResourceAssignmentUpdates Operation ........................................... 139 DeleteResourceAssignmentUpdates Operation ............................................ 139 ResourceAssignmentUpdate Fields .......................................................... 140

ResourceAssignmentCreate Service ................................................................ 143 CreateResourceAssignmentCreate Operation .............................................. 144 ReadResourceAssignmentCreate Operation ................................................ 144 UpdateResourceAssignmentCreate Operation ............................................. 145

4

Contents

DeleteResourceAssignmentCreate Operation .............................................. 145 ResourceAssignmentCreate ................................................................... 146

EPS Service ............................................................................................ 148 CreateEPS Operation .......................................................................... 149 ReadEPS Operation ............................................................................ 149 UpdateEPS Operation ......................................................................... 150 DeleteEPS Operation .......................................................................... 150 ReadProjectEPSPath Operation .............................................................. 151 ReadEPSPath Operation ....................................................................... 151 EPS Fields ....................................................................................... 152

ResourceAssignmentPeriodActual Service ......................................................... 175 CreateResourceAssignmentPeriodActuals Operation ..................................... 176 ReadResourceAssignmentPeriodActuals Operation ....................................... 177 UpdateResourceAssignmentPeriodActuals Operation ..................................... 177 DeleteResourceAssignmentPeriodActuals Operation ..................................... 178 ResourceAssignmentPeriodActual Fields ................................................... 179

CBS Service ............................................................................................ 181 CreateCBSs Operation ......................................................................... 182 ReadCBSs Operation ........................................................................... 182 UpdateCBSs Operation ........................................................................ 183 DeleteCBSs Operation ......................................................................... 183 CBS Fields ....................................................................................... 184

CBSDurationSummary Service ....................................................................... 185 CreateCBSDurationSummarys Operation ................................................... 186 ReadCBSDurationSummarys Operation ...................................................... 186 UpdateCBSDurationSummarys Operation ................................................... 187 DeleteCBSDurationSummarys Operation .................................................... 187 CBSDurationSummary Fields .................................................................. 188

AdminCategory Services ........................................................................... 191 BaselineType Service ................................................................................. 191

CreateBaselineTypes Operation ............................................................. 192 ReadBaselineTypes Operation ............................................................... 192 UpdateBaselineTypes Operation ............................................................. 193 DeleteBaselineTypes Operation.............................................................. 193 BaselineType Fields............................................................................ 194

DocumentCategory Service .......................................................................... 195 CreateDocumentCategories Operation ..................................................... 195 ReadDocumentCategories Operation ........................................................ 196 UpdateDocumentCategories Operation ..................................................... 196 DeleteDocumentCategories Operation ...................................................... 197 DocumentCategory Fields .................................................................... 198

5


DocumentStatusCode Service ....................................................................... 199 CreateDocumentStatusCodes Operation .................................................... 199 ReadDocumentStatusCodes Operation ...................................................... 200 UpdateDocumentStatusCodes Operation ................................................... 200 DeleteDocumentStatusCodes Operation .................................................... 201 DocumentStatusCode Fields .................................................................. 202

ExpenseCategory Service ............................................................................ 203 CreateExpenseCategories Operation ........................................................ 203 ReadExpenseCategories Operation .......................................................... 204 UpdateExpenseCategories Operation ....................................................... 204 DeleteExpenseCategories Operation ........................................................ 204 ExpenseCategory Fields ....................................................................... 205

NotebookTopic Service............................................................................... 206 CreateNotebookTopics Operation ........................................................... 206 ReadNotebookTopics Operation ............................................................. 207 UpdateNotebookTopics Operation ........................................................... 207 DeleteNotebookTopics Operation ........................................................... 208 NotebookTopic Fields ......................................................................... 209

ProjectResourceCategory Service .................................................................. 210 CreateProjectResourceCategories Operation .............................................. 211 ReadProjectResourceCategories Operation ................................................ 211 UpdateProjectResourceCategories Operation ............................................. 212 DeleteProjectResourceCategories Operation .............................................. 212 ProjectResourceCategory Fields ............................................................. 213

RiskCategory Service ................................................................................. 214 CreateRiskCategories Operation ............................................................. 214 ReadRiskCategories Operation ............................................................... 215 UpdateRiskCategories Operation ............................................................ 215 DeleteRiskCategories Operation ............................................................. 216 RiskCategory Fields ............................................................................ 217

ThresholdParameter Service ........................................................................ 218 ReadThresholdParameters Operation ....................................................... 219 ThresholdParameter Fields ................................................................... 220

UnitOfMeasure Service ............................................................................... 222 CreateUnitOfMeasures Operation ........................................................... 222 ReadUnitOfMeasures Operation .............................................................. 223 UpdateUnitOfMeasures Operation ........................................................... 223 DeleteUnitOfMeasures Operation ............................................................ 224 UnitOfMeasure Fields .......................................................................... 225

UserFieldTitle Service ................................................................................ 226 ReadUserFieldTitles Operation .............................................................. 227 UpdateUserFieldTitles Operation ............................................................ 227

6

Contents

UserFieldTitle Fields .......................................................................... 228 WBSCategory Fields .................................................................................. 229 WBSCategory Service ................................................................................. 230

CreateWBSCategories Operation ............................................................ 230 ReadWBSCategories Operation ............................................................... 231 UpdateWBSCategories Operation ............................................................ 231 DeleteWBSCategories Operation ............................................................. 232 WBSCategory Fields............................................................................ 233

Authentication Service ............................................................................ 234 Login Operation ....................................................................................... 235 Logout Operation ..................................................................................... 235 ReadDatabaseInstances Operation ................................................................. 236 ReadSessionProperties Operation .................................................................. 237 UpdateSessionProperties Operation ................................................................ 238

Code Services ........................................................................................ 239 ActivityCode Service ................................................................................. 239

CreateActivityCodes Operation .............................................................. 240 ReadActivityCodes Operation ................................................................ 240 UpdateActivityCodes Operation ............................................................. 241 DeleteActivityCodes Operation .............................................................. 241 ReadActivityCodePath Operation ............................................................ 241 ActivityCode Fields ............................................................................ 243

ActivityCodeType Service ........................................................................... 245 CreateActivityCodeTypes Operation ........................................................ 246 ReadActivityCodeTypes Operation .......................................................... 246 UpdateActivityCodeTypes Operation ....................................................... 247 DeleteActivityCodeTypes Operation ........................................................ 247 ActivityCodeType Fields ...................................................................... 248

ProjectCode Service .................................................................................. 250 CreateProjectCodes Operation .............................................................. 251 ReadProjectCodes Operation ................................................................ 251 UpdateProjectCodes Operation .............................................................. 252 DeleteProjectCodes Operation .............................................................. 252 ReadProjectCodePath Operation ............................................................ 253 ProjectCode Fields............................................................................. 254

ProjectCodeType Service ............................................................................ 256 CreateProjectCodeTypes Operation ........................................................ 257 ReadProjectCodeTypes Operation ........................................................... 257 UpdateProjectCodeTypes Operation ........................................................ 258 DeleteProjectCodeTypes Operation ......................................................... 258 ProjectCodeType Fields ....................................................................... 259

7


ProjectCodeUser Service ............................................................................ 260 ReadProjectCodeUsers Operation ........................................................... 261 ProjectCodeUser Fields ....................................................................... 262

ResourceCode Service ................................................................................ 263 CreateResourceCodes Operation ............................................................ 264 ReadResourceCodes Operation .............................................................. 264 UpdateResourceCodes Operation ............................................................ 265 DeleteResourceCodes Operation ............................................................ 265 ReadResourceCodePath Operation .......................................................... 266 ResourceCode Fields .......................................................................... 267

ResourceCodeType Service .......................................................................... 268 CreateResourceCodeTypes Operation ...................................................... 269 ReadResourceCodeTypes Operation ......................................................... 269 UpdateResourceCodeTypes Operation ...................................................... 270 DeleteResourceCodeTypes Operation ....................................................... 270 ResourceCodeType Fields ..................................................................... 271

UDFCode Service ...................................................................................... 272 CreateUDFCodes Operation .................................................................. 273 ReadUDFCodes Operation..................................................................... 273 UpdateUDFCodes Operation .................................................................. 274 DeleteUDFCodes Operation ................................................................... 274 UDFCode Fields ................................................................................. 275

UDFType Service ...................................................................................... 276 CreateUDFTypes Operation ................................................................... 277 ReadUDFTypes Operation ..................................................................... 277 UpdateUDFTypes Operation .................................................................. 278 DeleteUDFTypes Operation ................................................................... 278 ContainsProject Operation ................................................................... 279 UDFType Fields ................................................................................. 279

UDFValue Service ..................................................................................... 281 CreateUDFValues Operation .................................................................. 282 ReadUDFValues Operation .................................................................... 282 UpdateUDFValues Operation ................................................................. 283 DeleteUDFValues Operation .................................................................. 283 ReadCalculatedUDFValues Operation ....................................................... 284 UDFValue Fields ................................................................................ 285

EPS Services ......................................................................................... 289 EPSBudgetChangeLog Service ....................................................................... 289

CreateEPSBudgetChangeLogs Operation .................................................... 290 ReadEPSBudgetChangeLogs Operation ...................................................... 290 UpdateEPSBudgetChangeLogs Operation ................................................... 291

8

Contents

DeleteEPSBudgetChangeLogs Operation .................................................... 291 EPSBudgetChangeLog Fields .................................................................. 292

EPSFunding Service ................................................................................... 294 CreateEPSFundings Operation ................................................................ 294 ReadEPSFundings Operation .................................................................. 295 UpdateEPSFundings Operation ............................................................... 295 DeleteEPSFundings Operation ................................................................ 296 EPSFunding Fields .............................................................................. 297

EPSNote Service ....................................................................................... 298 CreateEPSNotes Operation ................................................................... 299 ReadEPSNotes Operation ..................................................................... 299 UpdateEPSNotes Operation ................................................................... 300 DeleteEPSNotes Operation ................................................................... 300 EPSNote Fields ................................................................................. 301

EPSSpendingPlan Service ............................................................................ 302 CreateEPSSpendingPlans Operation ......................................................... 303 ReadEPSSpendingPlans Operation ........................................................... 303 UpdateEPSSpendingPlans Operation ........................................................ 304 DeleteEPSSpendingPlans Operation ......................................................... 304 EPSSpendingPlan Fields ....................................................................... 305

Export Service ....................................................................................... 307 ExportProject Operation ............................................................................. 308 ExportProjects Operation ........................................................................... 310 BusinessObjectOptions Element .................................................................... 312

Global Services ...................................................................................... 366 Calendar Service ...................................................................................... 366

CreateCalendars Operation................................................................... 367 ReadCalendars Operation ..................................................................... 367 UpdateCalendars Operation .................................................................. 368 DeleteCalendars Operation ................................................................... 368 GetStandardTotalWorkHours Operation .................................................... 369 GetStandardTotalWorkHours ................................................................. 369 GetHolidayExceptionDates Operation ...................................................... 370 Calendar Fields ................................................................................. 371

CostAccount Service .................................................................................. 375 CreateCostAccounts Operation .............................................................. 376 ReadCostAccounts Operation ................................................................ 376 UpdateCostAccounts Operation .............................................................. 377 DeleteCostAccounts Operation .............................................................. 377 ReadCostAccountPath Operation ............................................................ 378 CostAccount Fields ............................................................................ 379

9


Currency Service ...................................................................................... 380 CreateCurrencies Operation .................................................................. 381 ReadCurrencies Operation .................................................................... 381 UpdateCurrencies Operation ................................................................. 382 DeleteCurrencies Operation .................................................................. 382 Currency Fields ................................................................................. 383

Document Service .................................................................................... 386 CreateDocuments Operation ................................................................. 387 ReadDocuments Operation ................................................................... 387 UpdateDocuments Operation ................................................................ 388 DeleteDocuments Operation ................................................................. 388 ReadDocumentPath Operation ............................................................... 389 Document Fields ............................................................................... 390

FinancialPeriod Service .............................................................................. 394 CreateFinancialPeriods Operation ........................................................... 395 ReadFinancialPeriods Operation ............................................................. 395 UpdateFinancialPeriods Operation .......................................................... 396 DeleteFinancialPeriods Operation ........................................................... 396 FinancialPeriod Fields ......................................................................... 397

FundingSource Service ............................................................................... 398 CreateFundingSources Operation ............................................................ 398 ReadFundingSources Operation .............................................................. 399 UpdateFundingSources Operation ........................................................... 399 DeleteFundingSources Operation ............................................................ 400 ReadFundingSourcePath Operation ......................................................... 400 FundingSource Fields .......................................................................... 401

GlobalPreferences Service .......................................................................... 402 ReadGlobalPreferences Operation .......................................................... 402 UpdateGlobalPreferences Operation ........................................................ 403 GlobalPreferences Fields ..................................................................... 404

GlobalReplace Service ............................................................................... 423 ReadGlobalReplace Operation ............................................................... 423 UpdateGlobalReplace Operation ............................................................ 424 GobalReplace Fields ........................................................................... 425

Location Service ...................................................................................... 426 CreateLocations Operation ................................................................... 426 ReadLocations Operation ..................................................................... 427 UpdateLocations Operation .................................................................. 427 DeleteLocations Operation ................................................................... 428 Location Fields ................................................................................. 429

OBS Service ............................................................................................ 431 CreateOBS Operation .......................................................................... 431

10

Contents

ReadOBS Operation ............................................................................ 432 UpdateOBS Operation ......................................................................... 432 DeleteOBS Operation .......................................................................... 433 ReadOBSPath Operation ...................................................................... 433 OBS Fields ....................................................................................... 434

ProjectDocument Service ............................................................................ 436 CreateProjectDocuments Operation ........................................................ 437 ReadProjectDocuments Operation .......................................................... 437 UpdateProjectDocuments Operation ........................................................ 438 DeleteProjectDocuments Operation ........................................................ 438 ProjectDocument Fields-updated ........................................................... 439

ResourceLocation Service ........................................................................... 441 CreateResourceLocations Operation ........................................................ 442 ReadResourceLocations Operation .......................................................... 442 UpdateResourceLocations Operation ....................................................... 443 DeleteResourceLocations Operation ........................................................ 443 ResourceLocation Fields ...................................................................... 444

Job Service ........................................................................................... 445 ApplyActuals Operation .............................................................................. 446 CancelJob Operation ................................................................................. 448 GetCurrentJobs Operation .......................................................................... 449 Level Operation ....................................................................................... 451 ReadJobLog Operation ............................................................................... 452 ReadJobStatus Operation ............................................................................ 453 RecalculateAssignmentCosts Operation ........................................................... 454 Schedule Operation .................................................................................. 456 StorePeriodPerformance Operation ................................................................ 458 SummarizeEPS Operation ............................................................................ 460 SummarizeProject Operation ....................................................................... 462 SendToUnifier Operation ............................................................................ 464 JobService Service .................................................................................... 465

CreateJobServices Operation ................................................................ 466 ReadJobServices Operation .................................................................. 466 pdateJobServices Operation ................................................................. 467 DeleteJobServices Operation ................................................................ 467 JobService Fields .............................................................................. 468

ScheduleCheckOption Service ...................................................................... 469 CreateScheduleCheckOptions Operation ................................................... 469 ReadScheduleCheckOptions Operation ..................................................... 470 UpdateScheduleCheckOptions Operation .................................................. 470 DeleteScheduleCheckOptions Operation ................................................... 471

11


ScheduleCheckOption Fields ................................................................. 472

Import Service ....................................................................................... 477 CreateNewProject Operation ....................................................................... 479 ImportProjects Operation ........................................................................... 484 UpdateExistingProject Operation .................................................................. 488

Project Services ..................................................................................... 492 Project Service ........................................................................................ 492

CreateProjects Operation .................................................................... 493 ReadProjects Operation....................................................................... 494 UpdateProjects Operation .................................................................... 494 DeleteProjects Operation ..................................................................... 495 CopyBaseline Operation....................................................................... 495 CopyProject Operation ........................................................................ 496 opyProjectAsBaseline Operation ............................................................. 498 CopyProjectAsReflection Operation ......................................................... 498 CopyWBSFromTemplate Operation .......................................................... 499 ConvertProjectToBaseline Operation ....................................................... 500 CalculateProjectScore Operation ............................................................ 501 CreateCopyAsTemplate Operation .......................................................... 504 CreateProjectFromTemplate Operation .................................................... 507 PublishProject Operation ..................................................................... 509 AssignProjectAsBaseline Operation.......................................................... 510 IsProjectLocked Operation ................................................................... 511 Project Fields ................................................................................... 512

BaselineProject Service .............................................................................. 559 CreateBaselineProject ........................................................................ 560 ReadBaselineProjects Operation ............................................................ 560 UpdateBaselineProjects Operation .......................................................... 561 DeleteBaselineProjects Operation ........................................................... 561 RestoreBaselineProject Operation .......................................................... 562 BaselineProject Fields......................................................................... 563

UpdateBaselineOption Service ...................................................................... 594 ReadUpdateBaselineOption Operation ...................................................... 594 UpdateUpdateBaselineOption Operation ................................................... 595 UpdateBaselineOption Fields ................................................................. 596

IssueHistory Service .................................................................................. 604 ReadIssueHistories Operation ................................................................ 605 IssueHistory Fields ............................................................................. 606

ProjectBudgetChangeLog Service .................................................................. 607 CreateProjectBudgetChangeLogs Operation ............................................... 608 ReadProjectBudgetChangeLogs Operation ................................................. 608

12

Contents

UpdateProjectBudgetChangeLogs Operation .............................................. 609 DeleteProjectBudgetChangeLogs Operation ............................................... 609 ProjectBudgetChangeLog Fields ............................................................. 610

ProjectCodeAssignment Service .................................................................... 612 CreateProjectCodeAssignments Operation ................................................. 613 ReadProjectCodeAssignments Operation ................................................... 613 UpdateProjectCodeAssignments Operation ................................................ 614 DeleteProjectCodeAssignments Operation ................................................. 614 ProjectCodeAssignment Fields ............................................................... 615

ProjectFunding Service .............................................................................. 617 CreateProjectFundings Operation ........................................................... 617 ReadProjectFundings Operation ............................................................. 618 UpdateProjectFundings Operation .......................................................... 618 DeleteProjectFundings Operation ........................................................... 619 ProjectFunding Fields ......................................................................... 620

ProjectIssue Service .................................................................................. 622 CreateProjectIssues Operation .............................................................. 623 ReadProjectIssues Operation ................................................................. 623 UpdateProjectIssues Operation .............................................................. 624 DeleteProjectIssues Operation ............................................................... 624 ProjectIssue Fields ............................................................................. 625

ProjectNote Service .................................................................................. 630 CreateProjectNotes Operation ............................................................... 631 ReadProjectNotes Operation ................................................................. 631 UpdateProjectNotes Operation .............................................................. 632 DeleteProjectNotes Operation ............................................................... 632 ProjectNote Fields-updated .................................................................. 633

ProjectPortfolio Service ............................................................................. 635 CreateProjectPortfolios Operation .......................................................... 636 ReadProjectPortfolios Operation ............................................................ 636 UpdateProjectPortfolios Operation ......................................................... 637 DeleteProjectPortfolios Operation .......................................................... 637 AddProjects Operation ........................................................................ 638 GetProjectObjectIds Operation .............................................................. 638 RemoveProjects Operation ................................................................... 639 ContainsProject Operation ................................................................... 639 HasPrivilege Operation ........................................................................ 640 ProjectPortfolio Fields-updated ............................................................. 641

ProjectResource Service ............................................................................. 643 CreateProjectResourceQuantities Operation .............................................. 644 ReadProjectResourceQuantities Operation ................................................ 644 UpdateProjectResourceQuantities Operation .............................................. 645

13


DeleteProjectResourceQuantities Operation .............................................. 645 ProjectResource Fields ........................................................................ 646

ProjectResourceQuantity Service .................................................................. 652 CreateProjectResources Operation ......................................................... 653 ReadProjectResources Operation ............................................................ 653 UpdateProjectResources Operation ......................................................... 654 DeleteProjectResources Operation .......................................................... 654 ProjectResourceQuantity Fields ............................................................. 655

ProjectSpendingPlan Service ........................................................................ 659 CreateProjectSpendingPlans Operation .................................................... 660 ReadProjectSpendingPlans Operation ...................................................... 660 UpdateProjectSpendingPlans Operation .................................................... 661 DeleteProjectSpendingPlans Operation..................................................... 661 ProjectSpendingPlan Fields-updated ........................................................ 662

ProjectThreshold Service ............................................................................ 664 CreateProjectThresholds Operation......................................................... 665 ReadProjectThresholds Operation ........................................................... 665 UpdateProjectThresholds Operation ........................................................ 666 DeleteProjectThresholds Operation ......................................................... 666 ProjectThreshold Fields ....................................................................... 667

ScheduleOptions Service ............................................................................. 673 ReadScheduleOptions Operation ............................................................ 674 UpdateScheduleOptions Operation .......................................................... 674 ScheduleOptions Fields ....................................................................... 675

WBS Service ........................................................................................... 684 CreateWBS Operation ......................................................................... 685 ReadWBS Operation ........................................................................... 685 UpdateWBS Operation ......................................................................... 686 CopyWBSFromTemplate Operation .......................................................... 687 DeleteWBS Operation ......................................................................... 687 ReadActivityWBSPath Operation ............................................................. 688 ReadWBSPath Operation ...................................................................... 688 ReadAllWBS Operation ........................................................................ 689 WBS Fields ...................................................................................... 690

WBSMilestone Service ................................................................................ 722 CreateWBSMilestones Operation ............................................................. 723 ReadWBSMilestones Operation ............................................................... 723 UpdateWBSMilestones Operation ............................................................ 724 DeleteWBSMilestones Operation ............................................................. 724 WBSMilestone Fields ........................................................................... 725

14

Contents

Resource Services .................................................................................. 727 Resource Service ...................................................................................... 727

CreateResources Operation .................................................................. 728 ReadResources Operation .................................................................... 729 UpdateResources Operation .................................................................. 729 DeleteResources Operation................................................................... 730 ReadResourcePath Operation ................................................................ 730 Resource Fields ................................................................................ 731

ResourceCodeAssignment Service .................................................................. 741 CreateResourceCodeAssignments Operation ............................................... 742 ReadResourceCodeAssignments Operation ................................................. 742 UpdateResourceCodeAssignments Operation .............................................. 743 DeleteResourceCodeAssignments Operation ............................................... 743 ResourceCodeAssignment Fields ............................................................. 744

ResourceCurve Service ............................................................................... 746 CreateResourceCurves Operation ........................................................... 747 ReadResourceCurves Operation .............................................................. 747 UpdateResourceCurves Operation ........................................................... 748 DeleteResourceCurves Operation ............................................................ 748 ResourceCurve Fields .......................................................................... 749

ResourceRate Service ................................................................................ 752 CreateResourceRates Operation ............................................................. 752 ReadResourceRates Operation ............................................................... 753 UpdateResourceRates Operation ............................................................ 753 DeleteResourceRates Operation ............................................................. 754 ResourceRate Fields ........................................................................... 755

ResourceRole Service ................................................................................ 758 CreateResourceRoles Operation ............................................................. 758 ReadResourceRoles Operation ............................................................... 759 UpdateResourceRoles Operation ............................................................ 759 DeleteResourceRoles Operation ............................................................. 760 ResourceRole Fields ........................................................................... 761

ResourceTeam Service ............................................................................... 763 CreateResourceTeams Operation ............................................................ 763 ReadResourceTeams Operation .............................................................. 764 UpdateResourceTeams Operation ........................................................... 764 DeleteResourceTeams Operation ............................................................ 765 AddProjects Operation ........................................................................ 765 GetProjectObjectIds Operation .............................................................. 766 RemoveResources Operation ................................................................. 766 ContainsProject Operation ................................................................... 767 ResourceTeam Fields .......................................................................... 768

15


RoleLimit Service ..................................................................................... 769 CreateRoleLimits Operation .................................................................. 770 ReadRoleLimits Operation .................................................................... 770 UpdateRoleLimits Operation ................................................................. 771 DeleteRoleLimits Operation .................................................................. 771 RoleLimit Fields ................................................................................ 772

RoleRate Service ...................................................................................... 773 CreateRoleRates Operation .................................................................. 773 ReadRoleRates Operation ..................................................................... 774 UpdateRoleRates Operation .................................................................. 774 RoleRate Fields ................................................................................. 775

Role Service ........................................................................................... 777 CreateRoles Operation ........................................................................ 778 ReadRoles Operation .......................................................................... 778 UpdateRoles Operation ....................................................................... 779 DeleteRoles Operation ........................................................................ 779 ReadRolePath Operation ...................................................................... 780 Role Fields ...................................................................................... 781

Shift Service ........................................................................................... 783 CreateShifts Operation ........................................................................ 784 ReadShifts Operation .......................................................................... 784 DeleteShifts Operation ........................................................................ 785 UpdateShifts Operation ....................................................................... 785 AddProjects Operation ........................................................................ 786 RemoveResources Operation ................................................................. 786 ContainsProject Operation ................................................................... 787 GetProjectObjectIds Operation .............................................................. 787 Shift Fields ...................................................................................... 788

Risk Services ......................................................................................... 790 ActivityRisk Service ................................................................................... 790

CreateActivityRisks Operation ............................................................... 791 ReadActivityRisks Operation ................................................................. 791 DeleteActivityRisks Operation ............................................................... 792 ActivityRisk Fields ............................................................................. 793

RiskImpact Service.................................................................................... 795 CreateRiskImpacts Operation ................................................................ 796 ReadRiskImpacts Operation .................................................................. 796 UpdateRiskImpacts Operation................................................................ 797 DeleteRiskImpacts Operation ................................................................ 797 RiskImpact Fields .............................................................................. 798

RiskMatrixScore Service .............................................................................. 799

16

Contents

CreateRiskMatrixScores Operation .......................................................... 800 ReadRiskMatrixScores Operation ............................................................ 801 UpdateRiskMatrixScores Operation .......................................................... 801 DeleteRiskMatrixScores Operation .......................................................... 802 RiskMatrixScore Fields ........................................................................ 803

RiskMatrix Service .................................................................................... 806 CreateRiskMatrices Operation ............................................................... 806 ReadRiskMatrices Operation .................................................................. 807 UpdateRiskMatrices Operation ............................................................... 807 DeleteRiskMatrices Operation ................................................................ 808 RiskMatrix Fields ............................................................................... 809

RiskMatrixThreshold Service ........................................................................ 810 CreateRiskMatrixThresholds Operation ..................................................... 811 ReadRiskMatrixThresholds Operation ....................................................... 811 DeleteRiskMatrixThresholds Operation ..................................................... 812 RiskMatrixThreshold Fields ................................................................... 813

RiskResponseAction Service ......................................................................... 814 CreateRiskResponseActions Operation ...................................................... 815 ReadRiskResponseActions Operation ........................................................ 815 DeleteRiskResponseActions Operation ...................................................... 816 UpdateRiskResponseActions Operation ..................................................... 816 RiskResponseAction Fields .................................................................... 817

RiskResponseActionImpact Service ................................................................. 821 CreateRiskResponseActionImpacts Operation ............................................. 822 ReadRiskResponseActionImpacts Operation ............................................... 822 UpdateRiskResponseActionImpacts Operation ............................................. 823 DeleteRiskResponseActionImpacts Operation ............................................. 823 RiskResponseActionImpact Fields ........................................................... 824

RiskResponsePlan Service............................................................................ 826 CreateRiskResponsePlans Operation ........................................................ 827 ReadRiskResponsePlans Operation .......................................................... 827 UpdateRiskResponsePlans Operation ........................................................ 828 DeleteRiskResponsePlans Operation ........................................................ 828 RiskResponsePlan Fields ...................................................................... 829

Risk Service ............................................................................................ 833 CreateRisks Operation ........................................................................ 834 ReadRisks Operation ........................................................................... 834 UpdateRisks Operation ........................................................................ 835 DeleteRisks Operation ......................................................................... 835 Risk Fields ....................................................................................... 836

RiskThresholdLevel Service .......................................................................... 840 CreateRiskThresholdLevels Operation ...................................................... 841

17


ReadRiskThresholdLevels Operation ........................................................ 841 UpdateRiskThresholdLevels Operation ...................................................... 842 DeleteRiskThresholdLevels Operation ...................................................... 842 RiskThresholdLevel Fields .................................................................... 843

RiskThreshold Service ................................................................................ 845 CreateRiskThresholds Operation ............................................................. 845 eadRiskThresholds Operation ................................................................ 846 UpdateRiskThresholds Operation ............................................................ 846 eleteRiskThresholds Operation .............................................................. 847 RiskThreshold Fields ........................................................................... 848

RoleTeam Service ................................................................................... 849 CreateRoleTeams Operation ........................................................................ 850 ReadRoleTeams Operation .......................................................................... 850 UpdateRoleTeams Operation........................................................................ 851 DeleteRoleTeams Operation ........................................................................ 851 AddProjects Operation ............................................................................... 852 GetProjectObjectIds Operation ..................................................................... 852 RemoveResources Operation ........................................................................ 853 ContainsProject Operation .......................................................................... 853 GetProjectObjectIds Operation ..................................................................... 854 RoleTeam Fields ...................................................................................... 855

Spread Service ...................................................................................... 857 ReadEPSSpread Operation ........................................................................... 858 ReadProjectSpread Operation ...................................................................... 867 ReadWBSSpread Operation .......................................................................... 876 ReadProjectResourceSpread Operation ........................................................... 885 ReadProjectRoleSpread Operation ................................................................. 892 ReadWBSResourceSpread Operation ............................................................... 898 ReadWBSRoleSpread Operation ..................................................................... 903 ReadResourceAssignmentSpread Operation ....................................................... 908 UpdateResourceAssignmentSpread Operation .................................................... 913 ReadActivitySpread Operation ...................................................................... 915

Timesheet Services ................................................................................. 922 OverheadCode Service ............................................................................... 922

CreateOverheadCodes Operation ............................................................ 923 ReadOverheadCodes Operation .............................................................. 923 UpdateOverheadCodes Operation ........................................................... 924 DeleteOverheadCodes Operation ............................................................ 924 OverheadCode Fields .......................................................................... 925

ResourceHour Service ................................................................................ 926 CreateResourceHours Operation ............................................................. 927

18

Contents

ReadResourceHours Operation ............................................................... 927 UpdateResourceHours Operation ............................................................ 928 DeleteResourceHours Operation ............................................................. 928 ResourceHour Fields ........................................................................... 929

TimesheetAudit Service .............................................................................. 933 ReadTimesheetAudits Operation ............................................................ 933 TimesheetAudit Fields ........................................................................ 934

TimesheetDelegate Service ......................................................................... 937 ReadTimesheetDelegates Operation ........................................................ 938 TimesheetDelegate Fields .................................................................... 939

TimesheetPeriod Service ............................................................................ 940 ReadTimesheetPeriods Operation ........................................................... 941 TimesheetPeriod Fields ....................................................................... 942

Timesheet Service .................................................................................... 943 CreateTimesheets Operation ................................................................. 944 ReadTimesheets Operation ................................................................... 944 UpdateTimesheets Operation ................................................................ 945 DeleteTimesheets Operation ................................................................. 945 Timesheet Fields ............................................................................... 946

User Services ........................................................................................ 948 User Service ........................................................................................... 948

CreateUsers Operation ........................................................................ 949 ReadUsers Operation .......................................................................... 949 UpdateUsers Operation ....................................................................... 950 DeleteUsers Operation ........................................................................ 950 ReadUserBaselines Operation ................................................................ 951 UpdateUserBaselines Operation ............................................................. 951 SetUserPassword Operation .................................................................. 952 SetMailServerPassword Operation ........................................................... 953 SetPrimaryBaselineProject Operation ...................................................... 953 GetPrimaryBaselineProject Operation ...................................................... 954 GetPrimaryBaselineProject Operation ...................................................... 954 SetPrimaryBaselineProject Operation ...................................................... 955 GetPrimaryBaselineProject Operation ...................................................... 955 SetPrimaryBaselineProject Operation ...................................................... 956 User Fields ...................................................................................... 957

GlobalProfile Service ................................................................................. 970 CreateGlobalProfiles Operation ............................................................. 971 ReadGlobalProfiles Operation ................................................................ 971 UpdateGlobalProfiles Operation ............................................................. 972 DeleteGlobalProfiles Operation .............................................................. 972

19


HasPrivilege Operation ........................................................................ 973 GlobalProfile Fields ............................................................................ 974 Global Privilege Definitions .................................................................. 976

ProjectProfile Service ................................................................................ 985 CreateProjectProfiles Operation ............................................................ 986 ReadProjectProfiles Operation .............................................................. 986 UpdateProjectProfiles Operation ............................................................ 987 DeleteProjectProfiles Operation............................................................. 987 ProjectProfile Fields........................................................................... 988 Project Privilege Definitions ................................................................. 990

ResourceAccess Service .............................................................................. 998 CreateResourceAccess Operation............................................................ 999 ReadResourceAccess Operation .............................................................. 999 DeleteResourceAccess Operation .......................................................... 1000 ResourceAccess Fields ....................................................................... 1001

UserInterfaceView Service ........................................................................ 1002 ReadUserInterfaceViews Operation ....................................................... 1003 UserInterfaceView Fields ................................................................... 1004

UserLicense Service ................................................................................ 1005 CreateUserLicenses Operation ............................................................. 1005 ReadUserLicenses Operation ............................................................... 1006 DeleteUserLicenses Operation ............................................................. 1006 UserLicense Fields ........................................................................... 1007

UserOBS Service ..................................................................................... 1008 CreateUserOBS Operation .................................................................. 1009 ReadUserOBS Operation .................................................................... 1009 UpdateUserOBS Operation .................................................................. 1010 DeleteUserOBS Operation................................................................... 1010 UserOBS Fields ............................................................................... 1011

For More Information ............................................................................. 1013 Where to Get Documentation ..................................................................... 1013 Documentation Accessibility ...................................................................... 1013 Where to Get Training ............................................................................. 1013 Where to Get Support .............................................................................. 1014

Legal Notices ....................................................................................... 1016

20

In This Section

Activity Service ........................................................................................................ 22 ActivityCodeAssignment Service ............................................................................. 60 ActivityComment Service ......................................................................................... 65 ActivityExpense Service .......................................................................................... 69 ActivityNote Service ................................................................................................ 79 ActivityOwner Service.............................................................................................. 84 ActivityPeriodActual Service .................................................................................... 88 ActivityStep Service ................................................................................................. 94 ActivityStepTemplateItem Service ......................................................................... 100 ActivityStepTemplate Service ................................................................................ 103 Relationship Service .............................................................................................. 106 ResourceAssignment Service................................................................................ 113 ResourceAssignmentUpdate Service .................................................................... 137 ResourceAssignmentCreate Service ..................................................................... 143 EPS Service .......................................................................................................... 148 ResourceAssignmentPeriodActual Service ............................................................ 175 CBS Service .......................................................................................................... 181 CBSDurationSummary Service ............................................................................. 185

Activity Services

21


Activity Service

Operations: CreateActivities Operation (on page 23) ReadActivities Operation (on page 23) UpdateActivities Operation (on page 24) DeleteActivities Operation (on page 24) CopyActivity Operation (on page 25) ReadAllActivitiesByWBS Operation (on page 26)

WSDL: Activity.wsdl Primary Key Field: ObjectId

Target Namespace: http://xmlns.oracle.com/Primavera/P6/WS/Activity/V1

Default Transport URLs:

http://:/p6ws/services/ActivityService?wsdl https://:/p6ws/services/ActivityService?wsdl

Java Client Stub Class: com.primavera.ws.p6.activity.ActivityService

Description: 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:

They can be subdivided into activity steps They often have activity expenses and resource assignments associated with them They have a parent WBS (Note: Activities assigned to the root WBS are considered to be

assigned to the project itself.) They can have user defined fields (UDFs) and codes assigned to them. To assign UDFs and

activity codes to an activity, use the UDFValue and ActivityCodeAssignment services, respectively.

22

Activity Services

CreateActivities Operation

Description: Creates multiple Activity objects in the database. You can create up to 1000 Activity objects with a single call.

Service: Activity Service (on page 22) Style: Document/literal wrapped

Input:

Message: CreateActivities Elements: Activity elements that contain Activity Fields (on page 27) fields

Required fields: You must supply either the ProjectObjectId or the WBSObjectId field when you use the CreateActivities operation. All other fields are optional.

Output:

Message: CreateActivitiesResponse Output: Zero to many ObjectId elements

ReadActivities Operation

Description: Reads Activity objects from the database.


Input:

Message: ReadActivities Elements: One to many field names from the Activity Fields (on page 27) field list You may also include an optional element that contains a filter clause and an optional element that contains an OrderBy clause. Warning: If you do not specify a filter, all business objects of this data type will be returned. Refer to the Filters topic in the P6 EPPM Web Services Programming Guide for additional details.

Output:

Message: ReadActivitiesResponse Output: Zero to many Activity elements that contain Activity fields.

23


UpdateActivities Operation

Description: Updates multiple Activity objects in the database. You can update up to 1000 Activity objects with a single call.


Input:

Message: UpdateActivities Elements: Activity elements that contain Activity Fields (on page 27) fields. Required fields: The ObjectId must be specified.

Output:

Message: UpdateActivitiesResponse Output: boolean

DeleteActivities Operation

Description: Deletes multiple Activity objects in the database. You can delete up to 1000 Activity objects with a single call.


Input:

Message: DeleteActivities Elements: One to many ObjectId elements

Output:

Message: DeleteActivitiesResponse Output: boolean

24

Activity Services

CopyActivity Operation

Description: This operation copies the activity to a project or a WBS. The WBS can be in the current project or in a different project. If both the project ObjectId and the WBS ObjectId are specified, the WBS ObjectId will take precedence.


Input:

Message: CopyActivity Elements:

ObjectId TargetProjectObjectId TargetWBSObjectId TargetActivityId CopyResourceAndRoleAssignments CopyRelationships CopyActivityCodes CopyActivityNotes CopyActivityExpenses CopyActivitySteps CopyProjectDocuments CopyPastPeriodActuals

Required fields You must supply the ObjectId and at least one of the following fields when you use the CopyActivity operation:

TargetProjectObjectId TargetWBSObjectId

All other fields are optional.

Output:

Message: CopyActivityResponse Elements: An ObjectId representing the unique identifier of the new activity.

25


ReadAllActivitiesByWBS Operation

Description: Reads Activity objects that are associated with the specified WBS or any descendant WBS from the database.


Input:

Message: ReadAllActivitiesByWBS Elements:

One WBSObjectId element One to many field names from the Activity Fields (on page 27) field list

You may also include an optional element that contains a filter clause and an optional element that contains an OrderBy clause. Warning: If you do not specify a filter, all business objects of this data type will be returned. Refer to the Filters topic in the P6 EPPM Web Services Programming Guide for additional details.

Output:

Message: ReadAllActivitiesByWBSResponse Output: Zero to many Activity elements that contain Activity Fields (on page 27) fields.

DissolveActivity Operation

Description: Deletes the activity without breaking the relationship chains. The successors of the activity will become successors of its predecessors, and the predecessors of the activity will become predecessors of its successors.


Input:

Message: DissolveActivity Elements:

ObjectId Output:

Message: DissolveActivityResponse Elements: boolean.

26

Activity Services

Activity Fields

Field

Type

Read Only

Filterable Orderable

Description

AccountingVariance

double X

The difference between the planned value of work scheduled and the actual cost of work performed. Computed as accounting variance = planned value - actual cost . A negative value indicates that actual costs have exceeded the scheduled costs.

AccountingVarianceLaborUnits

double X

The difference between the planned value of work scheduled and the actual work performed. Computed as accounting variance labor units = planned value labor units - actual units. A negative value indicates that actual costs have exceeded the scheduled costs.

ActivityOwnerUserId

int X X The unique user ID of the activity owner.

ActualDuration

double restricted to minInclusive(0.0)

The total working time from the activity actual start date to the actual finish date (for completed activities), or to the current data date (for in-progress activities). The actual working time is computed using the activity's calendar.

ActualExpenseCost

double X

The actual costs for all project expenses associated with the activity.

ActualFinishDate

dateTime X

The date on which the activity is actually finished.

ActualLaborCost

double

The actual costs for all labor resources assigned to the activity. If no resources are assigned,

27


computed as the activity actual labor units * project default price / time.

ActualLaborUnits

double X

The actual units for all labor resources assigned to the activity.

ActualMaterialCost

double X

The sum of all regular and overtime costs for material resources.

ActualNonLaborCost

double

The actual costs for all nonlabor resources assigned to the activity. If no resources are assigned, computed as the activity actual nonlabor units * project default price / time.

ActualNonLaborUnits

double X

The actual units for all nonlabor resources assigned to the activity.

ActualStartDate

dateTime X

The date on which the activity is actually started.

ActualThisPeriodLaborCost

double

The actual this period labor cost for all labor resources assigned to the activity.

ActualThisPeriodLaborUnits

double X

The actual this period labor units (hours) for all labor resources assigned to the activity.

ActualThisPeriodMaterialCost

double X

The sum of all material resource costs for the current period.

ActualThisPeriodNonLaborCost

double

The actual this period nonlabor cost for all nonlabor resources assigned to the activity. If no resources are assigned, computed as the activity actual nonlabor units * project default price / time.

ActualThisPeriodNonLaborUnits

double X

The actual this period nonlabor units (hours) for all nonlabor resources assigned to the activity.

ActualTotalCost

double X

The actual total cost for the activity, including labor resources, nonlabor resources, and project

28

Activity Services

expenses. Actual total cost = actual labor costs + actual nonlabor costs + actual expense costs.

ActualTotalUnits

double X

the sum of Actual Labor Units and Actual Nonlabor Units.

AtCompletionDuration

double restricted to minInclusive(0.0)

The total working time from the activity's current start date to the current finish date. The current start date is the planned start date until the activity is started, then it is the actual start date. The current finish date is the activity planned finish date while the activity is not started, the remaining finish date while the activity is in progress, and the actual finish date once the activity is completed. The total working time is computed using the activity's calendar.

AtCompletionExpenseCost

double X

The sum of the actual plus remaining costs for all expenses associated with the activity. Computed as actual expense cost + remaining expense cost.

AtCompletionLaborCost

double

The sum of the actual plus remaining costs for all labor resources assigned to the activity. Computed as actual labor cost + remaining labor cost. Same as the planned labor costs if the activity is not started and the actual labor costs once the activity is completed.

AtCompletionLaborUnits

double X

The sum of the actual plus remaining units for all labor resources assigned to the activity. Computed as actual labor units + remaining labor units. Same as the planned labor units if the activity is not started and the actual labor units once the activity is completed.

29


AtCompletionLaborUnitsVariance

double X

The project baseline planned total labor units minus the estimate at completion labor units.

AtCompletionMaterialCost

double X

The sum of all actual and remaining costs for material resources.

AtCompletionNonLaborCost

double

The sum of the actual plus remaining costs for all nonlabor resources assigned to the activity. Computed as actual nonlabor cost + remaining nonlabor cost. Same as the planned nonlabor costs if the activity is not started and the actual nonlabor costs once the activity is completed.

AtCompletionNonLaborUnits

double X

The sum of the actual plus remaining units for all nonlabor resources assigned to the activity. Computed as actual nonlabor units + remaining nonlabor units. Same as the planned nonlabor units if the activity is not started and the actual nonlabor units once the activity is completed.

AtCompletionTotalCost

double X

The total cost at completion for the activity, including labor resources, nonlabor resources, and project expenses. At completion total cost = at completion labor cost + at completion nonlabor cost + at completion expense cost.

AtCompletionTotalUnits

double X

The sum of the actual plus remaining units for the resource assignment on the activity.

AtCompletionVariance

double X

The difference between the project baseline total cost and the current estimate of total cost. Computed as VAC = BAC - EAC. A negative value indicates an estimated cost overrun. BAC is computed from the current project baseline.

AutoComputeActuals

boolean X

The option that determines whether the activity's actual and

30

Activity Services

remaining unit