Type Alias RetrievalWorkerUpdate

Type declaration

• OptionaldatePeriod?: FixedDatePeriod | RelativeDatePeriod

  Update the date period to retrieve data over.

  Either a fixed date range, or a dynamic date period.

• Optionalfilter?: number | FilterExpression | null

  Update the filter to apply to the data.

  If it is a number, it will use a saved filter.

  If it is an object, then it is a quick filter.

  If it is null, then no filter will be used.

• OptionalincludeBypassedData?: boolean

  Update whether to include data which has been marked as 'bypassed.'

• OptionalmaxRecords?: number

  Update the maximum number of records to fetch per standard. Must be a number between 1 and 1,000.

• Optionalstandards?: {
      characteristicIds: number[];
      type: "characteristic";
  } | {
      partIds?: number[];
      processIds?: number[];
      type: "partProcess";
  } | {
      filter: FilterExpression;
      type: "advancedMode";
  }

  Update the standards to retrieve.

  The retrieval standard type may not be changed, and the provided value must match the current standard type.