TTMSMCPStellarDS.UpdateField Method

Changes the name and the type of an existing field.

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

Syntax

function UpdateField(const AProjectId: string; ATableId, AFieldId: Integer; const AFieldName, AFieldType: string): TJSONValue;

Remarks

Both the name and the type are always part of the request, so each call rewrites both of them; read the current definition with GetFields first when only one of the two should change.

Parameters

Name	Description
AProjectId	Identifier of the project that holds the table.
ATableId	Numeric identifier of the table the field belongs to.
AFieldId	Identifier of the field to change.
AFieldName	Name the field takes after the call, sent as the name member of the request body.
AFieldType	Type the field takes after the call, written with the type name the service recognizes, and sent as the type member of the request body.

Returns

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