Use API_SetKeyField to specify a field in the table as the key field. You invoke this call on a table dbid. You must have full administration rights on the application to use this call.
If you don't specify a key field, Quick Base uses the built-in Record ID field as the key field. However, if you want to use a different field as the key field for a table, the following conditions must be met:
The field type you pick must support uniqueness (make sure the Unique checkbox is checked, which disallows duplicate entries).
If there is data in the table, the field values must all be unique and cannot be blank.
You cannot specify a List - user or Multi-select text field, or any formula field, as the key field in a table.
A valid authentication ticket.
The authentication ticket is returned via the API_Authenticate call.
yes, one of:
The user token is an alternative means of authentication, used for API access. User tokens cannot be used to access the Quick Base UI.
yes, one of:
A valid application token.
yes, if the application requires application tokens
The field ID of the table field to be used as the key field.
A string value that you want returned. It will not be handled by Quick Base but it will be returned in the response.
The originating request, for example, API_SetKeyField.
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.
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 help you? Give us a rating:
© 1999-2020 QuickBase, Inc. All rights reserved. Legal Notices.