TTMSMCPStellarDS.DeleteRecords Method

Deletes several records from a table in one call.

API unit family: TMS.MCP.StellarDS Declaring type: TTMSMCPStellarDS

Syntax

function DeleteRecords(const AProjectId: string; ATableId: Integer; const AIdList: TJSONArray): TJSONValue;

Remarks

The deletions cannot be undone. Unlike the single-record and data-reading calls, this one takes the table identifier as a 32-bit value.

Parameters

Name	Description
AProjectId	Identifier of the project that holds the table.
ATableId	Numeric identifier of the table to delete from.
AIdList	Array of record identifiers to delete, which is sent as the whole request body. The array is only read, so the caller keeps ownership.

Returns

In moSync, the parsed response body confirming the deletions. nil in moAsync, and also in moSync when the request failed or came back with an empty body. The caller owns a returned value and has to free it; a server that called this as a tool frees it once the result has been serialized.