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\
 -H "Accept: application/json"\
 -H "Content-Type: application/json"\
 "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) {
        
        // Create an instance of the API class
        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();
        }
    }
}


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *xOkapiTenant = xOkapiTenant_example; // X-Okapi-Tenant header value (default to null)
IndexRequestBody *indexRequestBody = examples/indexRequestBody.sample; //  (optional)

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

// Create an instance of the API class
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()
        {
            
            // Create an instance of the API class
            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');

// Create an instance of the API class
$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;

# Create an instance of the API class
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\
 -H "Accept: application/json"\
 -H "Content-Type: application/json"\
 "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) {
        
        // Create an instance of the API class
        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();
        }
    }
}


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
LanguageConfig *languageConfig = ; //  (optional)

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

// Create an instance of the API class
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()
        {
            
            // Create an instance of the API class
            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');

// Create an instance of the API class
$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;

# Create an instance of the API class
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) {
        
        // Create an instance of the API class
        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();
        }
    }
}


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *code = code_example; // Language code (default to null)

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

// Create an instance of the API class
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()
        {
            
            // Create an instance of the API class
            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');

// Create an instance of the API class
$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;

# Create an instance of the API class
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\
 -H "Accept: application/json"\
 "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) {
        
        // Create an instance of the API class
        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();
        }
    }
}


// Create an instance of the API class
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');

