Use API_AddField to add a new field to a table. You invoke this call on a table-level dbid.
When you add a field using API_AddField, you specify the field type, but no other field properties. After you've added the field, you can use API_SetFieldProperties to set the properties of the new field and any default values. (You can't set field type using API_SetFieldProperties; if you want to change the field type after adding the field, you must use the Quickbase UI.)
The amount of data space consumed by a field depends on the field type. Read more in the online help.
Specifies whether the field you are adding should appear at the end of any form with form properties set to "Auto-Add new fields."
Set this parameter to 1 if you want the field to appear on all forms with "Auto-Add new fields" enabled.
If the new field has a type of fkey or dblink, the form is set to display it as a report instead of as a link.
A valid application token.
yes, if the application requires application tokens
Allows you to enter the name of the new field.
Specifies whether the field is a formula field or a lookup field. Valid values are:
The value for this parameter must be lowercase.
Required for lookup or formula fields
A valid authentication ticket. The authentication ticket is returned via the API_Authenticate call.
yes, one of:
yes, one of:
The Quickbase field type. The eligible type names differ slightly from their counterparts in the Quickbase UI:
A string value that you want returned. It will not be handled by Quickbase but it will be returned in the response.
The response to this call contains the following:
The originating request, for example, API_AddField.
Identifies the error code, if any. (See the Error Codes appendix for a list of possible error codes.)
0 indicates that no error was encountered.
Text that explains the error code.
"No error" indicates that no error was encountered.
The field ID. You can use this value in other API calls that manipulate this field or field values.
The name of the field as it appears in the Quickbase application UI.
Optional. Contains any udata value supplied in the request.
where target_domain is the domain against which you are invoking this call, for example, quickbase.com. Read about this notation.
<?xml version="1.0" ?>
Did this page help?
© 1999-2022 Quickbase, Inc. All rights reserved. Legal Notices.