How can I get the field ID of a Workfront Planning field?

Question

Dear community,

I'm trying to create an external look up field for the Workfront Planning API, and in the instructions it says that I should add:

JSON Path: $.records[*].data.{fieldID}
{fieldID} is the field to display in the External lookup search results on the custom form for end users.

Can anyone help me understand what is exactly the fieldID? Is it the WF Planning field ID? If so, how can I get it? I was not able to find it.

Thanks in advance!

monicacardoso · Accepted Answer

Hi @karinasaijo,

Thank you for your question! The section of the article that you're looking at provides an example to pull the fieldID into the External lookup search results. You wouldn't need to know the fieldID, since that is what will be returned.

The base API URL will be:

$$HOST/maestro/api/v1/records/search?recordTypeId={recordTypeID}

So you would need to know the recordTypeID. In order to retrieve that, run this call in your browser:

https://<domain>.my.workfront.com/maestro/api/record-types?workspaceId={workspaceID}

For workspace ID, you can navigate to it in Workfront and grab the ID from the URL:

Running the API call above would return a different ID for Demands, Clients and Deliverables that I could plugin to base API URL.

- Monica

Sign up

Login with SSO

Login to the community

Login with SSO