DocumentationWorkfrontWorkfront Guide

What’s new in API version 19

Last update: Thu Nov 07 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer

Adobe Workfront released API version 19 on April 8, 2024. API version 19 features the following changes from version 18.

Added resources

No resources were added for API version 19.

Removed resources

No resources were removed for API version 19

Modified resources

AccessLevel (ACSLVL)

An AccessLevel object is associated with users, and describes the set of AccessLevelPermissions that determine what the user can access.

Direct fields

  • accessRestrictions

    Added the following possible values:

    • Disable the Workfront AI Assistant (AIOFF)

Assignment (ASSGN)

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

The Assignment object added the flag DATA_EXTENDIBLE.

Direct fields

Added the following direct fields:

  • categoryID

    A category is a custom form. This field supports the ability to add a custom form to an assignment.

  • priority

    This field allows the following values:

    • 0 (None)
    • 1 (Low)
    • 2 (Normal)
    • 3 (High)
    • 4 (Urgent)
Reference fields

Added the following reference fields:

  • category

    A category is a custom form. This field supports the ability to add a custom form to an assignment.

Collection fields

Added the following collection fields:

  • objectCategories

    A category is a custom form. This field supports the ability to add a custom form to an assignment.

Category (CTGY)

A Category object is a custom form.

Direct fields

The following fields have been added to support the ability to add a custom form to an assignment.

  • catObjCode

    Added the following possible values:

    • Assignment (ASSGN)

  • objTypes

    Added the following possible values:

    • Assignment (ASSGN)

Classifier (CLSF)

A Classifier is a location.

Actions

Added the following actions:

  • activateClassifiers
  • deactivateClassifiers

Customer

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

Direct fields

  • customEnumTypes

    Added the following possible values:

    • Assignment Priorities (PRIORITY_ASSIGNMENT)

    The CustomEnum object aids with converting status codes into human-readable text.

CustomerPreferences (CUSTPR)

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

Direct fields

  • name

    Removed the following possible values:

    • Enable Zoom integration in the updates stream (password:zoomIntegrationEnabled)

Document (DOCU)

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

Actions

  • createLargeDocument

    Added the field folderID.

  • sendDocumentsToExternalProvider

    Added.

ExchangeRate (EXRATE)

An ExchangeRate object represents a currency exchange rate set up in Workfront. ExchangeRate objects are not dynamic.

Direct fields

  • The following fields have added the validator REQUIRED:

    • currency

    • rate

  • The following fields have been added:

    • enteredByID

    • entryDate

    • lastUpdateDate

    • lastUpdatedByID

Reference fields

  • The following fields have been added:

    • enteredBy

    • lastUpdatedBy

Group (GROUP)

A Group object represents a set of users and teams. Groups often represent departmental structure.

The Group object added the flag SHARABLE.

Hour (HOUR)

An Hour object represents an hour logged by a user on a timesheet.

Direct fields

The following fields have been added:

  • assignedApproverID

  • isBillable

  • isBilled

  • rejectedByID

  • rejectedOnDate

  • rejectionComment

  • submittedByID

The following changed were made to the hours field.

  • Removed validator GREATER_THAN
  • Added validator NOT_EQUAL
Actions

The following actions have been added:

  • approve

  • unapprove

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.

Direct fields

  • flags

    Added the following possible values:

    • Is cost rate (CR)

    • Is billing rate (BR)

    • Is general finance (GF)

    • Is combined finance (CF)

Parameter (PARAM)

A Parameter object is a custom field.

Direct fields

  • dataType

    Added the following possible value:

    • Duration (DRTN)

  • displayType

    To create a more user-friendly and flexible system, the Widget (WIDGET) field type has been deprecated, and split into the following field types:

    • Adobe XD (ADOBEXD)
    • Image (IMAGE)
    • PDF (PDF)
    • Video (VIDEO)
    • External Lookup (EXTRNL)
    • Multi-Select External Lookup (MULTEXTRNL)
    • Native Field (WFNATIVE)
    • Planning Field (WFPLANNING)
    • Time-phased KPI (TIMEPHASED)
    • Rollup (ROLLUP)
    • Documents (DOCUMENT)

  • configurations

    Added.

Role (ROLE)

A Role object (job role) represents a functional capacity or a skill set a user might fill, such as Designer or Product Manager.

Direct fields

The following fields have been added:

  • lastUpdateDate

  • lastUpdatedByID

Reference fields

The following fields have been added:

  • lastUpdatedBy

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

To create a more user-friendly and flexible system, the Widget (WIDGET) field type has been deprecated, and split into the following field types:

  • Adobe XD (ADOBEXD)
  • Image (IMAGE)
  • PDF (PDF)
  • Video (VIDEO)
  • External Lookup (EXTRNL)
  • Multi-Select External Lookup (MULTEXTRNL)
  • Native Field (WFNATIVE)
  • Planning Field (WFPLANNING)
  • Time-phased KPI (TIMEPHASED)
  • Rollup (ROLLUP)
  • Documents (DOCUMENT)

TemplateAssignment (TASSGN)

A TemplateAssignment object represents the connection between a template task and the user, team, or group that is assigned to work on it. When the template is used for a project, that user, team, or group is assigned to the task.

The TemplateAssignment object added the flag DATA_EXTENDIBLE.

Direct fields

Added the following direct fields:

  • categoryID

    A category is a custom form. This field supports the ability to add a custom form to an assignment.

Reference fields

Added the following reference fields:

  • category

    A category is a custom form. This field supports the ability to add a custom form to an assignment.

Collection fields

Added the following collection fields:

  • objectCategories

    A category is a custom form. This field supports the ability to add a custom form to an assignment.

Timesheet (TSHET)

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.

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