Adaptive Search Webservices

SearchProfileController

getSearchProfiles

Get search profiles

Endpoint to retrieve search profiles


/v1/searchprofiles

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"https://{url}/adaptivesearchwebservices/v1/searchprofiles?catalogVersions=&code=¤tPage=&fields=&indexTypes=&needsTotal=&pageSize="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SearchProfileControllerApi;

import java.io.File;
import java.util.*;

public class SearchProfileControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        SearchProfileControllerApi apiInstance = new SearchProfileControllerApi();
        String catalogVersions = catalogVersions_example; // String | Filter for catalog versions
        String code = code_example; // String | Filter for search profile code
        Integer currentPage = ; // Integer | Current page number
        String fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)
        String indexTypes = indexTypes_example; // String | Filter for index types codes
        Boolean needsTotal = true; // Boolean | Request total count
        Integer pageSize = ; // Integer | Page size
        try {
            searchProfileList result = apiInstance.getSearchProfiles(catalogVersions, code, currentPage, fields, indexTypes, needsTotal, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchProfileControllerApi#getSearchProfiles");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SearchProfileControllerApi;

public class SearchProfileControllerApiExample {

    public static void main(String[] args) {
        SearchProfileControllerApi apiInstance = new SearchProfileControllerApi();
        String catalogVersions = catalogVersions_example; // String | Filter for catalog versions
        String code = code_example; // String | Filter for search profile code
        Integer currentPage = ; // Integer | Current page number
        String fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)
        String indexTypes = indexTypes_example; // String | Filter for index types codes
        Boolean needsTotal = true; // Boolean | Request total count
        Integer pageSize = ; // Integer | Page size
        try {
            searchProfileList result = apiInstance.getSearchProfiles(catalogVersions, code, currentPage, fields, indexTypes, needsTotal, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchProfileControllerApi#getSearchProfiles");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *catalogVersions = catalogVersions_example; // Filter for catalog versions (optional)
String *code = code_example; // Filter for search profile code (optional)
Integer *currentPage = ; // Current page number (optional)
String *fields = fields_example; // Response configuration (list of fields, which should be returned in response) (optional)
String *indexTypes = indexTypes_example; // Filter for index types codes (optional)
Boolean *needsTotal = true; // Request total count (optional)
Integer *pageSize = ; // Page size (optional)

SearchProfileControllerApi *apiInstance = [[SearchProfileControllerApi alloc] init];

// Get search profiles
[apiInstance getSearchProfilesWith:catalogVersions
    code:code
    currentPage:currentPage
    fields:fields
    indexTypes:indexTypes
    needsTotal:needsTotal
    pageSize:pageSize
              completionHandler: ^(searchProfileList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AdaptiveSearchWebservices = require('adaptive_search_webservices');
var defaultClient = AdaptiveSearchWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new AdaptiveSearchWebservices.SearchProfileControllerApi()
var opts = { 
  'catalogVersions': catalogVersions_example, // {{String}} Filter for catalog versions
  'code': code_example, // {{String}} Filter for search profile code
  'currentPage': , // {{Integer}} Current page number
  'fields': fields_example, // {{String}} Response configuration (list of fields, which should be returned in response)
  'indexTypes': indexTypes_example, // {{String}} Filter for index types codes
  'needsTotal': true, // {{Boolean}} Request total count
  'pageSize':  // {{Integer}} Page size
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSearchProfiles(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSearchProfilesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SearchProfileControllerApi();
            var catalogVersions = catalogVersions_example;  // String | Filter for catalog versions (optional) 
            var code = code_example;  // String | Filter for search profile code (optional) 
            var currentPage = new Integer(); // Integer | Current page number (optional) 
            var fields = fields_example;  // String | Response configuration (list of fields, which should be returned in response) (optional) 
            var indexTypes = indexTypes_example;  // String | Filter for index types codes (optional) 
            var needsTotal = true;  // Boolean | Request total count (optional) 
            var pageSize = new Integer(); // Integer | Page size (optional) 

            try
            {
                // Get search profiles
                searchProfileList result = apiInstance.getSearchProfiles(catalogVersions, code, currentPage, fields, indexTypes, needsTotal, pageSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SearchProfileControllerApi.getSearchProfiles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSearchProfileControllerApi();
$catalogVersions = catalogVersions_example; // String | Filter for catalog versions
$code = code_example; // String | Filter for search profile code
$currentPage = ; // Integer | Current page number
$fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)
$indexTypes = indexTypes_example; // String | Filter for index types codes
$needsTotal = true; // Boolean | Request total count
$pageSize = ; // Integer | Page size

try {
    $result = $api_instance->getSearchProfiles($catalogVersions, $code, $currentPage, $fields, $indexTypes, $needsTotal, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SearchProfileControllerApi->getSearchProfiles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SearchProfileControllerApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SearchProfileControllerApi->new();
my $catalogVersions = catalogVersions_example; # String | Filter for catalog versions
my $code = code_example; # String | Filter for search profile code
my $currentPage = ; # Integer | Current page number
my $fields = fields_example; # String | Response configuration (list of fields, which should be returned in response)
my $indexTypes = indexTypes_example; # String | Filter for index types codes
my $needsTotal = true; # Boolean | Request total count
my $pageSize = ; # Integer | Page size

eval { 
    my $result = $api_instance->getSearchProfiles(catalogVersions => $catalogVersions, code => $code, currentPage => $currentPage, fields => $fields, indexTypes => $indexTypes, needsTotal => $needsTotal, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SearchProfileControllerApi->getSearchProfiles: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SearchProfileControllerApi()
catalogVersions = catalogVersions_example # String | Filter for catalog versions (optional)
code = code_example # String | Filter for search profile code (optional)
currentPage =  # Integer | Current page number (optional)
fields = fields_example # String | Response configuration (list of fields, which should be returned in response) (optional)
indexTypes = indexTypes_example # String | Filter for index types codes (optional)
needsTotal = true # Boolean | Request total count (optional)
pageSize =  # Integer | Page size (optional)

try: 
    # Get search profiles
    api_response = api_instance.get_search_profiles(catalogVersions=catalogVersions, code=code, currentPage=currentPage, fields=fields, indexTypes=indexTypes, needsTotal=needsTotal, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SearchProfileControllerApi->getSearchProfiles: %s\n" % e)

Parameters

Query parameters
Name Description
catalogVersions
String
Filter for catalog versions
code
String
Filter for search profile code
currentPage
Integer
Current page number
fields
String
Response configuration (list of fields, which should be returned in response)
indexTypes
String
Filter for index types codes
needsTotal
Boolean
Request total count
pageSize
Integer
Page size

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found