Table of Contents

• Title and Copyright Information
• Introduction
• Security
• List of Updated Topics
• Integration Users
• Unifier Web Services
• Internationalization and Web Services
• General Validation Rules Across all Services
• General Limitations Across all Services
  • Pickers
  • File Size Limit for REST APIs
• Known Issues Across all Services
• Business Process (BP) Picker Support
• Business Process (BP) Record Data Processing Rules
• Creating and Updating Schedule Sheet through Primavera P6 Integration
  • Data Mapping
  • Associate CBS Codes with Activities
• Simple Object Access Protocol (SOAP) Web Services
  • Resource Manager Methods
    • Create or update Role
    • Get Role List
    • Create or update Resource
    • Get Resource List
  • Space Manager Methods
    • Create Level
    • Update Level
    • Get Level List
    • Create Space
    • Update Space
    • Get Space List
  • Planning Manager Methods
    • Get Planning Item Record
  • User Administration Methods
    • Create User
    • Update User
    • Get User List
    • Update User Group Membership
    • Update User Shell Membership
  • Schedule of Values (SOV) Methods
    • Get SOV
  • Exchange Rates Methods
    • Update Exchange Rates
    • Get Exchange Rates
  • Configurable Manager Methods
    • Create Records in Code and Records-based Generic Manager
    • Update Records in Code and Records-based Generic Manager
  • Shell Methods
    • Create Shell
    • Update Shell
    • Get Shell List
    • Get Project/Shell List
  • Schedule Manager Methods
    • Create Schedule Sheet Activities from Primavera P5 and P6 XML
    • Create Schedule Sheet Activities V2 from Oracle Primavera P6 XML
    • Create Schedule Activities from file V2
    • Update Schedule Sheet Activities from Oracle Primavera P5 and P6 XML
    • Update Schedule Sheet Activities V2 from Oracle Primavera P6 XML
    • Update Schedule Activities From File V2
    • Get Schedule Sheet Activities from Unifier
    • Get a List of Project Schedule Sheets
    • Get a List of Schedule Sheet Data Mappings
  • User Defined Reports (UDR) Methods
    • Get UDR Data
  • Cost Sheet Methods
    • Get Column Data
    • Update Column Data
  • Business Process (BP) Methods
    • Create BP Record
      • Create BP Record (Additional Information)
    • Create Complete BP Record
      • Create Complete BP Record (Additional Information)
    • Add BP Line Item
      • Add BP Line Item (Additional Information)
    • Add Complete BP Line Item
      • Add Complete BP Line Item (Additional Information)
    • Update BP Record
      • Update BP Record (Additional Information)
    • Update Complete BP Record
      • Update Complete BP Record (Additional Information)
    • Update BP Record V2
      • Update BP Record V2 (Additional Information)
    • Get BP Record
      • Get BP Record (Additional Information)
    • Get BP List
      • Get BP List (Additional Information)
    • Get Complete BP Record
      • Get Complete BP Record (Additional Information)
  • CBS Code Methods
    • Get CBS Structure
    • Create CBS Code
    • Get CBS Codes
    • Update CBS Codes
    • Sort Cost Sheet
• Accessing Representational State Transfer (REST) Services V1 and V2
  • Setting Up Integration Users with Basic Authentication
    • V1 Get Token REST Service for Basic Authentication
    • V2 Get Token REST Service for Basic Authentication
  • Setting Up Integration Users with OAuth Authentication
    • V1 Get Token REST Service for OAuth Authentication
    • V2 Get Token REST Service for OAuth Authentication
