DocumentationWorkfrontWorkfront Guide

What’s new in API version 11

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

CREATED FOR:

  • Developer

Added Resources added-resources

  • accessExpirationDate
  • accessorID
  • customerID
  • ID
  • userID
  • accessor
  • customer
  • user
  • ID
  • objCode
  • customerID
  • ID
  • loginAsSettingsID
  • objID
  • objObjCode
  • customer
  • ID
  • objCode
  • customerID
  • licenseTypes
  • ID
  • restrictedLoginAs
  • customer
  • additionalRules
  • ID
  • objCode

ReportableBudgetedHour reportablebudgetedhour

ReportableBudgedHour has been added to the Adobe Workfront API as a resource for Reporting. It features reference fields, core fields, and default fields that are absent in BudgetedHour.

Direct Fields

  • allocationDate

    The Allocation Date is the first day (a Sunday) of the week for which you budgeted the hours in the Resource Planner.

  • budgetedHours

    Budgeted Hours are hours that the resource manager budgets for the work that resources need to complete on projects

  • ID

    The unique Workfront ID assigned to a specific Reportable Budgeted Hour object.

  • plannedBudgetedHours

  • projectID

    The unique Workfront ID assigned to a specific Project.

  • roleID

    The unique Workfront ID assigned to a specific Job Role.

  • userID

    The unique Workfront ID assigned to a specific User.

Reference Fields

  • project

    The Project that a ReportableBudgetedHour is associated with.

  • role

    The Job Role that a ReportableBudgetedHour is associated with.

  • user

    The User that a ReportableBudgetedHour is associated with.

Core Fields
  • ID
  • name
  • objCode
Default Fields
  • name
Operations
  • COUNT
  • GET
  • REPORT
  • SEARCH

Removed Resources removed-resources

No resources were removed for API v11.

Modified Resources modified-resources

AccessLevelPermissions accesslevelpermissions

An AccessLevelPermissions object represents a set of permissions. This set of permissions can then be associated with an Access Level.

Direct Fields

The following fields added the possible value BUDGETING_INFORMATION. This allows users with permission to edit priorities and budget hours in the planner.

  • coreAction
  • forbiddenActions
  • secondaryActions

AccessRequest accessrequest

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.

Direct Fields

  • action

    Added the possible value BUDGETING_INFORMATION. This allows users with permission to edit priorities and budget hours in the planner.

AccessRule accessrule

An AccessRule object represents a rule set in custom access levels that determines how users can share projects they create.

Direct Fields

The following fields added the possible value BUDGETING_INFORMATION. This allows users with permission to edit priorities and budget hours in the planner.

  • coreAction
  • forbiddenActions
  • secondaryActions

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.

Direct Fields

The following fields added the validators AT_DATE_BEFORE_YEAR and AT_DATE_AFTER_YEAR. These validators specify that dates on associated objects can't be set before the year 1900 or after 2200.

  • actualCompletionDate
  • actualStartDate
  • constraintDate
  • plannedCompletionDate
  • plannedStartDate

The following fields were added to the public API for transparency in calculating EAC (Estimate at Completion).

  • bcwp

    Also known as the Earned Value, the Budgeted Cost of Work Performed (BCWP) is a project performance metric that represents the budgeted cost of the amount of the task that has actually completed at the time when this metric is calculated. For tasks, BCWP = Actual Percent Complete x Task Budget. For Projects, BCWP = SUM(BCWP values of all parent and individual tasks).

  • bcws

    Also known as the Planned Value, the Budgeted Cost of Work Scheduled (BCWS) is a project performance metric that represents the budgeted cost of the amount of the task that should have completed at the time when this metric is calculated. For tasks, BCWS = Planned Percent Complete x Task Budget. For projects, BCWS = SUM(BCWS values of all parent and individual tasks).

The following fields added the possible value ET. This value represents the unit of time Elapsed Months, which refers to months without regard to weekends or holidays.

  • durationUnit
  • workUnit

