Skip to content

Variable: ObjectFilterParamsSchema ​

ts
const ObjectFilterParamsSchema: ZodObject<{
  asc: ZodOptional<ZodNumber>;
  attributesToDisplay: ZodOptional<ZodObject<{
     attributesToDisplayIds: ZodArray<ZodString>;
  }, ApiObjectConfig<undefined>>>;
  includeAttributes: ZodOptional<ZodBoolean>;
  objectId: ZodOptional<ZodString>;
  objectSchemaId: ZodString;
  objectTypeId: ZodString;
  orderByTypeAttrId: ZodOptional<ZodNumber>;
  page: ZodOptional<ZodNumber>;
  qlQuery: ZodString;
  resultsPerPage: ZodNumber;
}, ApiObjectConfig<undefined>>;

Defined in: src/assets/models/objectFilterParams.ts:6

A filter object that is used to find a paginated result set based on an object type and an AQL query