DocumentationWorkfrontWorkfront Guide

What’s New in API Version 6

Last update: Tue Nov 07 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer

New Objects

Resource Manager

Fields
References
Collections
Search
Actions
Queries
Operations
ID
customer
Add
customerID
project
Count
projectID
resourceManager
Delete
resourceManagerID
template
Get
templateID
Report
Search

Ews

Fields
References
Collections
Search
Actions
Queries
Operations
fileName
upload
handle
objCode

Custom Label

Fields
References
Collections
Search
Actions
Queries
Operations
ID
checkDelete
customLabels
Add
inUseByOtherLayoutTemplate
userCustomLabels
Count
removeCustomLabel
Delete
Get
Report
Search

Updated Objects

Changes to existing objects: additions are simply listed, removals have strikethrough, changes to existing have an attached note after the table

Update

Fields
References
Collections
Search
Actions
Queries
Operations
updateType1
sinceDate
objectUpdatesByCommentID2

1 Changes to possible values

2 hasFilters attribute changed to true

Approval

Fields
References
Collections
Search
Actions
Queries
Operations
completedHours
resourceManagers
resourceManagerIDs
constraintDate1
isOriginalPlannedHoursSet
syncBurndownDate
workRequired2

1 Date validation added

2 NOT_FILTERABLE flag added

Approval Process

Fields
References
Collections
Search
Actions
Queries
Operations
attachedApprovalPaths

Approval Step

Fields
References
Collections
Search
Actions
Queries
Operations
approvalType1

1 Changes to possible Values

Approval Path1

Fields
References
Collections
Search
Actions
Queries
Operations
approvedStatus
Add
approvedStatusLabel
Count
comment
Delete
enteredByID
Edit
entryDate
Get
globalPathID
Report
isPrivate
Search
lastUpdateDate
lastUpdateByID
name2

1 Changed to Reportable

2 Added Max Length Validator

Work Service Object

Fields
References
Collections
Search
Actions
Queries
Operations
constraintDate1
getMyWorkCountFiltered
workRequired2
workItemStatusLabels

1 Date Validation Added

2 Not_Filterable Flag Added

Assignment

Fields
References
Collections
Search
Actions
Queries
Operations
assignUserToRoleOnProjects
swapUsersOnProjects
unassignUserFromProjects

Baseline

Fields
References
Collections
Search
Actions
Queries
Operations
workRequired1

1 Not_Filterable Flag Added

Baseline Task

Fields
References
Collections
Search
Actions
Queries
Operations
workRequired1

1 Not_Filterable Flag Added

Billing Record

Fields
References
Collections
Search
Actions
Queries
Operations
billingDate1

1 added NO_TIME field flag

Burndown Event

Fields
References
Collections
Search
Actions
Queries
Operations
eventInitiator
ADD
DELETE

Category

Fields
References
Collections
Search
Actions
Queries
Operations
getCascadingRules
reorderCategories

Custom Enum

Fields
References
Collections
Search
Actions
Queries
Operations
getGroupDefaultProjectStatus
opTaskGroupStatuses
isPossibleToUnlockStatus
projectGroupStatuses
taskGroupStatuses

Document

Fields
References
Collections
Search
Actions
Queries
Operations
checkedOutByID
checkedOutBy
isDir
isDir

Exchange Rate

Fields
References
Collections
Search
Actions
Queries
Operations
rate1

1 Changed PRECISION validator for 8 to 9

Integration

Fields
References
Collections
Search
Actions
Queries
Operations
syncBurndownDate

Journal Entry

Fields
References
Collections
Search
Actions
Queries
Operations
changeType1

1 Changes to possible Values

Optask (Issue)1

Fields
References
Collections
Search
Actions
Queries
Operations
workRequired2

1 Flagged as RESTORABLE

2 Not_Filterable Flag Added

Project1

Fields
References
Collections
Search
Actions
Queries
Operations
completedHours
openOpTasks
openOpTasks
isOriginalPlannedHoursSet
resourceManagers
resourceManagerIDs
originalWorkRequired
work
syncBurndownDate
work
workRequired

1 Flagged as RESTORABLE and RESOURCE_MANAGEABLE

2 Not_Filterable Flag Added

Task1

Fields
References
Collections
Search
Actions
Queries
Operations
constraintDate2
workRequired3

1 Flagged as RESTORABLE

2 AT_DATE_YEAR_BEFORE validator added

3 Not_Filterable Flag Added

Team

Fields
References
Collections
Search
Actions
Queries
Operations
myWorkViewID
myWorkView
requestsViewID
myRequestsView

Template1

Fields
References
Collections
Search
Actions
Queries
Operations
resourceManagers
resourceManagerIDs

1 Flagged as RESTORABLE and RESOURCE_MANAGEABLE

Template Task1

Fields
References
Collections
Search
Actions
Queries
Operations
workRequired2

1 Flagged as RESTORABLE

2 Not_Filterable Flag Added

User

Fields
References
Collections
Search
Actions
Queries
Operations
myInfo1

1 MAX_LENGTH violators

User Note

Fields
References
Collections
Search
Actions
Queries
Operations
eventType1
myNotifications2

1 Possible Values Changed

2 has filters Changed to [true]

Announcement

Fields
References
Collections
Search
Actions
Queries
Operations
fileHandle
zipAnnouncementAttachments
recommendation-more-help
5f00cc6b-2202-40d6-bcd0-3ee0c2316b43