The following fields added the flag CURRENCY

  • projectBudgetedCost
  • projectNetValue

The following fields were removed from the Approval object.

  • reservedTimeID
  • timelineExceptionInfo

The following field was added to the Approval object.

  • storyPoints
Reference Fields

  • reservedTime

    Removed from the Approval object

Collection Fields

  • allConditions

    Added to the Approval object.

ApprovalPath approvalpath

An ApprovalPath object is a branch within an Approval Process. Approval Paths are based on the status of the object that the Approval Process is associated with.

Direct Fields

  • durationUnit

    Added the possible value ET. This value represents the unit of time Elapsed Months, which refers to months without regard to weekends or holidays.

ApprovalProcess approvalprocess

An ApprovalProcess object is a multi-step Approval that can be associated with a Project, Task, or Issue.

Direct Fields

  • isActive

    This field was added, and 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. Objects not set to Active are not visible in drop-down menus and type-ahead fields to attach to other objects.

Default Fields

  • isActive

    Added

Assignment assignment

An assignment object represents the connection between a work item and the user, team, or group that is assigned to work on it.

Direct Fields

  • workUnit

    Added the possible value ET. This value represents the unit of time Elapsed Months, which refers to months without regard to weekends or holidays.

BaselineTask baselinetask

Baselines are snapshots of what the performance of a project looked like at a given moment in time. They store key pieces of information about the project, like key dates, progress, cost and revenue values. When you create a baseline, the task information is also captured on the baseline tasks of that baseline.

Direct Fields

  • durationUnit

    Added the possible value ET. This value represents the unit of time Elapsed Months, which refers to months without regard to weekends or holidays.

Category category

A Category object is a custom form. You can build reports for this object and you can show it in other object reports, as well.

Direct Fields

  • isActive

    This field was added, and 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. Objects not set to Active are not visible in drop-down menus and type-ahead fields to attach to other objects.

Default Fields

  • isActive

    Added

Company company

A Company object represents an organization consisting of a collection of people. Companies are associated with a user or a project.

Direct Fields

  • isActive

    This field was added, and 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. Objects not set to Active are not visible in drop-down menus and type-ahead fields to attach to other objects.

Default Fields

  • isActive

    Added

CustomEnum customenum

Actions

The following actions were added to the CustomEnum object

  • getDefaultOpTaskConditionEnum
  • getDefaultProjectConditionEnum
  • getDefaultTaskConditionEnum
Queries

The following queries were added to the CustomEnum object

  • opTaskConditions
  • projectConditions
  • taskConditions

Customer customer

A Customer object represents an organization that uses an instance of Workfront.

Direct Fields

  • customEnumTypes

    Added possible values:

    • CONDITION_PROJ (Project Conditions)
    • CONDITION_TASK (Task Conditions)
    • CONDITION_OPTASK (Issue Conditions)
Actions

The following actions were added to the Customer object

  • goalsEnabled
  • updateLoginAsSettings

CustomerPreferences customerpreferences

A CustomerPreferences object represents the set of preferences that a customer has set for their instance of Workfront.

  • name

    Added possible values:

    • password:password.eauthPolicy (Password Complexity Requirements)
    • password:password.minimumLength (Minimum Password Length)
    • password:mobileSessionTimeout (Mobile Session Time Out)
    • project.mgmt:default.project.usertimeoff (User Time Off)
    • timesheet:default.timesheet.manualrole (Manual control role)
    • proof:defaultNonRecipientRole (config.proofhq.defaultnonrecipientrole)
    • proof:defaultNonRecipientGuestRole (config.proofhq.defaultnonrecipientguestrole)

DocMetadataLinkGroup docmetadatalinkgroup

Actions

  • getMetadataDetailsForDocument

    Added

Document document

A Document object represents a file (such as written material, images, or other forms of information).

Actions

The following actions were added to the Document object.

  • completeLargeDocument
  • createLargeDocument
  • createProofRest
  • getDocumentProofTemplate
  • getProofRecipients
  • getProofStages
  • getProofTemplate

