src/app/modules/core/interfaces/search.ts
Interface
Properties |
|
| channel |
channel:
|
Type : string
|
| Optional |
|
page channel |
| concept |
concept:
|
Type : Array<object>
|
| Optional |
|
Content concept |
| contentType |
contentType:
|
Type : string[]
|
| Optional |
|
Content type - course,textbook,content |
| createdBy |
createdBy:
|
Type : string
|
| Optional |
|
createdBy id |
| exists |
exists:
|
Type : Array<string>
|
| Optional |
| facets |
facets:
|
Type : Array<string>
|
| Optional |
|
facet filters |
| fields |
fields:
|
Type : string[]
|
| Optional |
| filters |
filters:
|
Type : any
|
| Optional |
|
filters param |
| isRootOrg |
isRootOrg:
|
Type : boolean
|
| Optional |
| limit |
limit:
|
Type : number
|
| Optional |
|
page limit |
| locationIds |
locationIds:
|
Type : string[]
|
| Optional |
| mimeType |
mimeType:
|
Type : Array<string>
|
| Optional |
|
page mimeType |
| mode |
mode:
|
Type : string
|
| Optional |
|
mode : soft |
| objectType |
objectType:
|
Type : string[]
|
| Optional |
|
page objectType |
| offset |
offset:
|
Type : number
|
| Optional |
|
page offset |
| orgid |
orgid:
|
Type : string[]
|
| Optional |
|
Organization ids |
| pageNumber |
pageNumber:
|
Type : number
|
| Optional |
| params |
params:
|
Type : any
|
| Optional |
|
Additional params - userId, lastUpdatedOn, sort etc |
| query |
query:
|
Type : string
|
| Optional |
|
page query |
| rootOrgId |
rootOrgId:
|
Type : string[]
|
| Optional |
|
rootOrgId ids |
| softConstraints |
softConstraints:
|
Type : object
|
| Optional |
|
filters badgeAssertions |
| sort_by |
sort_by:
|
Type : literal type
|
| Optional |
|
filters sort_by |
| status |
status:
|
Type : string[]
|
| Optional |
|
Content status |
export interface SearchParam {
/**
* Content status
*/
status?: string[];
/**
* Content type - course,textbook,content
*/
contentType?: string[];
/**
* Content concept
*/
concept?: Array<object>;
/**
* Additional params - userId, lastUpdatedOn, sort etc
*/
params?: any;
/**
* createdBy id
*/
createdBy?: string;
/**
* Organization ids
*/
orgid?: string[];
/**
* rootOrgId ids
*/
rootOrgId?: string[];
/**
* page limit
*/
limit?: number;
/**
* page offset
*/
offset?: number;
pageNumber?: number;
/**
* page mimeType
*/
mimeType?: Array<string>;
/**
* page query
*/
query?: string;
/**
* page channel
*/
channel?: string;
/**
* page objectType
*/
objectType?: string[];
/**
* filters param
*/
filters?: any;
/**
* filters sort_by
*/
sort_by?: { [key: string]: string };
/**
* filters badgeAssertions
*/
softConstraints?: object;
/**
* facet filters
*/
facets?: Array<string>;
exists?: Array<string>;
/**
* mode : soft
*/
mode?: string;
fields?: string[];
locationIds?: string[];
isRootOrg?: boolean;
}