Use API_PurgeRecords to delete the specified records from the specified table. All records matching the criteria in the specified query will be deleted.
You can build your own query string using the query parameter in the call. You can also use a saved query for the table, using qid or qname. See API_DoQuery for information on saved queries or for instructions on building the query string.
Caution: Use this call carefully. If you do not supply a query parameter (query or qid or qname), ALL of the table records will be deleted. If you supply an empty query parameter (<query />, or <qid /> or <qname />) all of the table records will be deleted as well. If you need to delete only one record, you should use API_DeleteRecord.
Specifies the query. You can use any of these three options:
No, but unless you supply a non-empty query, all records in the table are deleted
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:
Supply a valid application token.
yes, if the application requires application tokens.
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_PurgeRecords.
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.
The total number of records that were deleted.
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.