DocumentationWorkfrontWorkfront Guide

Category

Last update: November 7, 2023
  • Topics:
  • Workfront API

CREATED FOR:

  • Developer

Fieldsclass: “java.lang.IllegalArgumentException”,
message: “APIModel INTERNAL does not support field projectid (OpTask)”

NameLabelTypeDescriptionPossible ValuesFlags
IDIDStringIdentifying GUID
accessorIDsacessorIDsString ArrayList of People/Team IDs that can access this object

Read Only

Lazy Read

Dynamic

Not Groupable

catObjCodeTypeStringType of Object the Custom form is related to[{"label":"Company","value":"CMPY"},{"label":"Task","value":"TASK"},{"label":"Project","value":"PROJ"},{"label":"Portfolio","value":"PORT"},{"label":"Program","value":"PRGM"},{"label":"User","value":"USER"},{"label":"Document","value":"DOCU"},{"label":"Issue","value":"OPTASK"},{"label":"Expense","value":"EXPNS"},{"label":"Iteration","value":"ITRN"}]

Editable

Required

customerIDCustomer IDStringID of the CustomerNot Groupable
descriptionDescriptionStringDescriptionEditable
enteredByIDEntered By IDStringID of the User that added the Custom FormNot Groupable
extRefIDExternal Reference IDStringUser Editable Field inteded to be used a link to an external objectEditable
groupIDGroup IDStringID of the first group with access to the custom form

Editable

Not Groupable

hasCalculatedFieldsHas Calculated FieldsBooleanDoes the form have calculated fields associated with it?Not Groupable
lastUpdateDateLast Update DateDate/TimeDate of when the object was last modified
lastUpdatedByIDLast Updated By IDStringID of the last user to Update the objectNot Groupable
nameNameStringName of the Object

Editable

Required

References

NameLabelTypeType Object CodeURL
CustomercustomerCustomerCUSThttps://support.workfront.com/hc/en-us/articles/226425467
Entered ByenteredByUserUSERhttps://support.workfront.com/hc/en-us/articles/226425467
GroupgroupGroupGROUPhttps://support.workfront.com/hc/en-us/articles/226425467
Last Updated BylastUpdatedByUserUSERhttps://support.workfront.com/hc/en-us/articles/226425467

Collections

Name
Label
Type
Type Object Code
URL
Access Rules
accessRules
Access Rule
ACSRUL
https://support.workfront.com/hc/en-us/articles/226425467
Category Access Rules
categoryAccessRules
Category Access Rules
CATACR
https://support.workfront.com/hc/en-us/articles/226425467
Category Cascade Rules
categoryCascadeRules
Catagory Cascade Rules
CTCSRL
https://support.workfront.com/hc/en-us/articles/226425467
Category Parameters
categoryParameters
Category Parameters
CTGYPA
https://support.workfront.com/hc/en-us/articles/226425467
Other Groups
otherGroups
Group
GROUP
https://support.workfront.com/hc/en-us/articles/226425467

Actions

Label
Name
Arguments
Assign Categories
assignCategories
[{name: "objID",type: "string"},{name: "objCode",type: "string"},{name: "categoryIDs",type: "string[]"}]
Assign Category
assignCategory
[{name: "objID",type: "string"},name: "objCode",type: "string"},{name: "categoryID",type: "string"}]
Unassign Categories
unassignCategories
[{name: "objID",type: "string"},{name: "objCode",type: "string"},{name: "categoryIDs",type: "string[]"}]
Unassign Category
unassignCategory
[{name: "objID",type: "string"},name: "objCode",type: "string"},{name: "categoryID",type: "string"}]
recommendation-more-help
5f00cc6b-2202-40d6-bcd0-3ee0c2316b43