What’s new in API version 15
- Topics:
- Workfront API
CREATED FOR:
- Developer
Adobe Workfront released API version 15 on June 14, 2022. API version 15 features the following changes from version 14.
Added resources
Initiative (INITIV)
The Initiative object creates estimates in the Workfront Scenario Planner for the kind and number of job roles, the Fixed Costs, and the Planned Benefit.
For more information on Initiatives, see Initiatives overview in the Scenario Planner.
-
customerID
This is an internal object.
-
duration
The amount of time between endDate and startDate.
-
endDate
The Planned Completion Date for the Initiative.
-
enteredByID
The ID associated with the user that submitted the request.
-
ID
The ID associated with the action
-
initiativeID
The ID associated with the Initiative.
-
lastPublishedDate
The date the Initiative was last published in the Workfront Scenario Planner.
-
name
The name of the Initiative
-
planID
The ID of the Plan associated with the Initiative.
-
planName
The name of the Plan associated with the Initiative.
-
projectID
The ID of the project associated with the initiative.
-
scenarioID
The ID of the scenario in Workfront Scenario Planner associated with the initiative.
-
startDate
The Planned Start Date of the Initiative.
-
customer
-
enteredBy
-
project
-
ID
-
name
-
objCode
-
COUNT
-
GET
-
REPORT
-
SEARCH
IssueDef (ISSDEF)
The IssueDef object represents a set of data regarding the format of issues. This object can be attached to Projects or Templates, and affects the issues added to that Project or Template.
-
ID
-
isInlineAddEnabled
-
ID
-
objCode
ObjectIntegration (OBJINT)
In some cases, it is possible to link Workfront work items directly to objects in an external software product. The ObjectIntegration object represents this link.
-
customerID
This is an internal object.
-
entryDate
The date and time that the ObjectIntegration was entered in to the Workfront System.
-
ID
The unique Workfront ID of the specific ObjectIntegration object.
-
integrationType
The external software that the ObjectIntegration object creates a link with. Possible values are:
-
JIRA
-
SALESFORCE
-
ANAPLAN
-
-
linkedObjectID
-
objID
The object in Workfront that the ObjectIntegration is associated with.
-
objObjCode
The object code of the object in Workfront that the ObjectIntegration is associated with.
-
param1
-
param2
-
param3
-
URL
- customer
-
ID
-
objCode
TaskDef (TSKDEF)
The TaskDef object represents a set of data regarding the format of tasks. This object can be attached to Projects or Templates, and affects the tasks added to that Project or Template.
-
autoCalcPlannedHours
-
ID
- defaultApprovalProcess
- objectCategories
-
ID
-
objCode
UserApproval (USRAPV)
-
approverID
-
customerID
-
ID
-
requestedDate
-
requestorID
-
status
-
userID
-
approver
-
customer
-
requestor
-
user
-
ID
-
objCode
-
approverID
-
requestorID
-
status
-
userID
-
approve
-
reject
-
ADD
-
COUNT
-
DELETE
-
GET
-
REPORT
-
SEARCH
Removed resources
No resources were removed for API version 15.
Modified resources
AccessLevel (ACSLVL)
An AccessLevel object is associated with users, and describes the set of AccessLevelPermissions that determine what the user can access.
For more information on access levels, see Access levels.
-
fieldAccessPrivileges (string[])
Added the following possible values:
-
VTMAWMG (View teams associated with my groups)
-
VALLTM (View all teams)
-
AccessLevelPermissions (ALVPER)
An AccessLevelPermissions object represents a specific permission to access, create, or modify a Workfront object. These permissions can then be associated with an Access Level.
-
coreAction (string[])
Added the following possible values:
-
EDIT_TEAMS_I_AM_ON (Edit teams I am on)
-
EDIT_TEAMS_I_GROUP_ADMIN (Edit teams in groups I manage (Group Admins only))
-
-
forbiddenActions (string[])
Added the following possible values:
-
EDIT_TEAMS_I_AM_ON (Edit teams I am on)
-
EDIT_TEAMS_I_GROUP_ADMIN (Edit teams in groups I manage (Group Admins only))
-
-
secondaryActions (string[])
Added the following possible values:
-
EDIT_TEAMS_I_AM_ON (Edit teams I am on)
-
EDIT_TEAMS_I_GROUP_ADMIN (Edit teams in groups I manage (Group Admins only))
-
AccessRequest (ACSREQ)
If a User does not have access to an object in Workfront that they need, they can request access to that object. The AccessRequest object represents this request.
-
action (string)
Added the following possible values:
-
EDIT_TEAMS_I_AM_ON (Edit teams I am on)
-
EDIT_TEAMS_I_GROUP_ADMIN (Edit teams in groups I manage (Group Admins only))
-
-
autoShareAction (string)
Added the following possible value:
- WDL
AccessRule (ACSRUL)
An AccessRule object represents a rule set in custom access levels that determines how users can share projects they create.
-
coreAction (string[])
Added the following possible values:
-
EDIT_TEAMS_I_AM_ON (Edit teams I am on)
-
EDIT_TEAMS_I_GROUP_ADMIN (Edit teams in groups I manage (Group Admins only))
-
-
forbiddenActions (string[])
Added the following possible values:
-
EDIT_TEAMS_I_AM_ON (Edit teams I am on)
-
EDIT_TEAMS_I_GROUP_ADMIN (Edit teams in groups I manage (Group Admins only))
-
-
secondaryActions (string[])
Added the following possible values:
-
EDIT_TEAMS_I_AM_ON (Edit teams I am on)
-
EDIT_TEAMS_I_GROUP_ADMIN (Edit teams in groups I manage (Group Admins only))
-
Approval (APPROVAL)
A given work item, such as a task, document, or timesheet, may require that a supervisor or other user sign off on the work item. An Approval object represents the action of signing off on a work item.
- resourcePlannerBudgetedHours
-
initiative
Added.
The Initiative object creates estimates in the Workfront Scenario Planner for the kind and number of job roles, the Fixed Costs, and the Planned Benefit.
-
issueDef
Added.
-
taskDef
Added.
-
objectIntegrations
Added.
In some cases, it is possible to link Workfront work items directly to objects in an external software product. The ObjectIntegration object represents this link.
Category (CTGY)
A Category object is a custom form.
-
catObjCode (string)
Added the following possible value:
- GROUP (Group)
-
objTypes (string[])
Added.
This parameter is an array of possible objects to which the custom form can be attached. It was added to support the ability to attach a custom form to multiple types of objects.
Possible values:
CMPY, PORT, PRGM, PROJ, TASK, OPTASK, USER, DOCU, EXPNS, ITRN, BILL, GROUP
-
objTypes (string[])
Added.
This parameter is an array of possible objects to which the custom form can be attached. It was added to support the ability to attach a custom form to multiple types of objects.
Possible values:
CMPY, PORT, PRGM, PROJ, TASK, OPTASK, USER, DOCU, EXPNS, ITRN, BILL, GROUP
CategoryParameter (CTGYPA)
-
hideFormulaFromDescription
Added.
-
journaledObjCodes
Added.
-
rawCustomExpression
Added.
CustomerPreferences (CUSTPR)
A CustomerPreferences object represents the set of preferences that a customer has set for their instance of Workfront.
-
name
Added the following values:
-
password:sharePointV2IntegrationEnabled(SharePoint (Graph API) Integration Enabled)This value supports the updated Sharepoint integration.
-
project.mgmt:default.project.allowcreatewithouttemplate(Allow users to create projects without using a template) -
project.mgmt:taskissue.delegate(config.taskissue.delegate)
-
DocumentFolder (DOCFDR)
Documents can be organized into folders. You can create personal folders in your personal Documents area. The DocumentFolder object represents one of these folders.
The DocumentFolder object added the flag SHARABLE.
DocumentVersion (DOCV)
A DocumentVersion object represents a specific version of a file (such as written material, images, or other forms of information).
For more information about document versions, see Upload a new version of a document.
-
externalIntegrationType
Added the following value:
-
SHAREPOINT_V2(SharePoint (Graph API))This value supports the updated Sharepoint integration.
-
Group (GROUP)
A Group object represents a set of users and teams. Groups often represent departmental structure.
For more information on groups, see Groups vs. teams.
The Group object added the flag DATA_EXTENDIBLE
The following fields were added:
-
categoryID
A Category is a Custom Form. This parameter was added to support the ability to add Custom Forms to Group objects.
-
isActive
This is a boolean parameter that has a value of true if an object is Active and false if it is not. Objects that are set to Active appear in drop-down menus and type-ahead fields and can be attached to other objects.
The following fields were added:
-
approver
-
customer
-
requestor
-
user
The following fields were added:
-
objectCategories
-
objectIntegrations
In some cases, it is possible to link Workfront work items directly to objects in an external software product. The ObjectIntegration object represents this link.
The following field was added:
-
isActive
This is a boolean parameter that has a value of true if an object is Active and false if it is not. Objects that are set to Active appear in drop-down menus and type-ahead fields and can be attached to other objects.
The following fields were added:
-
calculateDataExtension
This action recalculates the expressions in custom form fields.
-
completeGroupInfo
-
linkExternalObject
-
unlinkExternalObject
JournalEntry (JRNLE)
The JournalEntry object can be set up to log information about specific object fields any time those fields are modified. When a field is set up to be logged as a part of the Journal Entry object, a corresponding Journal Entry will be created every time that field is modified.
changeType
Added the following value:
- DW (Download)
LinkedFolder (LNKFDR)
A LinkedFolder object represents a folder linked from an external document provider, such as Google Drive or Dropbox.
For more information on Linked Folders, see Link documents from external applications.
-
externalIntegrationType
Added the following value:
-
SHAREPOINT_V2(SharePoint (Graph API))This value supports the updated Sharepoint integration.
-
OpTask / Issue (OPTASK)
An OpTask object is commonly known as an Issue. An issue is a work item that usually indicates that there is a problem preventing the completion of a task or project. An Issue can also be a Help Desk request. Change Orders, Requests, and Bugs are also Issues.
The following actions were added:
-
bulkMoveWithOptions
-
getRequestPath
The following action was modified:
-
copyIssue
Added field
parentID
Parameter (PARAM)
A Parameter object is a custom field.
The following field was added:
- fieldDefinition
The following fields were modified:
-
dataType
Added the possible value
WIDGET(Widget)This value supports the use of images in custom forms.
-
displayType
Added the possible value
WIDGET(Widget)This value supports the use of images in custom forms.
Portfolio (PORT)
A Portfolio object is a collection of projects that compete for the same resources, typically money or people to complete them.
- objectIntegrations
-
linkExternalObject
-
unlinkExternalObject
Program (PRGM)
A Program object is a subset of projects within a portfolio, where similar projects can be grouped together.
- objectIntegrations
-
linkExternalObject
-
unlinkExternalObject
Project (PROJ)
Projects are work items within Workfront, and are a main building block in the way Workfront helps people to do work. A Project object represents a group of tasks with a common, specific goal.
- resourcePlannerBudgetedHours
-
initiative
The Initiative object creates estimates in the Workfront Scenario Planner for the kind and number of job roles, the Fixed Costs, and the Planned Benefit.
-
issueDef
-
taskDef
-
objectIntegrations
In some cases, it is possible to link Workfront work items directly to objects in an external software product. The ObjectIntegration object represents this link.
QueueDef (QUED)
A QueueDef object represents a Queue, which is a project that has been published to the Help Desk area to allow users to submit issues to it.
For more information on Request Queues, see Create a Request Queue.
-
requestorCoreAction
Added the following possible values:
-
EDIT_TEAMS_I_AM_ON (Edit teams I am on)
-
EDIT_TEAMS_I_GROUP_ADMIN (Edit teams in groups I manage (Group Admins only))
-
-
requestorForbiddenActions
Added the following possible values:
-
EDIT_TEAMS_I_AM_ON (Edit teams I am on)
-
EDIT_TEAMS_I_GROUP_ADMIN (Edit teams in groups I manage (Group Admins only))
-
ScoreCardQuestion (SCOREQ)
A ScoreCardQuestion object represents a question that has been added to a Scorecard. These questions are usually determined by the Portfolio manager, and their answers allow the manager to understand how well a project aligns with the goals of the portfolio.
For more information on Scorecard Questions, see Create a scorecard.
-
displayType
Added the possible value
WIDGET(Widget)
Task (TASK)
A Task object represents a work item that must be performed as a step toward achieving a final goal (completing a Project).
-
objectIntegrations
In some cases, it is possible to link Workfront work items directly to objects in an external software product. The ObjectIntegration object represents this link.
Template (TMPL)
A Template object represents a pattern for a project. Projects can be created from templates to save time. A template contains a team and tasks, which will be copied to any project created from the template.
-
issueDef
-
taskDef
Timesheet (TSHET)
A Timesheet object represents a virtual timecard that allows Users to enter actual hours worked for Tasks, Projects, and overhead Hour Types.
The following field was removed:
- objCode
View (UIVIEW)
-
uiviewType
The following possible values were removed:
-
FOUR_COL(Four Column Layout) -
UPDATES(Updates) -
UPDATESTOOLBAR_FEED(Updates) -
WORKINGON(Working On) -
CUSTOMDATA(Custom Data) -
CUSTOMDATA_UPDATE(Update Custom Data) -
STATUS_UPDATE(Status Update) -
OPTASK_STATUS_UPDATE(Status Update) -
PROJ_STATUS_UPDATE(Status Update) -
PROJECT_TIMEENTRY(Status Update) -
DLIST(Detail List) -
DLIST_SECTION(Detail List Section)
-
Update (UPDATE)
Work Items in Workfront can be updated to keep users informed of the current status. An Update object represents one of these updates. Updates can be entered by users or created by the Workfront system.
-
updateType
Added the possible value
documentVersionDownload(enum.updatetypeenum.documentversiondownload)
User (USER)
A User object represents a person with an account in Workfront that can log in and interact with the system.
- userApproval
-
getUsersAvailableTime
-
resetRopgPassword
UserNote (USRNOT)
A UserNote object is a notification.
-
eventType
Added the following possible values:
-
DUP(Requested that you proof a document) -
DUV(Allow you to view a document)
-
Work (WORK)
A Work object is a common interface that both Task and OpTask inherit, and shares common code between the two.
-
objectIntegrations
In some cases, it is possible to link Workfront work items directly to objects in an external software product. The ObjectIntegration object represents this link.