Iteration iteration

An Iteration object represents a single Agile Iteration. Iterations are discrete periods of time used to plan and complete Agile stories.

Direct Fields

The following fields were added to the Iteration object.

  • originalTotalPoints
  • points Completed
  • totalPoints

Layout Template layout-template

A Layout Template object represents a particular arrangement of layout elements, such as the main menu, navigation panel, or the Home area. Layout templates can be assigned to users, teams, groups, or job roles.

Direct Fields

  • showHomeTimestamps

    This field was added, and is a boolean parameter that has a value of true if a Layout Template is set to show timestamps for due dates in the Work List and Calendar, and false if it is set to hide timestamps.

Default Fields

  • showHomeTimestamps

    Added

MilestonePath milestonepath

A milestone is a marker on a task indication that it is a key point in the Project. Generally used to denote a significant event such as the completion of a phase of the project or a set of critical activities. A MilestonePath object is a collection of milestones.

Direct Fields

  • isActive

    This field was added, and 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. Objects not set to Active are not visible in drop-down menus and type-ahead fields to attach to other objects.

Default Fields

  • isActive

    Added

Note note

A Note object is a comment or update made on a Workfront object.

Direct Fields

The following fields were added to the Note object.

  • proofID
Collection Fields

  • likes

    Added

OpTask 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.

Direct Fields

The following fields added the validators AT_DATE_BEFORE_YEAR and AT_DATE_AFTER_YEAR. These valdators specify that dates on associated objects can't be set before the year 1900 or after 2200.

  • actualCompletionDate
  • actualStartDate
  • plannedCompletionDate
  • plannedStartDate

The following fields were added to OpTask.

  • kanbanBoardID

    The unique Workfront ID of a Kanban Board object.

  • percentComplete

    Percent Complete is a parameter that will return the completed amount of an issue, as a percentage.

  • storyPoints

  • work

Collection Fields

  • allConditions

    Added

Search Fields

  • work

    Removed

Default Fields

  • percentComplete

    Added

Actions

The following actions were added to the OpTask object

  • bulkMove
  • copyIssue

Parameter parameter

A Parameter object is a custom field.

Direct Fields

  • displayType

    Added possible value TYAH (Typeahead).

  • refObjCode

    This field was added and refers to the object code of a referenced object. Object codes for all objects can be found in the API Explorer.

Portfolio portfolio

A Portfolio object is a collection of projects that compete for the same resources, typically money or people to complete them.

Direct Fields

  • description

    Added the validator MAX_LENGTH, which specifies that the length of the description is no more than 4000 characters.

Program program

A Program object is a subset within a portfolio, where similar projects can be grouped together.

Direct Fields

  • description

    Added the validator MAX_LENGTH, which specifies that the length of the description is no more than 4000 characters.

  • isActive

    This field was added, and 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. Objects not set to Active are not visible in drop-down menus and type-ahead fields to attach to other objects.

  • name

    Added the validator MAX_LENGTH, which specifies that the length of the name is no more than 255 characters.

Default Fields

  • isActive

    Added

Project project

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.

Direct Fields

The following fields added the validators AT_DATE_BEFORE_YEAR and AT_DATE_AFTER_YEAR. These valdators specify that dates on associated objects can't be set before the year 1900 or after 2200.

  • actualCompletionDate
  • actualStartDate
  • plannedCompletionDate
  • plannedStartDate

The following fields were added to the public API for transparency in calculating EAC (Estimate at Completion).

  • bcwp

    Also known as the Earned Value, the Budgeted Cost of Work Performed (BCWP) is a project performance metric that represents the budgeted cost of the amount of the task that has actually completed at the time when this metric is calculated. For tasks, BCWP = Actual Percent Complete x Task Budget. For Projects, BCWP = SUM(BCWP values of all parent and individual tasks).

  • bcws

    Also known as the Planned Value, the Budgeted Cost of Work Scheduled (BCWS) is a project performance metric that represents the budgeted cost of the amount of the task that should have completed at the time when this metric is calculated. For tasks, BCWS = Planned Percent Complete x Task Budget. For projects, BCWS = SUM(BCWS values of all parent and individual tasks).

