Skip to content

Function: findSchemaObjectTypesFlat() ​

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

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

Find all object types for this object schema

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ exclude?: string; id: string; includeObjectCounts?: boolean; query?: string; }-
parameters.exclude?stringExclude object types whose name or display name exactly matches this value, ignoring case
parameters.id?stringThe object schema id
parameters.includeObjectCounts?booleanIf true, the objectCount attribute is populated for each object type
parameters.query?stringA case-insensitive query used to filter object types whose name or display name starts with the value
options?RequestOptions-

Returns ​

Promise<object[]>