Skip to content

Function: findSchemaAttributes() ​

ts
function findSchemaAttributes(
   client, 
   parameters, 
   options?
): Promise<object[]>;

Defined in: src/assets/api/objectSchemas.ts:115

Find all object type attributes for this object schema

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ extended?: boolean; id: string; onlyValueEditable?: boolean; query?: string; }-
parameters.extended?booleanInclude the object type with each object type attribute
parameters.id?stringThe object schema id
parameters.onlyValueEditable?booleanReturn only values that are associated with values that can be edited
parameters.query?stringA case-insensitive query used to filter object type attributes whose name or display name contains the value
options?RequestOptions-

Returns ​

Promise<object[]>