1. Overview

These services are used to get search profiles using sort, facet, and boost settings.

1.1. Version information

Version : 2.2.0

1.2. License information

License : Use of this file is subject to the terms of your agreement with SAP SE or its affiliates respecting the use of the SAP product for which this file relates.
Terms of service : null

1.3. URI scheme

Host : localhost:9001
BasePath : /adaptivesearchwebservices

1.4. Tags

  • Search Profile : Search Profile Controller

1.5. Produces

  • application/xml

  • application/json

2. Paths

2.1. Get search profiles

GET /v1/searchprofiles

2.1.1. Description

Endpoint to retrieve search profiles

2.1.2. Parameters

Type Name Description Schema Default

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. This is the list of fields that should be returned in the response body. Examples BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

indexTypes
optional

Filter for index types codes

string

Query

needsTotal
optional

Request total count

boolean

Query

pageSize
optional

Page size

integer (int32)

2.1.3. Responses

HTTP Code Description Schema

200

OK

searchProfileList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.1.4. Tags

  • Search Profile

2.1.5. Security

Type Name

oauth2

oauth2_client_credentials

oauth2

oauth2_password

3. Definitions

3.1. AsSearchProfileData

Represents a search profile in adaptive search

Name Description Schema

catalogVersion
optional

The version of the catalog
Example : "Online, Staged"

string

code
optional

The search profile code

string

indexType
optional

The type of the search profile index
Example : "electronics store product"

string

name
optional

The name of the search profile

string

3.2. pagination

Pagination info

Name Description Schema

count
optional

Number of search profiles displayed on this page

integer (int32)

hasNext
optional

Indicates if there is next page

boolean

hasPrevious
optional

Indicates if there is previous page

boolean

page
optional

Current page number

integer (int32)

totalCount
optional

Total number of elements

integer (int64)

totalPages
optional

Total number of pages

integer (int32)

3.3. searchProfileList

List of search profiles

Name Schema

pagination
optional

pagination

searchProfiles
optional

< AsSearchProfileData > array

4. Security

4.1. oauth2_client_credentials

Type : oauth2
Flow : application
Token URL : https://{oauth2_url}/authorizationserver/oauth/token

Name

extended

4.2. oauth2_password

Type : oauth2
Flow : password
Token URL : https://{oauth2_url}/authorizationserver/oauth/token

Name

basic