TTMSMCPStellarDS.UpdateRecords Method

Writes the same set of field values to one or more existing records.

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

Syntax

function UpdateRecords(const AProjectId: string; ATableId: Int64; const ARecord: TJSONObject; const AIdList: TJSONArray = nil; AForce: Boolean = False): TJSONValue;

Remarks

The two trailing arguments have declared defaults but carry no optional attribute, so a client that calls this as a tool is asked for both of them.

Parameters

Name	Description
AProjectId	Identifier of the project that holds the table.
ATableId	Numeric identifier of the table to update.
ARecord	Object holding the field values to write. Only the fields present in the object are sent. The object is copied into the request body, so the caller keeps ownership.
AIdList	Identifiers of the records to write to. The array is copied into the request body, so the caller keeps ownership. Pass nil, the default, to leave the list out of the body entirely and let the service decide which records the update covers.
AForce	When True, the request carries a force flag that asks the service to carry the update through even where it would otherwise be refused. When False, the default, the flag is left out.

Returns

In moSync, the parsed response body describing the updated records. 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.