Search API

Default

createIndices

Creates indices for passed resource name and tenant id in request header.


/index/indices

Usage and SDK Samples

curl -X POST "https://falcon.ci.folio.org/search/index/indices"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
        IndexRequestBody indexRequestBody = examples/indexRequestBody.sample; // IndexRequestBody | 
        try {
            folioCreateIndexResponse result = apiInstance.createIndices(xOkapiTenant, indexRequestBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#createIndices");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
        IndexRequestBody indexRequestBody = examples/indexRequestBody.sample; // IndexRequestBody | 
        try {
            folioCreateIndexResponse result = apiInstance.createIndices(xOkapiTenant, indexRequestBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#createIndices");
            e.printStackTrace();
        }
    }
}
String *xOkapiTenant = xOkapiTenant_example; // X-Okapi-Tenant header value (default to null)
IndexRequestBody *indexRequestBody = examples/indexRequestBody.sample; //  (optional)

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

[apiInstance createIndicesWith:xOkapiTenant
    indexRequestBody:indexRequestBody
              completionHandler: ^(folioCreateIndexResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SearchApi = require('search_api');

var api = new SearchApi.DefaultApi()
var xOkapiTenant = xOkapiTenant_example; // {String} X-Okapi-Tenant header value
var opts = {
  'indexRequestBody': examples/indexRequestBody.sample // {IndexRequestBody} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createIndices(xOkapiTenant, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createIndicesExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var xOkapiTenant = xOkapiTenant_example;  // String | X-Okapi-Tenant header value (default to null)
            var indexRequestBody = new IndexRequestBody(); // IndexRequestBody |  (optional) 

            try
            {
                folioCreateIndexResponse result = apiInstance.createIndices(xOkapiTenant, indexRequestBody);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.createIndices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
$indexRequestBody = examples/indexRequestBody.sample; // IndexRequestBody | 

try {
    $result = $api_instance->createIndices($xOkapiTenant, $indexRequestBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->createIndices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $xOkapiTenant = xOkapiTenant_example; # String | X-Okapi-Tenant header value
my $indexRequestBody = WWW::OPenAPIClient::Object::IndexRequestBody->new(); # IndexRequestBody | 

eval { 
    my $result = $api_instance->createIndices(xOkapiTenant => $xOkapiTenant, indexRequestBody => $indexRequestBody);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->createIndices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = openapi_client.DefaultApi()
xOkapiTenant = xOkapiTenant_example # String | X-Okapi-Tenant header value (default to null)
indexRequestBody = examples/indexRequestBody.sample # IndexRequestBody |  (optional)

try: 
    api_response = api_instance.create_indices(xOkapiTenant, indexRequestBody=indexRequestBody)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->createIndices: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let xOkapiTenant = xOkapiTenant_example; // String
    let indexRequestBody = examples/indexRequestBody.sample; // IndexRequestBody

    let mut context = DefaultApi::Context::default();
    let result = client.createIndices(xOkapiTenant, indexRequestBody, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Header parameters
Name Description
x-okapi-tenant*
String
X-Okapi-Tenant header value
Required
Body parameters
Name Description
indexRequestBody

Responses


createLanguageConfig

Save languages that will be used for analyzers


/config/languages

Usage and SDK Samples

curl -X POST "https://falcon.ci.folio.org/search/config/languages"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        LanguageConfig languageConfig = ; // LanguageConfig | 
        try {
            languageConfig result = apiInstance.createLanguageConfig(languageConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#createLanguageConfig");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        LanguageConfig languageConfig = ; // LanguageConfig | 
        try {
            languageConfig result = apiInstance.createLanguageConfig(languageConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#createLanguageConfig");
            e.printStackTrace();
        }
    }
}
LanguageConfig *languageConfig = ; //  (optional)

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

[apiInstance createLanguageConfigWith:languageConfig
              completionHandler: ^(languageConfig output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SearchApi = require('search_api');

var api = new SearchApi.DefaultApi()
var opts = {
  'languageConfig':  // {LanguageConfig} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createLanguageConfig(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createLanguageConfigExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var languageConfig = new LanguageConfig(); // LanguageConfig |  (optional) 

            try
            {
                languageConfig result = apiInstance.createLanguageConfig(languageConfig);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.createLanguageConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$languageConfig = ; // LanguageConfig | 

try {
    $result = $api_instance->createLanguageConfig($languageConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->createLanguageConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $languageConfig = WWW::OPenAPIClient::Object::LanguageConfig->new(); # LanguageConfig | 

eval { 
    my $result = $api_instance->createLanguageConfig(languageConfig => $languageConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->createLanguageConfig: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = openapi_client.DefaultApi()
languageConfig =  # LanguageConfig |  (optional)

try: 
    api_response = api_instance.create_language_config(languageConfig=languageConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->createLanguageConfig: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let languageConfig = ; // LanguageConfig

    let mut context = DefaultApi::Context::default();
    let result = client.createLanguageConfig(languageConfig, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Body parameters
Name Description
languageConfig

Responses


deleteLanguageConfig

Delete all supported languages


/config/languages/{code}

Usage and SDK Samples

curl -X DELETE "https://falcon.ci.folio.org/search/config/languages/{code}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String code = code_example; // String | Language code
        try {
            apiInstance.deleteLanguageConfig(code);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deleteLanguageConfig");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String code = code_example; // String | Language code
        try {
            apiInstance.deleteLanguageConfig(code);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deleteLanguageConfig");
            e.printStackTrace();
        }
    }
}
String *code = code_example; // Language code (default to null)

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

[apiInstance deleteLanguageConfigWith:code
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SearchApi = require('search_api');

var api = new SearchApi.DefaultApi()
var code = code_example; // {String} Language code

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteLanguageConfig(code, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteLanguageConfigExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var code = code_example;  // String | Language code (default to null)

            try
            {
                apiInstance.deleteLanguageConfig(code);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.deleteLanguageConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$code = code_example; // String | Language code

try {
    $api_instance->deleteLanguageConfig($code);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deleteLanguageConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $code = code_example; # String | Language code

eval { 
    $api_instance->deleteLanguageConfig(code => $code);
};
if ($@) {
    warn "Exception when calling DefaultApi->deleteLanguageConfig: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = openapi_client.DefaultApi()
code = code_example # String | Language code (default to null)

try: 
    api_instance.delete_language_config(code)
except ApiException as e:
    print("Exception when calling DefaultApi->deleteLanguageConfig: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let code = code_example; // String

    let mut context = DefaultApi::Context::default();
    let result = client.deleteLanguageConfig(code, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
code*
String
Language code
Required

Responses


getAllLanguageConfigs

Get all supported languages


/config/languages

Usage and SDK Samples

curl -X GET "https://falcon.ci.folio.org/search/config/languages"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        try {
            languageConfigs result = apiInstance.getAllLanguageConfigs();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getAllLanguageConfigs");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            languageConfigs result = apiInstance.getAllLanguageConfigs();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getAllLanguageConfigs");
            e.printStackTrace();
        }
    }
}

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

[apiInstance getAllLanguageConfigsWithCompletionHandler: 
              ^(languageConfigs output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SearchApi = require('search_api');

var api = new SearchApi.DefaultApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllLanguageConfigs(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAllLanguageConfigsExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();

            try
            {
                languageConfigs result = apiInstance.getAllLanguageConfigs();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getAllLanguageConfigs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\DefaultApi();

try {
    $result = $api_instance->getAllLanguageConfigs();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getAllLanguageConfigs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

my $api_instance = WWW::OPenAPIClient::DefaultApi->new();

eval { 
    my $result = $api_instance->getAllLanguageConfigs();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->getAllLanguageConfigs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = openapi_client.DefaultApi()

try: 
    api_response = api_instance.get_all_language_configs()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->getAllLanguageConfigs: %s\n" % e)
extern crate DefaultApi;

pub fn main() {

    let mut context = DefaultApi::Context::default();
    let result = client.getAllLanguageConfigs(&context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Responses


indexRecords

Indexes the records into elasticsearch.


/index/records

Usage and SDK Samples

curl -X POST "https://falcon.ci.folio.org/search/index/records"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        array[resourceEventBody] resourceEventBody = examples/indexRecordRequestBody.sample; // array[resourceEventBody] | 
        try {
            folioIndexOperationResponse result = apiInstance.indexRecords(resourceEventBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#indexRecords");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        array[resourceEventBody] resourceEventBody = examples/indexRecordRequestBody.sample; // array[resourceEventBody] | 
        try {
            folioIndexOperationResponse result = apiInstance.indexRecords(resourceEventBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#indexRecords");
            e.printStackTrace();
        }
    }
}
array[resourceEventBody] *resourceEventBody = examples/indexRecordRequestBody.sample; //  (optional)

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

[apiInstance indexRecordsWith:resourceEventBody
              completionHandler: ^(folioIndexOperationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SearchApi = require('search_api');

var api = new SearchApi.DefaultApi()
var opts = {
  'resourceEventBody': examples/indexRecordRequestBody.sample // {array[resourceEventBody]} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.indexRecords(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class indexRecordsExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var resourceEventBody = new array[resourceEventBody](); // array[resourceEventBody] |  (optional) 

            try
            {
                folioIndexOperationResponse result = apiInstance.indexRecords(resourceEventBody);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.indexRecords: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$resourceEventBody = examples/indexRecordRequestBody.sample; // array[resourceEventBody] | 

try {
    $result = $api_instance->indexRecords($resourceEventBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->indexRecords: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $resourceEventBody = [WWW::OPenAPIClient::Object::array[resourceEventBody]->new()]; # array[resourceEventBody] | 

eval { 
    my $result = $api_instance->indexRecords(resourceEventBody => $resourceEventBody);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->indexRecords: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = openapi_client.DefaultApi()
resourceEventBody = examples/indexRecordRequestBody.sample # array[resourceEventBody] |  (optional)

try: 
    api_response = api_instance.index_records(resourceEventBody=resourceEventBody)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->indexRecords: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let resourceEventBody = examples/indexRecordRequestBody.sample; // array[resourceEventBody]

    let mut context = DefaultApi::Context::default();
    let result = client.indexRecords(resourceEventBody, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Body parameters
Name Description
resourceEventBody

Responses


searchInstances

Get a list of instances for CQL query


/instances

Usage and SDK Samples

curl -X GET "https://falcon.ci.folio.org/search/instances?query=&limit=&offset=&expandAll="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String query = query_example; // String | A CQL query string with search conditions.
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
        Boolean expandAll = true; // Boolean | Whether to return only basic properties or entire instance.
        Integer limit = 56; // Integer | Limit the number of elements returned in the response
        Integer offset = 56; // Integer | Skip over a number of elements by specifying an offset value for the query
        try {
            searchResult result = apiInstance.searchInstances(query, xOkapiTenant, expandAll, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#searchInstances");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String query = query_example; // String | A CQL query string with search conditions.
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
        Boolean expandAll = true; // Boolean | Whether to return only basic properties or entire instance.
        Integer limit = 56; // Integer | Limit the number of elements returned in the response
        Integer offset = 56; // Integer | Skip over a number of elements by specifying an offset value for the query
        try {
            searchResult result = apiInstance.searchInstances(query, xOkapiTenant, expandAll, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#searchInstances");
            e.printStackTrace();
        }
    }
}
String *query = query_example; // A CQL query string with search conditions. (default to null)
String *xOkapiTenant = xOkapiTenant_example; // X-Okapi-Tenant header value (default to null)
Boolean *expandAll = true; // Whether to return only basic properties or entire instance. (default to false)
Integer *limit = 56; // Limit the number of elements returned in the response (optional) (default to 100)
Integer *offset = 56; // Skip over a number of elements by specifying an offset value for the query (optional) (default to 0)

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

[apiInstance searchInstancesWith:query
    xOkapiTenant:xOkapiTenant
    expandAll:expandAll
    limit:limit
    offset:offset
              completionHandler: ^(searchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SearchApi = require('search_api');

var api = new SearchApi.DefaultApi()
var query = query_example; // {String} A CQL query string with search conditions.
var xOkapiTenant = xOkapiTenant_example; // {String} X-Okapi-Tenant header value
var expandAll = true; // {Boolean} Whether to return only basic properties or entire instance.
var opts = {
  'limit': 56, // {Integer} Limit the number of elements returned in the response
  'offset': 56 // {Integer} Skip over a number of elements by specifying an offset value for the query
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchInstances(query, xOkapiTenant, expandAll, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class searchInstancesExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var query = query_example;  // String | A CQL query string with search conditions. (default to null)
            var xOkapiTenant = xOkapiTenant_example;  // String | X-Okapi-Tenant header value (default to null)
            var expandAll = true;  // Boolean | Whether to return only basic properties or entire instance. (default to false)
            var limit = 56;  // Integer | Limit the number of elements returned in the response (optional)  (default to 100)
            var offset = 56;  // Integer | Skip over a number of elements by specifying an offset value for the query (optional)  (default to 0)

            try
            {
                searchResult result = apiInstance.searchInstances(query, xOkapiTenant, expandAll, limit, offset);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.searchInstances: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$query = query_example; // String | A CQL query string with search conditions.
$xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
$expandAll = true; // Boolean | Whether to return only basic properties or entire instance.
$limit = 56; // Integer | Limit the number of elements returned in the response
$offset = 56; // Integer | Skip over a number of elements by specifying an offset value for the query

try {
    $result = $api_instance->searchInstances($query, $xOkapiTenant, $expandAll, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->searchInstances: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $query = query_example; # String | A CQL query string with search conditions.
my $xOkapiTenant = xOkapiTenant_example; # String | X-Okapi-Tenant header value
my $expandAll = true; # Boolean | Whether to return only basic properties or entire instance.
my $limit = 56; # Integer | Limit the number of elements returned in the response
my $offset = 56; # Integer | Skip over a number of elements by specifying an offset value for the query

eval { 
    my $result = $api_instance->searchInstances(query => $query, xOkapiTenant => $xOkapiTenant, expandAll => $expandAll, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->searchInstances: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = openapi_client.DefaultApi()
query = query_example # String | A CQL query string with search conditions. (default to null)
xOkapiTenant = xOkapiTenant_example # String | X-Okapi-Tenant header value (default to null)
expandAll = true # Boolean | Whether to return only basic properties or entire instance. (default to false)
limit = 56 # Integer | Limit the number of elements returned in the response (optional) (default to 100)
offset = 56 # Integer | Skip over a number of elements by specifying an offset value for the query (optional) (default to 0)

try: 
    api_response = api_instance.search_instances(query, xOkapiTenant, expandAll, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->searchInstances: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let query = query_example; // String
    let xOkapiTenant = xOkapiTenant_example; // String
    let expandAll = true; // Boolean
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = DefaultApi::Context::default();
    let result = client.searchInstances(query, xOkapiTenant, expandAll, limit, offset, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Header parameters
Name Description
x-okapi-tenant*
String
X-Okapi-Tenant header value
Required
Query parameters
Name Description
query*
String
A CQL query string with search conditions.
Required
limit
Integer
Limit the number of elements returned in the response
offset
Integer
Skip over a number of elements by specifying an offset value for the query
expandAll*
Boolean
Whether to return only basic properties or entire instance.
Required

Responses


updateMappings

Creates mappings for passed resource name and tenant id in request header.


/index/mappings

Usage and SDK Samples

curl -X POST "https://falcon.ci.folio.org/search/index/mappings"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
        IndexRequestBody indexRequestBody = ; // IndexRequestBody | 
        try {
            folioIndexOperationResponse result = apiInstance.updateMappings(xOkapiTenant, indexRequestBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#updateMappings");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
        IndexRequestBody indexRequestBody = ; // IndexRequestBody | 
        try {
            folioIndexOperationResponse result = apiInstance.updateMappings(xOkapiTenant, indexRequestBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#updateMappings");
            e.printStackTrace();
        }
    }
}
String *xOkapiTenant = xOkapiTenant_example; // X-Okapi-Tenant header value (default to null)
IndexRequestBody *indexRequestBody = ; //  (optional)

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

[apiInstance updateMappingsWith:xOkapiTenant
    indexRequestBody:indexRequestBody
              completionHandler: ^(folioIndexOperationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SearchApi = require('search_api');

var api = new SearchApi.DefaultApi()
var xOkapiTenant = xOkapiTenant_example; // {String} X-Okapi-Tenant header value
var opts = {
  'indexRequestBody':  // {IndexRequestBody} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateMappings(xOkapiTenant, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateMappingsExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var xOkapiTenant = xOkapiTenant_example;  // String | X-Okapi-Tenant header value (default to null)
            var indexRequestBody = new IndexRequestBody(); // IndexRequestBody |  (optional) 

            try
            {
                folioIndexOperationResponse result = apiInstance.updateMappings(xOkapiTenant, indexRequestBody);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.updateMappings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
$indexRequestBody = ; // IndexRequestBody | 

try {
    $result = $api_instance->updateMappings($xOkapiTenant, $indexRequestBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->updateMappings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $xOkapiTenant = xOkapiTenant_example; # String | X-Okapi-Tenant header value
my $indexRequestBody = WWW::OPenAPIClient::Object::IndexRequestBody->new(); # IndexRequestBody | 

eval { 
    my $result = $api_instance->updateMappings(xOkapiTenant => $xOkapiTenant, indexRequestBody => $indexRequestBody);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->updateMappings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = openapi_client.DefaultApi()
xOkapiTenant = xOkapiTenant_example # String | X-Okapi-Tenant header value (default to null)
indexRequestBody =  # IndexRequestBody |  (optional)

try: 
    api_response = api_instance.update_mappings(xOkapiTenant, indexRequestBody=indexRequestBody)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->updateMappings: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let xOkapiTenant = xOkapiTenant_example; // String
    let indexRequestBody = ; // IndexRequestBody

    let mut context = DefaultApi::Context::default();
    let result = client.updateMappings(xOkapiTenant, indexRequestBody, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Header parameters
Name Description
x-okapi-tenant*
String
X-Okapi-Tenant header value
Required
Body parameters
Name Description
indexRequestBody

Responses