The following fields added the flag CURRENCY

  • projectBudgetedCost
  • projectNetValue

The following field was removed from the Project object.

  • timelineExceptionInfo
Collection Fields

  • allConditions

    Added

ProofApproval proofapproval

A ProofApproval object represents an approval that is directly connected to a proof.

Direct Fields

  • isAwaitingDecision

    This field was added, and is a boolean parameter that has a value of true if a proof is awaiting a decision and false if it is not.

QueueDef queuedef

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.

Direct Fields

The following fields added the possible value BUDGETING_INFORMATION. This allows users with permission to edit priorities and budget hours in the planner.

  • requestorCoreAction
  • requestorForbiddenActions

ReservedTime reservedtime

A ReservedTime object represents days specified on a User’s Personal Time, indicating that the User will not be available for work.

The ReservedTime resource added the flag REPORTABLE.

Direct Fields

The following fields removed the flag NOT_GROUPABLE.

  • endDate
  • extRefID
  • startDate

The following field was removed from the ReservedTime object.

  • taskID
Reference Fields

  • task

    Removed

Operations

  • EDIT

    Added

ResourcePlannerFilter resourceplannerfilter

A ResourcePlannerFilter object is a set of rules that determine which items will display in the Resource Planner.

The ResourcePlannerFilter resource added the flag SHARABLE. There were no other changes to the object.

Risk risk

A Risk object represents a possible event that may prevent a project from finishing on time or within budget. Risks are added to projects in the planning phase to identify potential obstacles prior to the approval of any work.

Direct Fields

The following fields were added to the Risk object:

  • enteredByID

    The ID of the user that originally created the object.

  • entryDate

    The date an object was submitted by a user in Workfront.

  • lastUpdateDate

    The Last Update Date parameter will return that Date that the Last Update was made to an object,

  • lastUpdatedByID

    Last Updated By ID is a parameter that will return the User ID of the last User that updated the object.

Reference Fields

The following Reference Fields were added to the RIsk object.

  • enteredBy
  • lastUpdatedBy

ScheduledReport scheduledreport

A ScheduledReport object represents a report that has been configured to be scheduled for delivery.

Direct Fields

  • pageSize

    Added the following possible values:

    • A2
    • A1
    • A0

ScoreCardQuestion scorecardquestion

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.

Direct Fields

  • displayType

    Added possible value TYAH (Typeahead)

Task task

A Task object represents a work item that must be performed as a step toward achieving a final goal (completing a Project).

Direct Fields

The following fields added the validators AT_DATE_BEFORE_YEAR and AT_DATE_AFTER_YEAR. These valdators specify that dates on associated objects can't be set before the year 1900 or after 2200.

  • actualCompletionDate
  • actualStartDate
  • constraintDate
  • plannedCompletionDate
  • plannedStartDate

The following fields were added to the public API for transparency in calculating EAC (Estimate at Completion).

  • bcwp

    Also known as the Earned Value, the Budgeted Cost of Work Performed (BCWP) is a project performance metric that represents the budgeted cost of the amount of the task that has actually completed at the time when this metric is calculated. For tasks, BCWP = Actual Percent Complete x Task Budget. For Projects, BCWP = SUM(BCWP values of all parent and individual tasks).

  • bcws

    Also known as the Planned Value, the Budgeted Cost of Work Scheduled (BCWS) is a project performance metric that represents the budgeted cost of the amount of the task that should have completed at the time when this metric is calculated. For tasks, BCWS = Planned Percent Complete x Task Budget. For projects, BCWS = SUM(BCWS values of all parent and individual tasks).

The following fields added the possible value ET. This value represents the unit of time Elapsed Months, which refers to months without regard to weekends or holidays.

  • durationUnit
  • workUnit

The following field was removed from the Task object.

  • reservedTimeID

