Type Alias RetrievalWorkerGet

Type declaration

• datePeriod: FixedDatePeriod | RelativeDatePeriod

  The date period to retrieve data over.

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

• Optionalfilter?: number | FilterExpression

  A 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.

• includeBypassedData: boolean

  Whether to include data which has been marked as 'bypassed.'

• items: {
      scriptId: string;
      type: DashboardItemType;
  }[]

  The script id and type of all the items on this retrieval.

• maxRecords: number

  The maximum number of records to fetch per standard.

  Will be a number between 1 and 1,000.

• name: string

  The retrieval name.

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

  The standards to retrieve.