• Representational State Transfer (REST) Web Services V1
  • Document Manager
    • Folder Services
      • Create Folders by Path
      • Create Folders by Parent Folder ID
      • Update Folder Metadata by Path
      • Update Folder Metadata by Folder ID
      • Get Folders or Documents Metadata by Path
      • Get Folders or Documents Metadata by Parent Folder ID
      • Delete Folders by Node ID
    • Document Services
      • Create Documents by Path
      • Create Documents by Parent Folder ID
      • Update Document's Metadata by Path
      • Update Document Metadata by Document ID
      • Get Documents by Path
      • Get Documents by Parent Folder ID
      • Get Document as Tiff File
      • Get Document by File ID
      • Search Document or Folder Properties
      • Rename a Node by Node ID
      • Rename Unpublished Document by File ID
      • Delete Documents by Node ID
    • Get Node Permissions by Node Path and Project Number
    • Get Node Permissions by Node Path, Project Number, and User or Group
    • Add Node Permissions by Node Path and Project Number
    • Update Node Permissions by Node Path and Project Number
    • Remove Node Permissions by Node Path and Project Number
    • Remove Node Permissions by Node Path, Project Number, and User or Group
    • Set Permissions in Document Manager
      • Granting, Inheriting, and Pushing permissions to files or folders
      • Removing Permissions to Files or Folders
  • Business Processes
    • Fetch BP Record List
    • Get BP Record
    • Get BP Record With Attachments
    • Create BP Record
    • Update BP Record
    • Create BP Record with Attachment
    • Update BP Record with Attachment
    • Fetch BP Record List with filter_criteria
    • Payment Application with Auto-populate from SOV and Commits
    • Asynchronous Bulk BP Operations
    • Asynchronous REST Call Status
    • Fetch List of Attached Files in a BP
    • Download a Single Attached File in a BP
    • Download Multipart or Large Files
  • Shell Manager
    • Create Shell
    • Update Shell
    • Get Shell
    • Get BPs in Shell or Company
    • Get Project Shell List
  • Level
    • Authorization
    • Get Level List
    • Create Level
    • Update Level
    • Response Error Codes
  • Space
    • Authorization
    • Get Space List
    • Create Space
    • Update Space
    • Response Error Codes
  • Cost
    • Get CBS Codes
    • Create CBS Codes
    • Update CBS Codes
    • Get Column Data
    • Update Column Data
    • Sort Cost Sheet
  • Cash Flow
    • Authorization
    • Definitions or Values Used
    • Response Error Codes (REST API Details in Cash Flow)
    • Create Cash Flow
      • Create Cash Flow From Template Only
      • Create Cash Flow Manual - Project or Shell
      • Create Cash Flow Manual - CBS
      • Create Cash Flow Manual - Summary CBS
      • Create Cash Flow Manual - Commitment
      • Create Cash flow By WBS from Activity Sheet
    • Create Summary Curve
    • Create Rollup Cash Flows for Company
    • Update Rollup Cash Flows for Company
    • Delete Cash Flow
    • Delete Cash Flow Curve
    • Delete Cash Flow - Summary Curves
    • Get Cash Flow Data
    • Get Summary Cash Flow Data
    • Get Rollup Status
    • Get Rollup Status - for Template Cash Flows
    • Update Rollup Status
    • Update Rollup Status - For Template Cash Flows
    • Refresh Cash Flow
    • Get Cash Flow Refresh Job Status
    • Get Cash Flow Properties
    • Get Summary Cash Flow Properties
    • Get Cash Flow Permissions
    • Get Distribution Profiles
    • Create (Add User or Group) Cash Flow Permission
    • Delete (Remove User or Group) Cash Flow Permission
    • Update Cash Flow Properties
    • Update or Modify Cash Flow Permission
    • Update Cash Flow Data
    • Update Cash Flow Schedule
    • Create Distribution Profiles
    • Update Distribution Profiles
    • Delete Distribution Profiles
    • Refresh Cash Flow Curves
    • Get Cash Flow Permissions
  • Schedule Sheet
    • Get Schedule Sheet Data Mapping
    • Get Schedule Sheets
    • Update Schedule Activities
    • Response Codes
  • Exchange Rates
    • Get Exchange Rates
    • Update Exchange Rates
  • Data Structure Setup
    • Authorization
    • Get Data Elements
    • Create Data Element
    • Update Data Element
    • Delete Data Elements
    • Create DDS Definition
    • Update DDS Definition
    • Delete DDS Definition
    • Get DDS Definition
    • Create DDS Data
    • Update DDS Data
    • Delete DDS Data
    • Get DDS Data
    • Get Data Definition
    • Create Data Definition
    • Update Data Definition
    • Delete Data Definition
    • Response Error Codes
  • Partner Company
    • Get Partner Company
    • Create Partner Company
    • Update Partner Company
    • Update Partner Company Shortname
    • Add (Update) Partner Company Shell Membership
    • Remove (Update) Partner Company Shell Membership
  • User
    • Get User
    • Update User
    • Create User
    • Update User Shell Membership
    • Update User Group Membership
  • User Defined Report (UDR)
    • Passing Values to UDR
  • Get Templates List
    • Project or Shell Sample
  • Data
  • Data Format
  • Data Transfer
  • Event Driven Notification
    • Get Event Driven Notification
  • Funding
    • Get Funds List
    • Create Fund
    • Update Fund
    • Delete Fund
    • Manual Fund Consumption
    • Get Fund Columns
    • Get Fund Assignment Order
    • Get Fund Assignment Order for Cost Sheet
    • Update Fund Assignment Order
    • Update Fund Assignment Order for Cost Sheet
    • Update Fund Status
    • Get Fund Consumption for CBS Level SOV (Auto-Order / Auto-Ratio)
    • Update Fund Consumption for CBS Level SOV (Auto-Order / Auto-Ratio)
    • Response Error Codes (Funding REST API Details)
  • Non-Workflow BP Permissions
    • Get BP Records Permission
    • Update/Modify BP Records Permission
    • Create (Add User/Group) BP Records Permission
    • Delete (Remove User/Group) BP Records Permission