The following field was added to the Task object.

  • storyPoints
Reference Fields

  • reservedTime

    Removed

Collection Fields

  • allConditions

    Added

Team team

A Team object is a collection of Users that can be assigned to a work item.

Direct Fields

  • agileEstimateType

    This field was added to the Team object. Agile Estimate Type determines how the work load of a story is estimated. If estimated in hours, then this is the number of Planned Hours that are added to the story. If estimated in points, each point will add a number of Planned Hours to the story based on how the points are set (default is 8 hours). Possible values for Agile Estimate Type are:

    • STORY_POINTS (Story Points)
    • HOURS (Hours)
    • LEGACY_POINTS (Hours as Points)

Template template

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 a Project when the Template is used.

Direct Fields

  • isActive

    This field was added, and 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. Objects not set to Active are not visible in drop-down menus and type-ahead fields to attach to other objects.

Collection Fields

  • allPriorities

    Added

Default Fields

  • isActive

    Added

TemplateAssignment templateassignment

Direct Fields

  • workUnit

    Added the possible value ET. This value represents the unit of time Elapsed Months, which refers to months without regard to weekends or holidays.

TemplateTask templatetask

A TemplateTask object represents a Task that is part of a Template. Template Tasks become Tasks in the Project where the Template is used.

Direct Fields

The following fields added the possible value ET. This value represents the unit of time Elapsed Months, which refers to months without regard to weekends or holidays.

  • durationUnit
  • workUnit
Collection Fields

  • allPriorities

    Added

Timesheet timesheet

A Timesheet object represents a virtual timecard that allows Users to enter actual hours worked for Tasks, Projects, and overhead Hour Types.

Core Fields

  • objCode

    Removed

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.

Direct Fields

  • updateType

    Added possible value referenceObjectCustomData (enum.updatetypeenum.referenceobjectcustomdata)

Queries

The following queries were added to the Update object.

  • objectUpdatesMobile
  • updateThreadMobile

  • loginAsAccessRules

    Added

The following actions were added to the User object.

  • hasGrantLoginAsAccess
  • isUserAdmin

  • userAdmins

    Added

UserNote usernote

Actions

The following actions were added to the User object.

  • acknowledgeMyNotifications
  • unacknowledgedAllObjectsTypeCount
Queries

  • myAllObjectTypesUnreadNotifications

    Added

Work work

A Work object is a common interface that both Task and OpTask inherit, and shares common code between the two.

Direct Fields

The following fields added the validators AT_DATE_BEFORE_YEAR and AT_DATE_AFTER_YEAR. These valdators specify that dates on associated objects can't be set before the year 1900 or after 2200.

  • actualCompletionDate
  • actualStartDate
  • constraintDate
  • plannedCompletionDate
  • plannedStartDate

The following fields were added to the public API for transparency in calculating EAC (Estimate at Completion).

  • bcwp

    Also known as the Earned Value, the Budgeted Cost of Work Performed (BCWP) is a project performance metric that represents the budgeted cost of the amount of the task that has actually completed at the time when this metric is calculated. For tasks, BCWP = Actual Percent Complete x Task Budget. For Projects, BCWP = SUM(BCWP values of all parent and individual tasks).

  • bcws

    Also known as the Planned Value, the Budgeted Cost of Work Scheduled (BCWS) is a project performance metric that represents the budgeted cost of the amount of the task that should have completed at the time when this metric is calculated. For tasks, BCWS = Planned Percent Complete x Task Budget. For projects, BCWS = SUM(BCWS values of all parent and individual tasks).

The following fields added the possible value ET. This value represents the unit of time Elapsed Months, which refers to months without regard to weekends or holidays.

  • durationUnit
  • workUnit

The following field was removed from the Work object.

  • reservedTimeID

The following field was added to the Work object.

  • storyPoints
Reference Fields

  • reservedTime

    Removed

Collection Fields

  • allConditions

    Added

recommendation-more-help
5f00cc6b-2202-40d6-bcd0-3ee0c2316b43