When using the Quickbase JSON API is there a way to add a new created relationship field to the form similar to when creating a normal field?

Question

I need to add ~500 fields using the API and when creating a regular field you can add them to the form in the order they are created with a boolean in the JSON body, however about half of these fields are relational and I cannot figure how to add them in form as the JSON for relationships does not have this field.
If it is not possible to add the field when creating the relationship can you update a field or a current relationship and connect fields to them that are already exist in the form?
------------------------------Chris Baker------------------------------

gary1 · Answer

Have you already created the fields and you just want to get them onto a form? Or do you want to create the fields and add them to the form automatically? Also, are they lookup fields or summary fields?

------------------------------
gary
------------------------------

chrisbaker2 · Answer

I want to both create the fields and add them to the form in one post request. All of these fields are reference fields, so there has to be a dropdown menu that lets you pick the parent record.
------------------------------Chris Baker------------------------------

gary1 · Answer

I don't think this is possible with the JSON API. The creation of lookup fields is vastly simplified, but at the cost of full field customization.
That said, this is possible using the good ol' XML API (or URL alternative). If you're interested, let me know and I'll pass along the details.------------------------------gary------------------------------

chrisbaker2 · Answer

Yeah that's fine, anything that works I will take a look.------------------------------Chris Baker------------------------------

gary1 · Answer

It's a two-step process per field.
First, use this endpoint to add the new field:
https://helpv2.quickbase.com/hc/en-us/articles/4418302265236-API-AddField
At minimum, you'll want to pass mode, type, and add_to_forms. Type must match the field type of the intended lookup field in the parent table.
Also, make sure your legacy form is set to "Auto-add new fields". (I have no idea what will happen with the new form styles.)

&lt;mode&gt;lookup&lt;/mode&gt;
&lt;type&gt;text&lt;/mode&gt; // must match intended lookup field!
&lt;add_to_forms&gt;1&lt;/add_to_forms&gt;

Second, use this endpoint to update the the&nbsp;lutfid and&nbsp;lusfid attributes of the newly created field:
https://helpv2.quickbase.com/hc/en-us/articles/4418310972052-API-SetFieldProperties

&lt;lutfid&gt;8&lt;/lutfid&gt; // the field ID of the reference field in the same table
&lt;lusfid&gt;6&lt;/lusfid&gt; // the field ID of the source field in the lookup table

lutfid and lusfid are not in the XML API documentation, but they are visible when you call API_GetFieldProperties on a lookup field. For some reason, they are ignored when passed to API_AddField, but they are accepted when passed to API_SetFieldProperties.
I tested this out and it all works: the field is created, it's a lookup, and it appears by default on the legacy form.&nbsp;
IMO, this method is going to require a lot of overhead to script/automate. If I were in your shoes and this was a one-time operation, I would consider using the JSON API to create the fields (very easy) and manually add them to the form (painfully monotonous).&nbsp;
Good luck!------------------------------gary------------------------------

Forum Discussion

When using the Quickbase JSON API is there a way to add a new created relationship field to the form similar to when creating a normal field?

8 Replies