Follow
What's New in API Version 8

New Resources

AgileWork

Fields References Collections Search Actions Queries Operations
backlogOrder customer     bulkCopy    COPY
color iteration          COUNT
customerID lastUpdatedBy         DELETE
estimate opTask         EDIT
ID project         GET 
isReady storyboardParent         REPORT
iterationID task         SEARCH
lastUpdateDate team          
lastUpdatedByID            
name            
opTaskID            
parentStoryBoardOrder            
projectID            
storyBoardOrder            
storyBoardParentID            
taskID             
teamID            
type            
uiObjCode            
uiObjectID            

APIVersionMetadata

Fields References Collections Search Actions Queries Operations
deprecationRelease           COUNT 
removalRelease           GET
versionName           REPORT
            SEARCH

KanbanBoard

Fields References Collections Search Actions Queries Operations
ID           ADD
name           COUNT
            DELETE
            EDIT
            GET
            REPORT
            SEARCH

ProofApprovalStatus

Fields References Collections Search Actions Queries Operations
ID            
proofApprovalStatusID            
proofApprovalStatusLabel            

ProofFileMetadata

Fields References Collections Search Actions Queries Operations
documentVersionID documentVersion          
fileIndex            
fileName            
ID            
isURL            

ResourceBudgetedHour

Fields References Collections Search Actions Queries Operations
allocationDate           ADD
budgetedHours           COUNT
plannedBudgetedHours           DELETE
projectID           EDIT
roleID           GET
userID           REPORT
            SEARCH

ResourcePlannerFilter

Fields References Collections Search Actions Queries Operations
ID           ADD
name           COUNT
            DELETE
            EDIT
            GET
            REPORT
            SEARCH

RichTextNote

Fields References Collections Search Actions Queries Operations
ID           COUNT
            GET
            REPORT
            SEARCH

Subscribe

Fields References Collections Search Actions Queries Operations
 ID       addSubscribers subscribers ADD
        removeSubscribers   COUNT 
        subscribes   DELETE
        unsubscribes   GET
            REPORT
            SEARCH

UserRole

Fields References Collections Search Actions Queries Operations
roleID role          
timePercentage user          
userID            

Updated Resources

The following existing resources have been updated with this release of the Workfront API. Changes made to a resource are indicated in the following manner:

  • Additions are simply listed
  • Removals are indicated with strikethrough text
  • Changes are noted in the note after the table

AccessRequest

Fields References Collections Search Actions Queries Operations
action¹             

¹ Changes to possible values

AccessRule¹ 

Fields References Collections Search Actions Queries Operations
coreAction²             
forbiddenActions²            
secondaryActions²            

¹ Flag removed: REPORTABLE
² Changes to possible values

Approval

Fields References Collections Search Actions Queries Operations
auditTypes¹ agileWork  resourcePools        
backlogOrder² kanbanBoard           
backlogParent            
kanbanBoardID            

¹Changes to possible values
²Flags added: DYNAMIC, LAZY_READ, and NOT_GROUPABLE

Assignment

Fields References Collections Search Actions Queries Operations
        assignUserToRoleOnTasks getAssignAssignmentsForTasks   
        swapUsersOnTasks getUnassignAssignmentsForTasks  
        unassignUserFromTasks    

Customer

Fields References Collections Search Actions Queries Operations
bizRuleExclusions¹       getPackagingOptionValue    
proofPlan¹       isPackagingOptionEnabled    

¹Changes to possible values

CustomerPreferences

Fields References Collections Search Actions Queries Operations
name¹            

¹Changes to possible values

DocumentApproval

Fields References Collections Search Actions Queries Operations
ID¹            

¹Flag added: NOT_FILTERABLE

DocumentVersion

Fields References Collections Search Actions Queries Operations
activeProofStages            

Group

Fields References Collections Search Actions Queries Operations
    owners        

HourType

Fields References Collections Search Actions Queries Operations
appGlobalID¹            

¹Flag added: NOT_FILTERABLE

Iteration

Fields References Collections Search Actions Queries Operations
        moveStories    

Like

Fields References Collections Search Actions Queries Operations
endorsementID endorsement          

Note

Fields References Collections Search Actions Queries Operations
auditType¹            

¹Changes to possible values

OpTask

Fields References Collections Search Actions Queries Operations
auditTypes¹ agileWork        defaultShownTimesheetIssues   
backlogOrder iteration          
backlogParent            
estimate            
iterationID            

¹Changes to possible values

Portfolio

Fields References Collections Search Actions Queries Operations
auditTypes¹            

¹Changes to possible values

Program

Fields References Collections Search Actions Queries Operations
auditTypes¹            

¹Changes to possible values

Project

Fields References Collections Search Actions Queries Operations
auditTypes¹   resourcePools     defaultShownTimesheetProjects  

¹Changes to possible values

ProofApproval

Fields References Collections Search Actions Queries Operations
approverID approver          
documentVersionID documentVersion          
ID¹            
proofCreationDate            

¹Flag added: NOT_FILTERABLE

QueueDef

Fields References Collections Search Actions Queries Operations
requestorCoreAction¹            
requestorForbiddenActions¹            

¹Changes to possible values

Rate

Fields References Collections Search Actions Queries Operations
endDate       setRatesForRole     
name            
startDate            

ReservedTime

Fields References Collections Search Actions Queries Operations
extRefID            

ResourceManager

Fields References Collections Search Actions Queries Operations
projectPriority            

Task

Fields References Collections Search Actions Queries Operations
auditTypes¹ agileWork        allTasksOnIterations   
backlogParent kanbanBoard       defaultShownTimesheetTasks  
kanbanBoardID            

¹Changes to possible values

Team

Fields References Collections Search Actions Queries Operations
agileMethodology            
autoAddNextStory            
includeIssues            
teamStoryBoardIssueStatuses            
wipLimit            

Template

Fields References Collections Search Actions Queries Operations
    resourcePools        

TemplateTask

Fields References Collections Search Actions Queries Operations
auditTypes¹            

¹Changes to possible values

Update

Fields References Collections Search Actions Queries Operations
updateType¹ updateEndorsement          

¹Changes to possible values

User

Fields References Collections Search Actions Queries Operations
    resourcePools        
    userGroups        
    userRoles        

UserNote

Fields References Collections Search Actions Queries Operations
endorsementID endorsement          
endorsementShareID endorsementShare          
eventType¹            

¹Changes to possible values

Work

Fields References Collections Search Actions Queries Operations
auditTypes¹ agileWork           
backlogOrder² kanbanBoard           
backlogParent             
kanbanBoardID            

¹Changes to possible values
²Flags added: DYNAMIC, LAZY_READ, and NOT_GROUPABLE

This article last updated on 2018-01-30 20:54:17 UTC