Don't forget to check out our JSON RESTful APIs, they can help you utilize and extend Quickbase with ease.
Overview
Use this call this to remove one or more of the options listed within a Text - Multiple Choice or Multi-select Text field in a Quickbase application. You can remove any choices that you created yourself. You must have Full Administration rights on the application to remove choices you did not create.
Request parameters
| Parameter | Value | Required? |
|---|---|---|
|
fid |
The field ID of the field from which you want to remove choices. |
yes |
|
choice |
Specifies a choice you want to remove. Use this tag multiple times to remove more than one choice. If any choice you specify cannot be removed (either because it does not exist, or because you lack permission to remove it), other valid choices you specify will be removed. The operation will be considered successful if at least one choice is removed. You should check the numremoved response value to make sure all the fields you expected were removed. |
yes |
|
ticket |
A valid authentication ticket. The authentication ticket is returned via the API_Authenticate call. |
yes, one of:
|
|
usertoken |
The user token is an alternative means of authentication, used for API access. User tokens cannot be used to access the Quickbase UI. |
yes, one of:
|
|
apptoken |
A valid application token. |
yes, if the application requires application tokens |
|
udata |
A string value that you want returned. It will not be handled by Quickbase but it will be returned in the response. |
no |
Response values
| Element Name | Value |
|---|---|
|
action |
The originating request, for example, API_FieldRemoveChoices. |
|
errcode |
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. |
|
errtext |
Text that explains the error code. "No error" indicates that no error was encountered. |
|
udata |
Optional. Contains any udata value supplied in the request. |
|
fid |
The field ID of the multiple choice field from which you removed choices. |
|
fname |
The label of the field from which you removed choices. |
|
numremoved |
The number of choices successfully removed. The call will be considered successful (errorcode=0) if one or more fields are removed successfully. |
Sample XML Request
POST https://target_domain/db/target_dbid
HTTP/1.0
Content-Type: application/xml
Content-Length:
QUICKBASE-ACTION: API_FieldRemoveChoices
<qdbapi>
<udata>mydata</udata>
<ticket>auth_ticket</ticket>
<apptoken>app_token</apptoken>
<fid>11</fid>
<choice>Black</choice>
<choice>Blue</choice>
<qdbapi>
URL Alternative
https://target_domain/db/81768?a=API_FieldRemoveChoices&fid=11&choice=
black&choice=blue&ticket=auth_ticket&apptoken=app_token
where target_domain is the domain against which you are invoking this call, for example, quickbase.com. Read about this notation.
Sample response
<?xml version="1.0" ?>
<qdbapi>
<action>API_FieldRemoveChoices</action>
<errcode>0</errcode>
<errtext>No error</errtext>
<udata>mydata</udata>
<fid>11</fid>
<fname>Color Choices</fname>
<numremoved>2</numremoved>
</qdbapi>