• Representational State Transfer (REST) Web Services V2
  • Document Manager
    • Get Document as a TIFF File
  • Business Processes
    • Create BP Record
    • Update BP Record
    • Create BP Record with Attachment
    • Update BP Record with Attachment
    • Payment Application with Auto-populate from SOV and Commits
    • Get BP Record Permission
    • Update BP Record Permission
    • Add Assignees to Workflow BP Records
    • Task Reassignment of Workflow Records
    • Bulk Create Records
    • Bulk Create Workflow BPs
    • Bulk Update Records
    • Bulk Reverse Auto-populate Records
    • Get Schedule of Values (SOVs) For Base Commit Type BPs
    • Terminate Workflow and Non-Workflow BP Records
    • Response Error Codes
  • Shell Manager
    • Create Shell
    • Update Shell
    • Get Shell
    • Get Project List
  • Mapped Projects
    • Create or Update Mapped External Projects
    • Get Mapped External Projects
  • WBS Sheet
    • Create WBS Code
    • Get External WBS Sheet Data
  • Master Rate Sheet
    • Create and Update Resources in the Master Rate Sheet
    • Create and Update Roles in the Master Rate Sheet
    • Get Resources from the Master Rate Sheet
    • Get Roles from the Master Rate Sheet
  • Cash Flow
    • Snapshots in Cashflow Summary Curves
      • Create Snapshot at the Summary Level Cashflow Worksheet
      • Delete Snapshot from Cashflow Curve
      • Get Snapshot Names for the Selected Cashflow
    • Snapshots of Cashflow Detail Curves
      • Create Snapshot of Cashflow Detail Curves
      • Delete an Existing Snapshot for Cashflow Summary Curves
      • Get Snapshot Names for Existing Summary Curves
  • Cost Sheet
    • Create Cost Sheet Snapshot
    • Get Names of Cost Sheet Snapshots
    • Create Work Package
    • Get Work Package
    • Update Work Package
    • Get Lock Status of Cost Sheet
    • Update Lock Status of Cost Sheet
  • Activities and Assignments
    • Create, Update, and Remove Assignments
    • Get Assignments
    • Create or Update Assignment Spreads
    • Get Assignment Spread
    • Get Activity Spread
    • Get Spread File
    • Get Spread Job Status
    • Create or Update Activity Spreads
    • Create, Update, and Remove Activities from the System Activity Sheet of a Specific Shell
    • Get Activities from the System Activity Sheet of a Specific Shell
    • Create, Update, and Delete Activities in the Manual Activity Sheet of a Specific Shell
    • Create Manual Activity Sheet
    • Create or Update Baseline Schedule for Manual Activity Sheet
    • Get Activities in the Manual Activity Sheet of a Specific Shell
    • Schedule Project for Manual Activity Sheet
    • Recost Project for Manual Activity Sheet
    • Create Activity Dependency
  • Oracle Integration
    • Callback API to Update Status of Integration Instance from Oracle Integration
• Codes Used in Web Services
  • Currency
    • Currencies and codes (A-G)
    • Currencies and codes (H-N)
    • Currencies and codes (O-T)
    • Currencies and codes (U-Z)
  • Time Zone
  • Date Format
  • User Type
  • Company Address
  • Status
  • Check Box
• Appendix A: Return Values