1. Overview

adaptivesearchwebservices Documentation

1.1. Version information

Version : 1.0.0

1.2. URI scheme

Host : localhost:9001
BasePath : /adaptivesearchwebservices

1.3. Tags

  • Sample : Sample Methods

  • search-profile-controller : Search Profile Controller

2. Security

2.1. oauth2_password

Type : oauth2
Flow : password
Token URL : /authorizationserver/oauth/token

Name

basic

2.2. oauth2_client_credentials

Type : oauth2
Flow : application
Token URL : /authorizationserver/oauth/token

Name

basic

3. Resources

3.1. Sample

Sample Methods

3.2. Search-profile-controller

Search Profile Controller

3.2.1. Get search profiles

GET /v1/searchprofiles
Description

Endpoint to retrieve search profiles

Parameters
Type Name Description Schema

Query

catalogVersions
optional

Filter for catalog versions

string

Query

code
optional

Filter for search profile code

string

Query

currentPage
optional

Current page number

integer(int32)

Query

fields
optional

Response configuration (list of fields, which should be returned in response)

string

Query

indexTypes
optional

Filter for index types codes

string

Query

needsTotal
optional

Request total count

boolean

Query

pageSize
optional

Page size

integer(int32)
Responses
HTTP Code Description Schema

200

OK

searchProfileList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • /

Security
Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

4. Definitions

4.1. AsSearchProfileData

Name Schema

catalogVersion
optional

string

code
optional

string

indexType
optional

string

name
optional

string

4.2. pagination

Pagination info

Name Description Schema

count
optional

Number of elements on this page

integer(int32)

page
optional

Current page number

integer(int32)

totalCount
optional

Total number of elements

integer(int64)

totalPages
optional

Total number of pages

integer(int32)

4.3. searchProfileList

List of search profiles

Name Schema

pagination
optional

pagination

searchProfiles
optional

< AsSearchProfileData > array