Skip to content

Function: setPropertyViaRestfulTable() ​

ts
function setPropertyViaRestfulTable(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  allowedValues?: string[];
  defaultValue?: string;
  desc?: string;
  example?: string;
  id?: string;
  key?: string;
  name?: string;
  type?: string;
  value?: string;
}>;

Defined in: src/server/api/applicationProperties.ts:41

Update an application property via PUT. The "value" field present in the PUT will override the existing value.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ body: { id?: string; value?: string; }; id: string; }-
parameters.body{ id?: string; value?: string; }-
parameters.body.id?string-
parameters.body.value?string-
parameters.id?stringA String containing the property key.
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; allowedValues?: string[]; defaultValue?: string; desc?: string; example?: string; id?: string; key?: string; name?: string; type?: string; value?: string; }>