Type Alias FilterRequest

{
* description: "this is a filter sample",
* filterType: "REP",
* filterV1_0: {
* fieldsByState: {
* "$": [
* {
* name: "Country",
* overrideValues: false,
* selectExcluded: false,
* values: [
* {
* valueAsText: "1-Argentina",
* valueType: "string"
* },
* {
* valueAsText: "4-Brazil",
* valueType: "string"
* }
* ]
* },
* {
* name: "Order number",
* overrideValues: false,
* selectExcluded: false,
* values: [
* {
* valueAsNumber: 61300,
* valueAsText: "61300",
* valueType: "number"
* }
* ]
* }
* ]
* }
* },
* filterVersion: "filter-1.0",
* name: "Filter sample"
* }
type FilterRequest = {
    appId?: string;
    description?: string;
    filterType: FilterType;
    filterV1_0?: FilterV10;
    filterVersion: "filter-1.0" | "filter-2.0";
    name: string;
    ownerId?: string;
}
Index

Properties

appId?: string

The App ID.

description?: string

The filter description.

filterType: FilterType
filterV1_0?: FilterV10
filterVersion: "filter-1.0" | "filter-2.0"
name: string

The filter name.

ownerId?: string

The user that owns the filter, if missing the same as the request user.