Expand my Community achievements bar.

Don’t miss the Workfront AMA: System Smarts & Strategic Starts! Ask your questions about keeping Workfront running smoothly, planning enhancements, reporting, or adoption, and get practical insights from Adobe experts.

Allow commas and colons to be passed when retrieving a custom field value - this is a bug fix request.

Avatar

Level 1

7/12/17

I was told to make a feature request for this bug by one of your customer service reps. Here are the details: Allow an API user to retrieve values on a custom field that contains commas or colons. Currently these characters are special characters that delimit fields or custom fields. There is no way to escape/encode these characters to allow an API call to successfully retrieve their value even though the UI allows these characters to be used as part of a custom field name.
The following call will fail due to the commas in the custom field name, even though the custom field name is allowed in Workfront:

https://mydomain.workfront.com/attask/api/v5.0/TASK/595f22b45654d98536c5a66b5a9302?apiKey=myapikey&f... this item tie into any other existing, current, or future item?

1 Comment

Avatar

Level 3

11/17/17

I think it's a good rule of thumb not to put commas or colons in a field name, and workfront should prevent that in the UI.

However I can confirm that a custom field with a comma is allowed, and WILL return in a report, but CAN'T be used in an API query.

Querying my custom Project field (/project/search/?fields=parameterValues) returns the following:

"DE:my, sample":"my sample data"

But try as I might the API will not accept "my, sample" as a parameter. Commas are escapable via %2C but are still treated as regular commas by the API.

Side note: I also found the API dies when asked to provide a custom field that does not exist.

https://mahle.preview.workfront.com/attask/api/v7.0/user/search/?fields=DE:doesntexist
{"data":[

(It simply returns an error when asked for a regular non-existent field)

{"error":{"class":"java.lang.IllegalArgumentException","message":"APIModel V7_0 does not support field doesntexist (Project)"}}