All Verbs | /RestApi/search/settings | ||
---|---|---|---|
GET | /RestApi/search/settings |
"use strict";
export class SettingsRequest {
/** @param {{IndexId?:string,SuggestionFields?:string,SectionName?:string,Text?:string,Take?:number,Skip?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
IndexId;
/** @type {string} */
SuggestionFields;
/** @type {string} */
SectionName;
/** @type {string} */
Text;
/** @type {number} */
Take;
/** @type {number} */
Skip;
}
export class SettingsResponse {
/** @param {{Results?:SettingDto[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {SettingDto[]} */
Results;
}
export class SettingDto {
/** @param {{Title?:string,SectionName?:string,FullSettingName?:string,Path?:string[],VisiblePath?:string,FullPath?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Title;
/** @type {string} */
SectionName;
/** @type {string} */
FullSettingName;
/** @type {string[]} */
Path;
/** @type {string} */
VisiblePath;
/** @type {string} */
FullPath;
}
JavaScript SettingsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /RestApi/search/settings HTTP/1.1
Host: www.asg.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
SuggestionFields: String,
SectionName: String,
Text: String,
Take: 0,
Skip: 0
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { Results: [ { Title: String, SectionName: String, FullSettingName: String, VisiblePath: String, FullPath: String } ] }