// Create an instance of the API class
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()
        {
            
            // Create an instance of the API class
            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');

// Create an instance of the API class
$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;

# Create an instance of the API class
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


getFacets

Provides list of facets for instance


/instances/facets

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "https://falcon.ci.folio.org/search/instances/facets?cqlFacetRequest="
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) {
        
        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        cqlFacetRequest cqlFacetRequest = ; // cqlFacetRequest | Facet request parameters (cql query, facet names) as object.
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
        
        try {
            facetResult result = apiInstance.getFacets(cqlFacetRequest, xOkapiTenant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getFacets");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        cqlFacetRequest cqlFacetRequest = ; // cqlFacetRequest | Facet request parameters (cql query, facet names) as object.
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
        
        try {
            facetResult result = apiInstance.getFacets(cqlFacetRequest, xOkapiTenant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getFacets");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
cqlFacetRequest *cqlFacetRequest = ; // Facet request parameters (cql query, facet names) as object. (default to null)
String *xOkapiTenant = xOkapiTenant_example; // X-Okapi-Tenant header value (default to null)

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

// Create an instance of the API class
var api = new SearchApi.DefaultApi()
var cqlFacetRequest = ; // {cqlFacetRequest} Facet request parameters (cql query, facet names) as object.
var xOkapiTenant = xOkapiTenant_example; // {String} X-Okapi-Tenant header value

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

namespace Example
{
    public class getFacetsExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var cqlFacetRequest = new cqlFacetRequest(); // cqlFacetRequest | Facet request parameters (cql query, facet names) as object. (default to null)
            var xOkapiTenant = xOkapiTenant_example;  // String | X-Okapi-Tenant header value (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$cqlFacetRequest = ; // cqlFacetRequest | Facet request parameters (cql query, facet names) as object.
$xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $cqlFacetRequest = ; # cqlFacetRequest | Facet request parameters (cql query, facet names) as object.
my $xOkapiTenant = xOkapiTenant_example; # String | X-Okapi-Tenant header value

eval { 
    my $result = $api_instance->getFacets(cqlFacetRequest => $cqlFacetRequest, xOkapiTenant => $xOkapiTenant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->getFacets: $@\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()
cqlFacetRequest =  # cqlFacetRequest | Facet request parameters (cql query, facet names) as object. (default to null)
xOkapiTenant = xOkapiTenant_example # String | X-Okapi-Tenant header value (default to null)

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

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

    let mut context = DefaultApi::Context::default();
    let result = client.getFacets(cqlFacetRequest, xOkapiTenant, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Header parameters
Name Description
x-okapi-tenant*
String
X-Okapi-Tenant header value
Required
Query parameters
Name Description
cqlFacetRequest*
cqlFacetRequest
Facet request parameters (cql query, facet names) as object.
Required

Responses


getInstanceIds

Get a list of instance ids for CQL query


/instances/ids

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "https://falcon.ci.folio.org/search/instances/ids?query="
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) {
        
        // Create an instance of the API class
        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
        
        try {
            apiInstance.getInstanceIds(query, xOkapiTenant);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getInstanceIds");
            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
        
        try {
            apiInstance.getInstanceIds(query, xOkapiTenant);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getInstanceIds");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
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)

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

// Create an instance of the API class
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 callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getInstanceIds(query, xOkapiTenant, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getInstanceIdsExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            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)

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

// Create an instance of the API class
$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

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

# Create an instance of the API class
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

eval { 
    $api_instance->getInstanceIds(query => $query, xOkapiTenant => $xOkapiTenant);
};
if ($@) {
    warn "Exception when calling DefaultApi->getInstanceIds: $@\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)

try: 
    api_instance.get_instance_ids(query, xOkapiTenant)
except ApiException as e:
    print("Exception when calling DefaultApi->getInstanceIds: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let query = query_example; // String
    let xOkapiTenant = xOkapiTenant_example; // String

    let mut context = DefaultApi::Context::default();
    let result = client.getInstanceIds(query, xOkapiTenant, &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

Responses


indexRecords

Indexes the records into elasticsearch.


/index/records

Usage and SDK Samples

curl -X POST\
 -H "Accept: application/json"\
 -H "Content-Type: application/json"\
 "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) {
        
        // Create an instance of the API class
        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();
        }
    }
}


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
array[resourceEventBody] *resourceEventBody = examples/indexRecordRequestBody.sample; //  (optional)

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

// Create an instance of the API class
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()
        {
            
            // Create an instance of the API class
            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');

// Create an instance of the API class
$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;

# Create an instance of the API class
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


reindexInventoryRecords

Initiates reindex for the inventory records


/index/inventory/reindex

Usage and SDK Samples

curl -X POST\
 -H "Accept: application/json"\
 -H "Content-Type: application/json"\
 "https://falcon.ci.folio.org/search/index/inventory/reindex"
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) {
        
        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
        ReindexRequest reindexRequest = examples/reindexRequest.sample; // ReindexRequest | 
        
        try {
            reindexJob result = apiInstance.reindexInventoryRecords(xOkapiTenant, reindexRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#reindexInventoryRecords");
            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
        ReindexRequest reindexRequest = examples/reindexRequest.sample; // ReindexRequest | 
        
        try {
            reindexJob result = apiInstance.reindexInventoryRecords(xOkapiTenant, reindexRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#reindexInventoryRecords");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *xOkapiTenant = xOkapiTenant_example; // X-Okapi-Tenant header value (default to null)
ReindexRequest *reindexRequest = examples/reindexRequest.sample; //  (optional)

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

// Create an instance of the API class
var api = new SearchApi.DefaultApi()
var xOkapiTenant = xOkapiTenant_example; // {String} X-Okapi-Tenant header value
var opts = {
  'reindexRequest': examples/reindexRequest.sample // {ReindexRequest} 
};

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

namespace Example
{
    public class reindexInventoryRecordsExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var xOkapiTenant = xOkapiTenant_example;  // String | X-Okapi-Tenant header value (default to null)
            var reindexRequest = new ReindexRequest(); // ReindexRequest |  (optional) 

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
$reindexRequest = examples/reindexRequest.sample; // ReindexRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $xOkapiTenant = xOkapiTenant_example; # String | X-Okapi-Tenant header value
my $reindexRequest = WWW::OPenAPIClient::Object::ReindexRequest->new(); # ReindexRequest | 

eval { 
    my $result = $api_instance->reindexInventoryRecords(xOkapiTenant => $xOkapiTenant, reindexRequest => $reindexRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->reindexInventoryRecords: $@\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)
reindexRequest = examples/reindexRequest.sample # ReindexRequest |  (optional)

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

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

    let mut context = DefaultApi::Context::default();
    let result = client.reindexInventoryRecords(xOkapiTenant, reindexRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

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

Responses


searchInstances

Get a list of instances for CQL query


/instances

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "https://falcon.ci.folio.org/search/instances?cqlSearchRequest="
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) {
        
        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        cqlSearchRequest cqlSearchRequest = ; // cqlSearchRequest | Search request parameters(query, size, limit and etc.) as object.
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
        
        try {
            searchResult result = apiInstance.searchInstances(cqlSearchRequest, xOkapiTenant);
            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();
        cqlSearchRequest cqlSearchRequest = ; // cqlSearchRequest | Search request parameters(query, size, limit and etc.) as object.
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
        
        try {
            searchResult result = apiInstance.searchInstances(cqlSearchRequest, xOkapiTenant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#searchInstances");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
cqlSearchRequest *cqlSearchRequest = ; // Search request parameters(query, size, limit and etc.) as object. (default to null)
String *xOkapiTenant = xOkapiTenant_example; // X-Okapi-Tenant header value (default to null)

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

// Create an instance of the API class
var api = new SearchApi.DefaultApi()
var cqlSearchRequest = ; // {cqlSearchRequest} Search request parameters(query, size, limit and etc.) as object.
var xOkapiTenant = xOkapiTenant_example; // {String} X-Okapi-Tenant header value

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchInstances(cqlSearchRequest, xOkapiTenant, 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()
        {
            
            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var cqlSearchRequest = new cqlSearchRequest(); // cqlSearchRequest | Search request parameters(query, size, limit and etc.) as object. (default to null)
            var xOkapiTenant = xOkapiTenant_example;  // String | X-Okapi-Tenant header value (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$cqlSearchRequest = ; // cqlSearchRequest | Search request parameters(query, size, limit and etc.) as object.
$xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value

try {
    $result = $api_instance->searchInstances($cqlSearchRequest, $xOkapiTenant);
    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;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $cqlSearchRequest = ; # cqlSearchRequest | Search request parameters(query, size, limit and etc.) as object.
my $xOkapiTenant = xOkapiTenant_example; # String | X-Okapi-Tenant header value

eval { 
    my $result = $api_instance->searchInstances(cqlSearchRequest => $cqlSearchRequest, xOkapiTenant => $xOkapiTenant);
    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()
cqlSearchRequest =  # cqlSearchRequest | Search request parameters(query, size, limit and etc.) as object. (default to null)
xOkapiTenant = xOkapiTenant_example # String | X-Okapi-Tenant header value (default to null)

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

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

    let mut context = DefaultApi::Context::default();
    let result = client.searchInstances(cqlSearchRequest, xOkapiTenant, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Header parameters
Name Description
x-okapi-tenant*
String
X-Okapi-Tenant header value
Required
Query parameters
Name Description
cqlSearchRequest*
cqlSearchRequest
Search request parameters(query, size, limit and etc.) as object.
Required

Responses


updateLanguageConfig

Update language config settings


/config/languages/{code}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/json"\
 "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) {
        
        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        String code = code_example; // String | Language code
        LanguageConfig languageConfig = ; // LanguageConfig | 
        
        try {
            languageConfig result = apiInstance.updateLanguageConfig(code, languageConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#updateLanguageConfig");
            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
        LanguageConfig languageConfig = ; // LanguageConfig | 
        
        try {
            languageConfig result = apiInstance.updateLanguageConfig(code, languageConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#updateLanguageConfig");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *code = code_example; // Language code (default to null)
LanguageConfig *languageConfig = ; //  (optional)

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

// Create an instance of the API class
var api = new SearchApi.DefaultApi()
var code = code_example; // {String} Language code
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.updateLanguageConfig(code, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateLanguageConfigExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var code = code_example;  // String | Language code (default to null)
            var languageConfig = new LanguageConfig(); // LanguageConfig |  (optional) 

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$code = code_example; // String | Language code
$languageConfig = ; // LanguageConfig | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $code = code_example; # String | Language code
my $languageConfig = WWW::OPenAPIClient::Object::LanguageConfig->new(); # LanguageConfig | 

eval { 
    my $result = $api_instance->updateLanguageConfig(code => $code, languageConfig => $languageConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->updateLanguageConfig: $@\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)
languageConfig =  # LanguageConfig |  (optional)

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

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

    let mut context = DefaultApi::Context::default();
    let result = client.updateLanguageConfig(code, languageConfig, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
code*
String
Language code
Required
Body parameters
Name Description
languageConfig

Responses


updateMappings

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


/index/mappings

Usage and SDK Samples

curl -X POST\
 -H "Accept: application/json"\
 -H "Content-Type: application/json"\
 "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) {
        
        // Create an instance of the API class
        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();
        }
    }
}


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *xOkapiTenant = xOkapiTenant_example; // X-Okapi-Tenant header value (default to null)
IndexRequestBody *indexRequestBody = ; //  (optional)

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

// Create an instance of the API class
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()
        {
            
            // Create an instance of the API class
            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');

// Create an instance of the API class
$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;

# Create an instance of the API class
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