Expand my Community achievements bar.

SOLVED

Workfront API: Possible to retrieve all project custom fields in a single go using APIs?

Avatar

Level 7

Is it possible to retrieve all custom fields from a specific custom form associated with Workfront projects using APIs? Currently, I am manually specifying each field in the query parameters using the 'fields' parameter. However, I would like to know if there is a way to retrieve all fields at once without having to manually specify them. I have included a screenshot from Postman below for reference. May not be possible, but just wanted to check : )

Using '*' in fields params doesn't work because it retrieves native fields only:

_Manish_Singh_0-1679321650165.png

 

1 Accepted Solution

Avatar

Correct answer by
Community Advisor

 

All

 

https://<DOMAIN>.my.workfront.com/attask/api/v12.0/project/<PROJECTID>?fields=*,parameterValues

 

Custom Only

 

https://<DOMAIN>.my.workfront.com/attask/api-unsupported/project/<PROJECTID>?fields=parameterValues

 

Native Only

 

https://<DOMAIN>.my.workfront.com/attask/api-unsupported/project/<PROJECTID>?fields=*

 

 

 

TIP: if this solved your problem, I invite you to consider marking it as a Correct Answer to help others who might also find it of use.

View solution in original post

6 Replies

Avatar

Level 10

Hello,

 

to get all custom fields assigned to a specific custom form I call the following:

 

https://<domainname>.my.workfront.com/ctgy/<customFormId>?fields=categoryParameters:*,categoryParameters:parameter:name

as within the API custom forms are called Categories and custom fields are called Parameters.

Regards

Lars

Avatar

Level 7

Thank you. I'm looking to get custom fields at project/search endpoint, but I believe it is not possible without manually specifying "DE:" fields in params I guess.

Avatar

Correct answer by
Community Advisor

 

All

 

https://<DOMAIN>.my.workfront.com/attask/api/v12.0/project/<PROJECTID>?fields=*,parameterValues

 

Custom Only

 

https://<DOMAIN>.my.workfront.com/attask/api-unsupported/project/<PROJECTID>?fields=parameterValues

 

Native Only

 

https://<DOMAIN>.my.workfront.com/attask/api-unsupported/project/<PROJECTID>?fields=*

 

 

 

TIP: if this solved your problem, I invite you to consider marking it as a Correct Answer to help others who might also find it of use.

Avatar

Level 7

Perfect, thank you so much. I was looking for custom only

Avatar

Level 10

Hello Randy,

 

nice! Just for my understanding, why are you using `api-unsupported` for the custom / native only calls, but the regular API for the general call? 

Thanks in advance.

Regards

Lars

Avatar

Community Advisor

Hi, No reason really.

I have several dozen API calls bookmarked so I can go to them quickly. If it's an old book mark, it uses an old API version. There are a few things that the unsupported or internal versions do that the official ones do not but I can't remember off the top of my head what they are. These calls are all pretty standard so any version should work.