Search API

Browse

browseAuthorities

Provides list of authorities by headingRef


/browse/authorities

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://folio-dev-spitfire-okapi.ci.folio.org/browse/authorities?query=query_example&limit=56&expandAll=true&highlightMatch=true&precedingRecordsCount=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BrowseApi;

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

public class BrowseApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        BrowseApi apiInstance = new BrowseApi();
        String query = query_example; // String | A CQL query string with search conditions.
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
        Integer limit = 56; // Integer | Limit the number of elements returned in the response.
        Boolean expandAll = true; // Boolean | Whether to return only basic properties or entire instance.
        Boolean highlightMatch = true; // Boolean | Whether to highlight matched resource by query input or not.
        Integer precedingRecordsCount = 56; // Integer | Number of preceding records for browsing around and around-including options

        try {
            authorityBrowseResult result = apiInstance.browseAuthorities(query, xOkapiTenant, limit, expandAll, highlightMatch, precedingRecordsCount);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BrowseApi#browseAuthorities");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String query = new String(); // String | A CQL query string with search conditions.
final String xOkapiTenant = new String(); // String | X-Okapi-Tenant header value
final Integer limit = new Integer(); // Integer | Limit the number of elements returned in the response.
final Boolean expandAll = new Boolean(); // Boolean | Whether to return only basic properties or entire instance.
final Boolean highlightMatch = new Boolean(); // Boolean | Whether to highlight matched resource by query input or not.
final Integer precedingRecordsCount = new Integer(); // Integer | Number of preceding records for browsing around and around-including options

try {
    final result = await api_instance.browseAuthorities(query, xOkapiTenant, limit, expandAll, highlightMatch, precedingRecordsCount);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->browseAuthorities: $e\n');
}

import org.openapitools.client.api.BrowseApi;

public class BrowseApiExample {
    public static void main(String[] args) {
        BrowseApi apiInstance = new BrowseApi();
        String query = query_example; // String | A CQL query string with search conditions.
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
        Integer limit = 56; // Integer | Limit the number of elements returned in the response.
        Boolean expandAll = true; // Boolean | Whether to return only basic properties or entire instance.
        Boolean highlightMatch = true; // Boolean | Whether to highlight matched resource by query input or not.
        Integer precedingRecordsCount = 56; // Integer | Number of preceding records for browsing around and around-including options

        try {
            authorityBrowseResult result = apiInstance.browseAuthorities(query, xOkapiTenant, limit, expandAll, highlightMatch, precedingRecordsCount);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BrowseApi#browseAuthorities");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
BrowseApi *apiInstance = [[BrowseApi 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)
Integer *limit = 56; // Limit the number of elements returned in the response. (optional) (default to 100)
Boolean *expandAll = true; // Whether to return only basic properties or entire instance. (optional) (default to false)
Boolean *highlightMatch = true; // Whether to highlight matched resource by query input or not. (optional) (default to true)
Integer *precedingRecordsCount = 56; // Number of preceding records for browsing around and around-including options (optional) (default to null)

[apiInstance browseAuthoritiesWith:query
    xOkapiTenant:xOkapiTenant
    limit:limit
    expandAll:expandAll
    highlightMatch:highlightMatch
    precedingRecordsCount:precedingRecordsCount
              completionHandler: ^(authorityBrowseResult 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.BrowseApi()
var query = query_example; // {String} A CQL query string with search conditions.
var xOkapiTenant = xOkapiTenant_example; // {String} X-Okapi-Tenant header value
var opts = {
  'limit': 56, // {Integer} Limit the number of elements returned in the response.
  'expandAll': true, // {Boolean} Whether to return only basic properties or entire instance.
  'highlightMatch': true, // {Boolean} Whether to highlight matched resource by query input or not.
  'precedingRecordsCount': 56 // {Integer} Number of preceding records for browsing around and around-including options
};

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

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

            // Create an instance of the API class
            var apiInstance = new BrowseApi();
            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 limit = 56;  // Integer | Limit the number of elements returned in the response. (optional)  (default to 100)
            var expandAll = true;  // Boolean | Whether to return only basic properties or entire instance. (optional)  (default to false)
            var highlightMatch = true;  // Boolean | Whether to highlight matched resource by query input or not. (optional)  (default to true)
            var precedingRecordsCount = 56;  // Integer | Number of preceding records for browsing around and around-including options (optional)  (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BrowseApi();
$query = query_example; // String | A CQL query string with search conditions.
$xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
$limit = 56; // Integer | Limit the number of elements returned in the response.
$expandAll = true; // Boolean | Whether to return only basic properties or entire instance.
$highlightMatch = true; // Boolean | Whether to highlight matched resource by query input or not.
$precedingRecordsCount = 56; // Integer | Number of preceding records for browsing around and around-including options

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BrowseApi->new();
my $query = query_example; # String | A CQL query string with search conditions.
my $xOkapiTenant = xOkapiTenant_example; # String | X-Okapi-Tenant header value
my $limit = 56; # Integer | Limit the number of elements returned in the response.
my $expandAll = true; # Boolean | Whether to return only basic properties or entire instance.
my $highlightMatch = true; # Boolean | Whether to highlight matched resource by query input or not.
my $precedingRecordsCount = 56; # Integer | Number of preceding records for browsing around and around-including options

eval {
    my $result = $api_instance->browseAuthorities(query => $query, xOkapiTenant => $xOkapiTenant, limit => $limit, expandAll => $expandAll, highlightMatch => $highlightMatch, precedingRecordsCount => $precedingRecordsCount);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BrowseApi->browseAuthorities: $@\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.BrowseApi()
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)
limit = 56 # Integer | Limit the number of elements returned in the response. (optional) (default to 100)
expandAll = true # Boolean | Whether to return only basic properties or entire instance. (optional) (default to false)
highlightMatch = true # Boolean | Whether to highlight matched resource by query input or not. (optional) (default to true)
precedingRecordsCount = 56 # Integer | Number of preceding records for browsing around and around-including options (optional) (default to null)

try:
    api_response = api_instance.browse_authorities(query, xOkapiTenant, limit=limit, expandAll=expandAll, highlightMatch=highlightMatch, precedingRecordsCount=precedingRecordsCount)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BrowseApi->browseAuthorities: %s\n" % e)
extern crate BrowseApi;

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

    let mut context = BrowseApi::Context::default();
    let result = client.browseAuthorities(query, xOkapiTenant, limit, expandAll, highlightMatch, precedingRecordsCount, &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.
expandAll
Boolean
Whether to return only basic properties or entire instance.
highlightMatch
Boolean
Whether to highlight matched resource by query input or not.
precedingRecordsCount
Integer
Number of preceding records for browsing around and around-including options

Responses


browseInstancesByCallNumber

Provides list of instances for browsing by call number


/browse/call-numbers/instances

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://folio-dev-spitfire-okapi.ci.folio.org/browse/call-numbers/instances?query=query_example&limit=56&expandAll=true&highlightMatch=true&precedingRecordsCount=56&callNumberType="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BrowseApi;

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

public class BrowseApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        BrowseApi apiInstance = new BrowseApi();
        String query = query_example; // String | A CQL query string with search conditions.
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
        Integer limit = 56; // Integer | Limit the number of elements returned in the browse response.
        Boolean expandAll = true; // Boolean | Whether to return only basic properties or entire instance.
        Boolean highlightMatch = true; // Boolean | Whether to highlight matched resource by query input or not.
        Integer precedingRecordsCount = 56; // Integer | Number of preceding records for browsing around and around-including options
        CallNumberType callNumberType = ; // CallNumberType | Type of call number

        try {
            callNumberBrowseResult result = apiInstance.browseInstancesByCallNumber(query, xOkapiTenant, limit, expandAll, highlightMatch, precedingRecordsCount, callNumberType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BrowseApi#browseInstancesByCallNumber");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String query = new String(); // String | A CQL query string with search conditions.
final String xOkapiTenant = new String(); // String | X-Okapi-Tenant header value
final Integer limit = new Integer(); // Integer | Limit the number of elements returned in the browse response.
final Boolean expandAll = new Boolean(); // Boolean | Whether to return only basic properties or entire instance.
final Boolean highlightMatch = new Boolean(); // Boolean | Whether to highlight matched resource by query input or not.
final Integer precedingRecordsCount = new Integer(); // Integer | Number of preceding records for browsing around and around-including options
final CallNumberType callNumberType = new CallNumberType(); // CallNumberType | Type of call number

try {
    final result = await api_instance.browseInstancesByCallNumber(query, xOkapiTenant, limit, expandAll, highlightMatch, precedingRecordsCount, callNumberType);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->browseInstancesByCallNumber: $e\n');
}

import org.openapitools.client.api.BrowseApi;

public class BrowseApiExample {
    public static void main(String[] args) {
        BrowseApi apiInstance = new BrowseApi();
        String query = query_example; // String | A CQL query string with search conditions.
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
        Integer limit = 56; // Integer | Limit the number of elements returned in the browse response.
        Boolean expandAll = true; // Boolean | Whether to return only basic properties or entire instance.
        Boolean highlightMatch = true; // Boolean | Whether to highlight matched resource by query input or not.
        Integer precedingRecordsCount = 56; // Integer | Number of preceding records for browsing around and around-including options
        CallNumberType callNumberType = ; // CallNumberType | Type of call number

        try {
            callNumberBrowseResult result = apiInstance.browseInstancesByCallNumber(query, xOkapiTenant, limit, expandAll, highlightMatch, precedingRecordsCount, callNumberType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BrowseApi#browseInstancesByCallNumber");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
BrowseApi *apiInstance = [[BrowseApi 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)
Integer *limit = 56; // Limit the number of elements returned in the browse response. (optional) (default to 100)
Boolean *expandAll = true; // Whether to return only basic properties or entire instance. (optional) (default to false)
Boolean *highlightMatch = true; // Whether to highlight matched resource by query input or not. (optional) (default to true)
Integer *precedingRecordsCount = 56; // Number of preceding records for browsing around and around-including options (optional) (default to null)
CallNumberType *callNumberType = ; // Type of call number (optional) (default to null)

[apiInstance browseInstancesByCallNumberWith:query
    xOkapiTenant:xOkapiTenant
    limit:limit
    expandAll:expandAll
    highlightMatch:highlightMatch
    precedingRecordsCount:precedingRecordsCount
    callNumberType:callNumberType
              completionHandler: ^(callNumberBrowseResult 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.BrowseApi()
var query = query_example; // {String} A CQL query string with search conditions.
var xOkapiTenant = xOkapiTenant_example; // {String} X-Okapi-Tenant header value
var opts = {
  'limit': 56, // {Integer} Limit the number of elements returned in the browse response.
  'expandAll': true, // {Boolean} Whether to return only basic properties or entire instance.
  'highlightMatch': true, // {Boolean} Whether to highlight matched resource by query input or not.
  'precedingRecordsCount': 56, // {Integer} Number of preceding records for browsing around and around-including options
  'callNumberType':  // {CallNumberType} Type of call number
};

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

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

            // Create an instance of the API class
            var apiInstance = new BrowseApi();
            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 limit = 56;  // Integer | Limit the number of elements returned in the browse response. (optional)  (default to 100)
            var expandAll = true;  // Boolean | Whether to return only basic properties or entire instance. (optional)  (default to false)
            var highlightMatch = true;  // Boolean | Whether to highlight matched resource by query input or not. (optional)  (default to true)
            var precedingRecordsCount = 56;  // Integer | Number of preceding records for browsing around and around-including options (optional)  (default to null)
            var callNumberType = new CallNumberType(); // CallNumberType | Type of call number (optional)  (default to null)

            try {
                callNumberBrowseResult result = apiInstance.browseInstancesByCallNumber(query, xOkapiTenant, limit, expandAll, highlightMatch, precedingRecordsCount, callNumberType);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BrowseApi.browseInstancesByCallNumber: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BrowseApi();
$query = query_example; // String | A CQL query string with search conditions.
$xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
$limit = 56; // Integer | Limit the number of elements returned in the browse response.
$expandAll = true; // Boolean | Whether to return only basic properties or entire instance.
$highlightMatch = true; // Boolean | Whether to highlight matched resource by query input or not.
$precedingRecordsCount = 56; // Integer | Number of preceding records for browsing around and around-including options
$callNumberType = ; // CallNumberType | Type of call number

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BrowseApi->new();
my $query = query_example; # String | A CQL query string with search conditions.
my $xOkapiTenant = xOkapiTenant_example; # String | X-Okapi-Tenant header value
my $limit = 56; # Integer | Limit the number of elements returned in the browse response.
my $expandAll = true; # Boolean | Whether to return only basic properties or entire instance.
my $highlightMatch = true; # Boolean | Whether to highlight matched resource by query input or not.
my $precedingRecordsCount = 56; # Integer | Number of preceding records for browsing around and around-including options
my $callNumberType = ; # CallNumberType | Type of call number

eval {
    my $result = $api_instance->browseInstancesByCallNumber(query => $query, xOkapiTenant => $xOkapiTenant, limit => $limit, expandAll => $expandAll, highlightMatch => $highlightMatch, precedingRecordsCount => $precedingRecordsCount, callNumberType => $callNumberType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BrowseApi->browseInstancesByCallNumber: $@\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.BrowseApi()
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)
limit = 56 # Integer | Limit the number of elements returned in the browse response. (optional) (default to 100)
expandAll = true # Boolean | Whether to return only basic properties or entire instance. (optional) (default to false)
highlightMatch = true # Boolean | Whether to highlight matched resource by query input or not. (optional) (default to true)
precedingRecordsCount = 56 # Integer | Number of preceding records for browsing around and around-including options (optional) (default to null)
callNumberType =  # CallNumberType | Type of call number (optional) (default to null)

try:
    api_response = api_instance.browse_instances_by_call_number(query, xOkapiTenant, limit=limit, expandAll=expandAll, highlightMatch=highlightMatch, precedingRecordsCount=precedingRecordsCount, callNumberType=callNumberType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BrowseApi->browseInstancesByCallNumber: %s\n" % e)
extern crate BrowseApi;

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

    let mut context = BrowseApi::Context::default();
    let result = client.browseInstancesByCallNumber(query, xOkapiTenant, limit, expandAll, highlightMatch, precedingRecordsCount, callNumberType, &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 browse response.
expandAll
Boolean
Whether to return only basic properties or entire instance.
highlightMatch
Boolean
Whether to highlight matched resource by query input or not.
precedingRecordsCount
Integer
Number of preceding records for browsing around and around-including options
callNumberType
CallNumberType
Type of call number

Responses


browseInstancesByClassificationNumber

Provides list of instances for browsing by classification number


/browse/classification-numbers/{browseOptionId}/instances

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://folio-dev-spitfire-okapi.ci.folio.org/browse/classification-numbers/{browseOptionId}/instances?query=query_example&limit=56&expandAll=true&highlightMatch=true&precedingRecordsCount=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BrowseApi;

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

public class BrowseApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        BrowseApi apiInstance = new BrowseApi();
        BrowseOptionType browseOptionId = ; // BrowseOptionType | Browse option type
        String query = query_example; // String | A CQL query string with search conditions.
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
        Integer limit = 56; // Integer | Limit the number of elements returned in the browse response.
        Boolean expandAll = true; // Boolean | Whether to return only basic properties or entire instance.
        Boolean highlightMatch = true; // Boolean | Whether to highlight matched resource by query input or not.
        Integer precedingRecordsCount = 56; // Integer | Number of preceding records for browsing around and around-including options

        try {
            classificationNumberBrowseResult result = apiInstance.browseInstancesByClassificationNumber(browseOptionId, query, xOkapiTenant, limit, expandAll, highlightMatch, precedingRecordsCount);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BrowseApi#browseInstancesByClassificationNumber");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final BrowseOptionType browseOptionId = new BrowseOptionType(); // BrowseOptionType | Browse option type
final String query = new String(); // String | A CQL query string with search conditions.
final String xOkapiTenant = new String(); // String | X-Okapi-Tenant header value
final Integer limit = new Integer(); // Integer | Limit the number of elements returned in the browse response.
final Boolean expandAll = new Boolean(); // Boolean | Whether to return only basic properties or entire instance.
final Boolean highlightMatch = new Boolean(); // Boolean | Whether to highlight matched resource by query input or not.
final Integer precedingRecordsCount = new Integer(); // Integer | Number of preceding records for browsing around and around-including options

try {
    final result = await api_instance.browseInstancesByClassificationNumber(browseOptionId, query, xOkapiTenant, limit, expandAll, highlightMatch, precedingRecordsCount);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->browseInstancesByClassificationNumber: $e\n');
}

import org.openapitools.client.api.BrowseApi;

public class BrowseApiExample {
    public static void main(String[] args) {
        BrowseApi apiInstance = new BrowseApi();
        BrowseOptionType browseOptionId = ; // BrowseOptionType | Browse option type
        String query = query_example; // String | A CQL query string with search conditions.
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
        Integer limit = 56; // Integer | Limit the number of elements returned in the browse response.
        Boolean expandAll = true; // Boolean | Whether to return only basic properties or entire instance.
        Boolean highlightMatch = true; // Boolean | Whether to highlight matched resource by query input or not.
        Integer precedingRecordsCount = 56; // Integer | Number of preceding records for browsing around and around-including options

        try {
            classificationNumberBrowseResult result = apiInstance.browseInstancesByClassificationNumber(browseOptionId, query, xOkapiTenant, limit, expandAll, highlightMatch, precedingRecordsCount);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BrowseApi#browseInstancesByClassificationNumber");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
BrowseApi *apiInstance = [[BrowseApi alloc] init];
BrowseOptionType *browseOptionId = ; // Browse option type (default to null)
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)
Integer *limit = 56; // Limit the number of elements returned in the browse response. (optional) (default to 100)
Boolean *expandAll = true; // Whether to return only basic properties or entire instance. (optional) (default to false)
Boolean *highlightMatch = true; // Whether to highlight matched resource by query input or not. (optional) (default to true)
Integer *precedingRecordsCount = 56; // Number of preceding records for browsing around and around-including options (optional) (default to null)

[apiInstance browseInstancesByClassificationNumberWith:browseOptionId
    query:query
    xOkapiTenant:xOkapiTenant
    limit:limit
    expandAll:expandAll
    highlightMatch:highlightMatch
    precedingRecordsCount:precedingRecordsCount
              completionHandler: ^(classificationNumberBrowseResult 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.BrowseApi()
var browseOptionId = ; // {BrowseOptionType} Browse option type
var query = query_example; // {String} A CQL query string with search conditions.
var xOkapiTenant = xOkapiTenant_example; // {String} X-Okapi-Tenant header value
var opts = {
  'limit': 56, // {Integer} Limit the number of elements returned in the browse response.
  'expandAll': true, // {Boolean} Whether to return only basic properties or entire instance.
  'highlightMatch': true, // {Boolean} Whether to highlight matched resource by query input or not.
  'precedingRecordsCount': 56 // {Integer} Number of preceding records for browsing around and around-including options
};

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

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

            // Create an instance of the API class
            var apiInstance = new BrowseApi();
            var browseOptionId = new BrowseOptionType(); // BrowseOptionType | Browse option type (default to null)
            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 limit = 56;  // Integer | Limit the number of elements returned in the browse response. (optional)  (default to 100)
            var expandAll = true;  // Boolean | Whether to return only basic properties or entire instance. (optional)  (default to false)
            var highlightMatch = true;  // Boolean | Whether to highlight matched resource by query input or not. (optional)  (default to true)
            var precedingRecordsCount = 56;  // Integer | Number of preceding records for browsing around and around-including options (optional)  (default to null)

            try {
                classificationNumberBrowseResult result = apiInstance.browseInstancesByClassificationNumber(browseOptionId, query, xOkapiTenant, limit, expandAll, highlightMatch, precedingRecordsCount);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BrowseApi.browseInstancesByClassificationNumber: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BrowseApi();
$browseOptionId = ; // BrowseOptionType | Browse option type
$query = query_example; // String | A CQL query string with search conditions.
$xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
$limit = 56; // Integer | Limit the number of elements returned in the browse response.
$expandAll = true; // Boolean | Whether to return only basic properties or entire instance.
$highlightMatch = true; // Boolean | Whether to highlight matched resource by query input or not.
$precedingRecordsCount = 56; // Integer | Number of preceding records for browsing around and around-including options

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BrowseApi->new();
my $browseOptionId = ; # BrowseOptionType | Browse option type
my $query = query_example; # String | A CQL query string with search conditions.
my $xOkapiTenant = xOkapiTenant_example; # String | X-Okapi-Tenant header value
my $limit = 56; # Integer | Limit the number of elements returned in the browse response.
my $expandAll = true; # Boolean | Whether to return only basic properties or entire instance.
my $highlightMatch = true; # Boolean | Whether to highlight matched resource by query input or not.
my $precedingRecordsCount = 56; # Integer | Number of preceding records for browsing around and around-including options

eval {
    my $result = $api_instance->browseInstancesByClassificationNumber(browseOptionId => $browseOptionId, query => $query, xOkapiTenant => $xOkapiTenant, limit => $limit, expandAll => $expandAll, highlightMatch => $highlightMatch, precedingRecordsCount => $precedingRecordsCount);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BrowseApi->browseInstancesByClassificationNumber: $@\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.BrowseApi()
browseOptionId =  # BrowseOptionType | Browse option type (default to null)
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)
limit = 56 # Integer | Limit the number of elements returned in the browse response. (optional) (default to 100)
expandAll = true # Boolean | Whether to return only basic properties or entire instance. (optional) (default to false)
highlightMatch = true # Boolean | Whether to highlight matched resource by query input or not. (optional) (default to true)
precedingRecordsCount = 56 # Integer | Number of preceding records for browsing around and around-including options (optional) (default to null)

try:
    api_response = api_instance.browse_instances_by_classification_number(browseOptionId, query, xOkapiTenant, limit=limit, expandAll=expandAll, highlightMatch=highlightMatch, precedingRecordsCount=precedingRecordsCount)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BrowseApi->browseInstancesByClassificationNumber: %s\n" % e)
extern crate BrowseApi;

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

    let mut context = BrowseApi::Context::default();
    let result = client.browseInstancesByClassificationNumber(browseOptionId, query, xOkapiTenant, limit, expandAll, highlightMatch, precedingRecordsCount, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
browseOptionId*
BrowseOptionType
Browse option type
Required
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 browse response.
expandAll
Boolean
Whether to return only basic properties or entire instance.
highlightMatch
Boolean
Whether to highlight matched resource by query input or not.
precedingRecordsCount
Integer
Number of preceding records for browsing around and around-including options

Responses


browseInstancesByContributor

Provides list of instances for browsing by contributor


/browse/contributors/instances

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://folio-dev-spitfire-okapi.ci.folio.org/browse/contributors/instances?query=query_example&limit=56&highlightMatch=true&precedingRecordsCount=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BrowseApi;

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

public class BrowseApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        BrowseApi apiInstance = new BrowseApi();
        String query = query_example; // String | A CQL query string with search conditions.
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
        Integer limit = 56; // Integer | Limit the number of elements returned in the response.
        Boolean highlightMatch = true; // Boolean | Whether to highlight matched resource by query input or not.
        Integer precedingRecordsCount = 56; // Integer | Number of preceding records for browsing around and around-including options

        try {
            contributorBrowseResult result = apiInstance.browseInstancesByContributor(query, xOkapiTenant, limit, highlightMatch, precedingRecordsCount);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BrowseApi#browseInstancesByContributor");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String query = new String(); // String | A CQL query string with search conditions.
final String xOkapiTenant = new String(); // String | X-Okapi-Tenant header value
final Integer limit = new Integer(); // Integer | Limit the number of elements returned in the response.
final Boolean highlightMatch = new Boolean(); // Boolean | Whether to highlight matched resource by query input or not.
final Integer precedingRecordsCount = new Integer(); // Integer | Number of preceding records for browsing around and around-including options

try {
    final result = await api_instance.browseInstancesByContributor(query, xOkapiTenant, limit, highlightMatch, precedingRecordsCount);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->browseInstancesByContributor: $e\n');
}

import org.openapitools.client.api.BrowseApi;

public class BrowseApiExample {
    public static void main(String[] args) {
        BrowseApi apiInstance = new BrowseApi();
        String query = query_example; // String | A CQL query string with search conditions.
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
        Integer limit = 56; // Integer | Limit the number of elements returned in the response.
        Boolean highlightMatch = true; // Boolean | Whether to highlight matched resource by query input or not.
        Integer precedingRecordsCount = 56; // Integer | Number of preceding records for browsing around and around-including options

        try {
            contributorBrowseResult result = apiInstance.browseInstancesByContributor(query, xOkapiTenant, limit, highlightMatch, precedingRecordsCount);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BrowseApi#browseInstancesByContributor");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
BrowseApi *apiInstance = [[BrowseApi 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)
Integer *limit = 56; // Limit the number of elements returned in the response. (optional) (default to 100)
Boolean *highlightMatch = true; // Whether to highlight matched resource by query input or not. (optional) (default to true)
Integer *precedingRecordsCount = 56; // Number of preceding records for browsing around and around-including options (optional) (default to null)

[apiInstance browseInstancesByContributorWith:query
    xOkapiTenant:xOkapiTenant
    limit:limit
    highlightMatch:highlightMatch
    precedingRecordsCount:precedingRecordsCount
              completionHandler: ^(contributorBrowseResult 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.BrowseApi()
var query = query_example; // {String} A CQL query string with search conditions.
var xOkapiTenant = xOkapiTenant_example; // {String} X-Okapi-Tenant header value
var opts = {
  'limit': 56, // {Integer} Limit the number of elements returned in the response.
  'highlightMatch': true, // {Boolean} Whether to highlight matched resource by query input or not.
  'precedingRecordsCount': 56 // {Integer} Number of preceding records for browsing around and around-including options
};

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

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

            // Create an instance of the API class
            var apiInstance = new BrowseApi();
            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 limit = 56;  // Integer | Limit the number of elements returned in the response. (optional)  (default to 100)
            var highlightMatch = true;  // Boolean | Whether to highlight matched resource by query input or not. (optional)  (default to true)
            var precedingRecordsCount = 56;  // Integer | Number of preceding records for browsing around and around-including options (optional)  (default to null)

            try {
                contributorBrowseResult result = apiInstance.browseInstancesByContributor(query, xOkapiTenant, limit, highlightMatch, precedingRecordsCount);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BrowseApi.browseInstancesByContributor: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BrowseApi();
$query = query_example; // String | A CQL query string with search conditions.
$xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
$limit = 56; // Integer | Limit the number of elements returned in the response.
$highlightMatch = true; // Boolean | Whether to highlight matched resource by query input or not.
$precedingRecordsCount = 56; // Integer | Number of preceding records for browsing around and around-including options

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BrowseApi->new();
my $query = query_example; # String | A CQL query string with search conditions.
my $xOkapiTenant = xOkapiTenant_example; # String | X-Okapi-Tenant header value
my $limit = 56; # Integer | Limit the number of elements returned in the response.
my $highlightMatch = true; # Boolean | Whether to highlight matched resource by query input or not.
my $precedingRecordsCount = 56; # Integer | Number of preceding records for browsing around and around-including options

eval {
    my $result = $api_instance->browseInstancesByContributor(query => $query, xOkapiTenant => $xOkapiTenant, limit => $limit, highlightMatch => $highlightMatch, precedingRecordsCount => $precedingRecordsCount);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BrowseApi->browseInstancesByContributor: $@\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.BrowseApi()
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)
limit = 56 # Integer | Limit the number of elements returned in the response. (optional) (default to 100)
highlightMatch = true # Boolean | Whether to highlight matched resource by query input or not. (optional) (default to true)
precedingRecordsCount = 56 # Integer | Number of preceding records for browsing around and around-including options (optional) (default to null)

try:
    api_response = api_instance.browse_instances_by_contributor(query, xOkapiTenant, limit=limit, highlightMatch=highlightMatch, precedingRecordsCount=precedingRecordsCount)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BrowseApi->browseInstancesByContributor: %s\n" % e)
extern crate BrowseApi;

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

    let mut context = BrowseApi::Context::default();
    let result = client.browseInstancesByContributor(query, xOkapiTenant, limit, highlightMatch, precedingRecordsCount, &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.
highlightMatch
Boolean
Whether to highlight matched resource by query input or not.
precedingRecordsCount
Integer
Number of preceding records for browsing around and around-including options

Responses


browseInstancesBySubject

Provides list of instances for browsing by subject


/browse/subjects/instances

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://folio-dev-spitfire-okapi.ci.folio.org/browse/subjects/instances?query=query_example&limit=56&highlightMatch=true&precedingRecordsCount=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BrowseApi;

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

public class BrowseApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        BrowseApi apiInstance = new BrowseApi();
        String query = query_example; // String | A CQL query string with search conditions.
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
        Integer limit = 56; // Integer | Limit the number of elements returned in the response.
        Boolean highlightMatch = true; // Boolean | Whether to highlight matched resource by query input or not.
        Integer precedingRecordsCount = 56; // Integer | Number of preceding records for browsing around and around-including options

        try {
            subjectBrowseResult result = apiInstance.browseInstancesBySubject(query, xOkapiTenant, limit, highlightMatch, precedingRecordsCount);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BrowseApi#browseInstancesBySubject");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String query = new String(); // String | A CQL query string with search conditions.
final String xOkapiTenant = new String(); // String | X-Okapi-Tenant header value
final Integer limit = new Integer(); // Integer | Limit the number of elements returned in the response.
final Boolean highlightMatch = new Boolean(); // Boolean | Whether to highlight matched resource by query input or not.
final Integer precedingRecordsCount = new Integer(); // Integer | Number of preceding records for browsing around and around-including options

try {
    final result = await api_instance.browseInstancesBySubject(query, xOkapiTenant, limit, highlightMatch, precedingRecordsCount);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->browseInstancesBySubject: $e\n');
}

import org.openapitools.client.api.BrowseApi;

public class BrowseApiExample {
    public static void main(String[] args) {
        BrowseApi apiInstance = new BrowseApi();
        String query = query_example; // String | A CQL query string with search conditions.
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
        Integer limit = 56; // Integer | Limit the number of elements returned in the response.
        Boolean highlightMatch = true; // Boolean | Whether to highlight matched resource by query input or not.
        Integer precedingRecordsCount = 56; // Integer | Number of preceding records for browsing around and around-including options

        try {
            subjectBrowseResult result = apiInstance.browseInstancesBySubject(query, xOkapiTenant, limit, highlightMatch, precedingRecordsCount);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BrowseApi#browseInstancesBySubject");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
BrowseApi *apiInstance = [[BrowseApi 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)
Integer *limit = 56; // Limit the number of elements returned in the response. (optional) (default to 100)
Boolean *highlightMatch = true; // Whether to highlight matched resource by query input or not. (optional) (default to true)
Integer *precedingRecordsCount = 56; // Number of preceding records for browsing around and around-including options (optional) (default to null)

[apiInstance browseInstancesBySubjectWith:query
    xOkapiTenant:xOkapiTenant
    limit:limit
    highlightMatch:highlightMatch
    precedingRecordsCount:precedingRecordsCount
              completionHandler: ^(subjectBrowseResult 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.BrowseApi()
var query = query_example; // {String} A CQL query string with search conditions.
var xOkapiTenant = xOkapiTenant_example; // {String} X-Okapi-Tenant header value
var opts = {
  'limit': 56, // {Integer} Limit the number of elements returned in the response.
  'highlightMatch': true, // {Boolean} Whether to highlight matched resource by query input or not.
  'precedingRecordsCount': 56 // {Integer} Number of preceding records for browsing around and around-including options
};

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

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

            // Create an instance of the API class
            var apiInstance = new BrowseApi();
            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 limit = 56;  // Integer | Limit the number of elements returned in the response. (optional)  (default to 100)
            var highlightMatch = true;  // Boolean | Whether to highlight matched resource by query input or not. (optional)  (default to true)
            var precedingRecordsCount = 56;  // Integer | Number of preceding records for browsing around and around-including options (optional)  (default to null)

            try {
                subjectBrowseResult result = apiInstance.browseInstancesBySubject(query, xOkapiTenant, limit, highlightMatch, precedingRecordsCount);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BrowseApi.browseInstancesBySubject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BrowseApi();
$query = query_example; // String | A CQL query string with search conditions.
$xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
$limit = 56; // Integer | Limit the number of elements returned in the response.
$highlightMatch = true; // Boolean | Whether to highlight matched resource by query input or not.
$precedingRecordsCount = 56; // Integer | Number of preceding records for browsing around and around-including options

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BrowseApi->new();
my $query = query_example; # String | A CQL query string with search conditions.
my $xOkapiTenant = xOkapiTenant_example; # String | X-Okapi-Tenant header value
my $limit = 56; # Integer | Limit the number of elements returned in the response.
my $highlightMatch = true; # Boolean | Whether to highlight matched resource by query input or not.
my $precedingRecordsCount = 56; # Integer | Number of preceding records for browsing around and around-including options

eval {
    my $result = $api_instance->browseInstancesBySubject(query => $query, xOkapiTenant => $xOkapiTenant, limit => $limit, highlightMatch => $highlightMatch, precedingRecordsCount => $precedingRecordsCount);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BrowseApi->browseInstancesBySubject: $@\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.BrowseApi()
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)
limit = 56 # Integer | Limit the number of elements returned in the response. (optional) (default to 100)
highlightMatch = true # Boolean | Whether to highlight matched resource by query input or not. (optional) (default to true)
precedingRecordsCount = 56 # Integer | Number of preceding records for browsing around and around-including options (optional) (default to null)

try:
    api_response = api_instance.browse_instances_by_subject(query, xOkapiTenant, limit=limit, highlightMatch=highlightMatch, precedingRecordsCount=precedingRecordsCount)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BrowseApi->browseInstancesBySubject: %s\n" % e)
extern crate BrowseApi;

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

    let mut context = BrowseApi::Context::default();
    let result = client.browseInstancesBySubject(query, xOkapiTenant, limit, highlightMatch, precedingRecordsCount, &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.
highlightMatch
Boolean
Whether to highlight matched resource by query input or not.
precedingRecordsCount
Integer
Number of preceding records for browsing around and around-including options

Responses


Config

createLanguageConfig

Save languages that will be used for analyzers


/search/config/languages

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://folio-dev-spitfire-okapi.ci.folio.org/search/config/languages" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConfigApi;

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

public class ConfigApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ConfigApi apiInstance = new ConfigApi();
        LanguageConfig languageConfig = ; // LanguageConfig | 

        try {
            languageConfig result = apiInstance.createLanguageConfig(languageConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigApi#createLanguageConfig");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final LanguageConfig languageConfig = new LanguageConfig(); // LanguageConfig | 

try {
    final result = await api_instance.createLanguageConfig(languageConfig);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createLanguageConfig: $e\n');
}

import org.openapitools.client.api.ConfigApi;

public class ConfigApiExample {
    public static void main(String[] args) {
        ConfigApi apiInstance = new ConfigApi();
        LanguageConfig languageConfig = ; // LanguageConfig | 

        try {
            languageConfig result = apiInstance.createLanguageConfig(languageConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigApi#createLanguageConfig");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ConfigApi *apiInstance = [[ConfigApi 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.ConfigApi()
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 ConfigApi();
            var languageConfig = new LanguageConfig(); // LanguageConfig |  (optional) 

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConfigApi();
$languageConfig = ; // LanguageConfig | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConfigApi->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 ConfigApi->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.ConfigApi()
languageConfig =  # LanguageConfig |  (optional)

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

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

    let mut context = ConfigApi::Context::default();
    let result = client.createLanguageConfig(languageConfig, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
languageConfig

Responses


deleteFeatureConfigurationById

Delete feature configuration by id


/search/config/features/{featureId}

Usage and SDK Samples

curl -X DELETE \
 "https://folio-dev-spitfire-okapi.ci.folio.org/search/config/features/{featureId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConfigApi;

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

public class ConfigApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ConfigApi apiInstance = new ConfigApi();
        String featureId = featureId_example; // String | Feature id (name)

        try {
            apiInstance.deleteFeatureConfigurationById(featureId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigApi#deleteFeatureConfigurationById");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String featureId = new String(); // String | Feature id (name)

try {
    final result = await api_instance.deleteFeatureConfigurationById(featureId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteFeatureConfigurationById: $e\n');
}

import org.openapitools.client.api.ConfigApi;

public class ConfigApiExample {
    public static void main(String[] args) {
        ConfigApi apiInstance = new ConfigApi();
        String featureId = featureId_example; // String | Feature id (name)

        try {
            apiInstance.deleteFeatureConfigurationById(featureId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigApi#deleteFeatureConfigurationById");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ConfigApi *apiInstance = [[ConfigApi alloc] init];
String *featureId = featureId_example; // Feature id (name) (default to null)

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

// Create an instance of the API class
var api = new SearchApi.ConfigApi()
var featureId = featureId_example; // {String} Feature id (name)

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

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

            // Create an instance of the API class
            var apiInstance = new ConfigApi();
            var featureId = featureId_example;  // String | Feature id (name) (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConfigApi();
$featureId = featureId_example; // String | Feature id (name)

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConfigApi->new();
my $featureId = featureId_example; # String | Feature id (name)

eval {
    $api_instance->deleteFeatureConfigurationById(featureId => $featureId);
};
if ($@) {
    warn "Exception when calling ConfigApi->deleteFeatureConfigurationById: $@\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.ConfigApi()
featureId = featureId_example # String | Feature id (name) (default to null)

try:
    api_instance.delete_feature_configuration_by_id(featureId)
except ApiException as e:
    print("Exception when calling ConfigApi->deleteFeatureConfigurationById: %s\n" % e)
extern crate ConfigApi;

pub fn main() {
    let featureId = featureId_example; // String

    let mut context = ConfigApi::Context::default();
    let result = client.deleteFeatureConfigurationById(featureId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
featureId*
String
Feature id (name)
Required

Responses


deleteLanguageConfig

Delete all supported languages


/search/config/languages/{code}

Usage and SDK Samples

curl -X DELETE \
 "https://folio-dev-spitfire-okapi.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.ConfigApi;

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

public class ConfigApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ConfigApi apiInstance = new ConfigApi();
        String code = code_example; // String | Language code

        try {
            apiInstance.deleteLanguageConfig(code);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigApi#deleteLanguageConfig");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String code = new String(); // String | Language code

try {
    final result = await api_instance.deleteLanguageConfig(code);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteLanguageConfig: $e\n');
}

import org.openapitools.client.api.ConfigApi;

public class ConfigApiExample {
    public static void main(String[] args) {
        ConfigApi apiInstance = new ConfigApi();
        String code = code_example; // String | Language code

        try {
            apiInstance.deleteLanguageConfig(code);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigApi#deleteLanguageConfig");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ConfigApi *apiInstance = [[ConfigApi 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.ConfigApi()
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 ConfigApi();
            var code = code_example;  // String | Language code (default to null)

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

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

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

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

eval {
    $api_instance->deleteLanguageConfig(code => $code);
};
if ($@) {
    warn "Exception when calling ConfigApi->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.ConfigApi()
code = code_example # String | Language code (default to null)

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

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

    let mut context = ConfigApi::Context::default();
    let result = client.deleteLanguageConfig(code, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
code*
String
Language code
Required

Responses


getAllFeatures

Get all feature configurations per tenant


/search/config/features

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://folio-dev-spitfire-okapi.ci.folio.org/search/config/features"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConfigApi;

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

public class ConfigApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ConfigApi apiInstance = new ConfigApi();

        try {
            featureConfigs result = apiInstance.getAllFeatures();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigApi#getAllFeatures");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getAllFeatures();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getAllFeatures: $e\n');
}

import org.openapitools.client.api.ConfigApi;

public class ConfigApiExample {
    public static void main(String[] args) {
        ConfigApi apiInstance = new ConfigApi();

        try {
            featureConfigs result = apiInstance.getAllFeatures();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigApi#getAllFeatures");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ConfigApi *apiInstance = [[ConfigApi alloc] init];

[apiInstance getAllFeaturesWithCompletionHandler: 
              ^(featureConfigs 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.ConfigApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllFeatures(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ConfigApi();

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConfigApi();

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConfigApi->new();

eval {
    my $result = $api_instance->getAllFeatures();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigApi->getAllFeatures: $@\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.ConfigApi()

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

pub fn main() {

    let mut context = ConfigApi::Context::default();
    let result = client.getAllFeatures(&context).wait();

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

Scopes

Parameters

Responses


getAllLanguageConfigs

Get all supported languages


/search/config/languages

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://folio-dev-spitfire-okapi.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.ConfigApi;

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

public class ConfigApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ConfigApi apiInstance = new ConfigApi();

        try {
            languageConfigs result = apiInstance.getAllLanguageConfigs();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigApi#getAllLanguageConfigs");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getAllLanguageConfigs();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getAllLanguageConfigs: $e\n');
}

import org.openapitools.client.api.ConfigApi;

public class ConfigApiExample {
    public static void main(String[] args) {
        ConfigApi apiInstance = new ConfigApi();

        try {
            languageConfigs result = apiInstance.getAllLanguageConfigs();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigApi#getAllLanguageConfigs");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ConfigApi *apiInstance = [[ConfigApi 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.ConfigApi()
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 ConfigApi();

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConfigApi();

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConfigApi->new();

eval {
    my $result = $api_instance->getAllLanguageConfigs();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigApi->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.ConfigApi()

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

pub fn main() {

    let mut context = ConfigApi::Context::default();
    let result = client.getAllLanguageConfigs(&context).wait();

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

Scopes

Parameters

Responses


getBrowseConfigs

Get all configurations for browse type


/browse/config/{browseType}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://folio-dev-spitfire-okapi.ci.folio.org/browse/config/{browseType}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConfigApi;

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

public class ConfigApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ConfigApi apiInstance = new ConfigApi();
        BrowseType browseType = ; // BrowseType | Browse feature type

        try {
            browseConfigCollection result = apiInstance.getBrowseConfigs(browseType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigApi#getBrowseConfigs");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final BrowseType browseType = new BrowseType(); // BrowseType | Browse feature type

try {
    final result = await api_instance.getBrowseConfigs(browseType);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getBrowseConfigs: $e\n');
}

import org.openapitools.client.api.ConfigApi;

public class ConfigApiExample {
    public static void main(String[] args) {
        ConfigApi apiInstance = new ConfigApi();
        BrowseType browseType = ; // BrowseType | Browse feature type

        try {
            browseConfigCollection result = apiInstance.getBrowseConfigs(browseType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigApi#getBrowseConfigs");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ConfigApi *apiInstance = [[ConfigApi alloc] init];
BrowseType *browseType = ; // Browse feature type (default to null)

[apiInstance getBrowseConfigsWith:browseType
              completionHandler: ^(browseConfigCollection 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.ConfigApi()
var browseType = ; // {BrowseType} Browse feature type

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

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

            // Create an instance of the API class
            var apiInstance = new ConfigApi();
            var browseType = new BrowseType(); // BrowseType | Browse feature type (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConfigApi();
$browseType = ; // BrowseType | Browse feature type

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConfigApi->new();
my $browseType = ; # BrowseType | Browse feature type

eval {
    my $result = $api_instance->getBrowseConfigs(browseType => $browseType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigApi->getBrowseConfigs: $@\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.ConfigApi()
browseType =  # BrowseType | Browse feature type (default to null)

try:
    api_response = api_instance.get_browse_configs(browseType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigApi->getBrowseConfigs: %s\n" % e)
extern crate ConfigApi;

pub fn main() {
    let browseType = ; // BrowseType

    let mut context = ConfigApi::Context::default();
    let result = client.getBrowseConfigs(browseType, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
browseType*
BrowseType
Browse feature type
Required

Responses


putBrowseConfig

Update configuration for browse type


/browse/config/{browseType}/{browseOptionId}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://folio-dev-spitfire-okapi.ci.folio.org/browse/config/{browseType}/{browseOptionId}" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConfigApi;

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

public class ConfigApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ConfigApi apiInstance = new ConfigApi();
        BrowseType browseType = ; // BrowseType | Browse feature type
        BrowseOptionType browseOptionId = ; // BrowseOptionType | Browse option type
        BrowseConfig browseConfig = ; // BrowseConfig | 

        try {
            apiInstance.putBrowseConfig(browseType, browseOptionId, browseConfig);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigApi#putBrowseConfig");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final BrowseType browseType = new BrowseType(); // BrowseType | Browse feature type
final BrowseOptionType browseOptionId = new BrowseOptionType(); // BrowseOptionType | Browse option type
final BrowseConfig browseConfig = new BrowseConfig(); // BrowseConfig | 

try {
    final result = await api_instance.putBrowseConfig(browseType, browseOptionId, browseConfig);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->putBrowseConfig: $e\n');
}

import org.openapitools.client.api.ConfigApi;

public class ConfigApiExample {
    public static void main(String[] args) {
        ConfigApi apiInstance = new ConfigApi();
        BrowseType browseType = ; // BrowseType | Browse feature type
        BrowseOptionType browseOptionId = ; // BrowseOptionType | Browse option type
        BrowseConfig browseConfig = ; // BrowseConfig | 

        try {
            apiInstance.putBrowseConfig(browseType, browseOptionId, browseConfig);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigApi#putBrowseConfig");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ConfigApi *apiInstance = [[ConfigApi alloc] init];
BrowseType *browseType = ; // Browse feature type (default to null)
BrowseOptionType *browseOptionId = ; // Browse option type (default to null)
BrowseConfig *browseConfig = ; // 

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

// Create an instance of the API class
var api = new SearchApi.ConfigApi()
var browseType = ; // {BrowseType} Browse feature type
var browseOptionId = ; // {BrowseOptionType} Browse option type
var browseConfig = ; // {BrowseConfig} 

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

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

            // Create an instance of the API class
            var apiInstance = new ConfigApi();
            var browseType = new BrowseType(); // BrowseType | Browse feature type (default to null)
            var browseOptionId = new BrowseOptionType(); // BrowseOptionType | Browse option type (default to null)
            var browseConfig = new BrowseConfig(); // BrowseConfig | 

            try {
                apiInstance.putBrowseConfig(browseType, browseOptionId, browseConfig);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConfigApi.putBrowseConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConfigApi();
$browseType = ; // BrowseType | Browse feature type
$browseOptionId = ; // BrowseOptionType | Browse option type
$browseConfig = ; // BrowseConfig | 

try {
    $api_instance->putBrowseConfig($browseType, $browseOptionId, $browseConfig);
} catch (Exception $e) {
    echo 'Exception when calling ConfigApi->putBrowseConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ConfigApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConfigApi->new();
my $browseType = ; # BrowseType | Browse feature type
my $browseOptionId = ; # BrowseOptionType | Browse option type
my $browseConfig = WWW::OPenAPIClient::Object::BrowseConfig->new(); # BrowseConfig | 

eval {
    $api_instance->putBrowseConfig(browseType => $browseType, browseOptionId => $browseOptionId, browseConfig => $browseConfig);
};
if ($@) {
    warn "Exception when calling ConfigApi->putBrowseConfig: $@\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.ConfigApi()
browseType =  # BrowseType | Browse feature type (default to null)
browseOptionId =  # BrowseOptionType | Browse option type (default to null)
browseConfig =  # BrowseConfig | 

try:
    api_instance.put_browse_config(browseType, browseOptionId, browseConfig)
except ApiException as e:
    print("Exception when calling ConfigApi->putBrowseConfig: %s\n" % e)
extern crate ConfigApi;

pub fn main() {
    let browseType = ; // BrowseType
    let browseOptionId = ; // BrowseOptionType
    let browseConfig = ; // BrowseConfig

    let mut context = ConfigApi::Context::default();
    let result = client.putBrowseConfig(browseType, browseOptionId, browseConfig, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
browseType*
BrowseType
Browse feature type
Required
browseOptionId*
BrowseOptionType
Browse option type
Required
Body parameters
Name Description
browseConfig *

Responses


saveFeatureConfiguration

Save feature configuration (enables or disables pre-defined optional search options)


/search/config/features

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://folio-dev-spitfire-okapi.ci.folio.org/search/config/features" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConfigApi;

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

public class ConfigApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ConfigApi apiInstance = new ConfigApi();
        FeatureConfig featureConfig = ; // FeatureConfig | 

        try {
            featureConfig result = apiInstance.saveFeatureConfiguration(featureConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigApi#saveFeatureConfiguration");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final FeatureConfig featureConfig = new FeatureConfig(); // FeatureConfig | 

try {
    final result = await api_instance.saveFeatureConfiguration(featureConfig);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->saveFeatureConfiguration: $e\n');
}

import org.openapitools.client.api.ConfigApi;

public class ConfigApiExample {
    public static void main(String[] args) {
        ConfigApi apiInstance = new ConfigApi();
        FeatureConfig featureConfig = ; // FeatureConfig | 

        try {
            featureConfig result = apiInstance.saveFeatureConfiguration(featureConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigApi#saveFeatureConfiguration");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ConfigApi *apiInstance = [[ConfigApi alloc] init];
FeatureConfig *featureConfig = ; //  (optional)

[apiInstance saveFeatureConfigurationWith:featureConfig
              completionHandler: ^(featureConfig 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.ConfigApi()
var opts = {
  'featureConfig':  // {FeatureConfig} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new ConfigApi();
            var featureConfig = new FeatureConfig(); // FeatureConfig |  (optional) 

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConfigApi();
$featureConfig = ; // FeatureConfig | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConfigApi->new();
my $featureConfig = WWW::OPenAPIClient::Object::FeatureConfig->new(); # FeatureConfig | 

eval {
    my $result = $api_instance->saveFeatureConfiguration(featureConfig => $featureConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigApi->saveFeatureConfiguration: $@\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.ConfigApi()
featureConfig =  # FeatureConfig |  (optional)

try:
    api_response = api_instance.save_feature_configuration(featureConfig=featureConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigApi->saveFeatureConfiguration: %s\n" % e)
extern crate ConfigApi;

pub fn main() {
    let featureConfig = ; // FeatureConfig

    let mut context = ConfigApi::Context::default();
    let result = client.saveFeatureConfiguration(featureConfig, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
featureConfig

Responses


updateFeatureConfiguration

Update feature configuration settings


/search/config/features/{featureId}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://folio-dev-spitfire-okapi.ci.folio.org/search/config/features/{featureId}" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConfigApi;

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

public class ConfigApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ConfigApi apiInstance = new ConfigApi();
        String featureId = featureId_example; // String | Feature id (name)
        FeatureConfig featureConfig = ; // FeatureConfig | 

        try {
            featureConfig result = apiInstance.updateFeatureConfiguration(featureId, featureConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigApi#updateFeatureConfiguration");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String featureId = new String(); // String | Feature id (name)
final FeatureConfig featureConfig = new FeatureConfig(); // FeatureConfig | 

try {
    final result = await api_instance.updateFeatureConfiguration(featureId, featureConfig);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateFeatureConfiguration: $e\n');
}

import org.openapitools.client.api.ConfigApi;

public class ConfigApiExample {
    public static void main(String[] args) {
        ConfigApi apiInstance = new ConfigApi();
        String featureId = featureId_example; // String | Feature id (name)
        FeatureConfig featureConfig = ; // FeatureConfig | 

        try {
            featureConfig result = apiInstance.updateFeatureConfiguration(featureId, featureConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigApi#updateFeatureConfiguration");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ConfigApi *apiInstance = [[ConfigApi alloc] init];
String *featureId = featureId_example; // Feature id (name) (default to null)
FeatureConfig *featureConfig = ; //  (optional)

[apiInstance updateFeatureConfigurationWith:featureId
    featureConfig:featureConfig
              completionHandler: ^(featureConfig 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.ConfigApi()
var featureId = featureId_example; // {String} Feature id (name)
var opts = {
  'featureConfig':  // {FeatureConfig} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new ConfigApi();
            var featureId = featureId_example;  // String | Feature id (name) (default to null)
            var featureConfig = new FeatureConfig(); // FeatureConfig |  (optional) 

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConfigApi();
$featureId = featureId_example; // String | Feature id (name)
$featureConfig = ; // FeatureConfig | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConfigApi->new();
my $featureId = featureId_example; # String | Feature id (name)
my $featureConfig = WWW::OPenAPIClient::Object::FeatureConfig->new(); # FeatureConfig | 

eval {
    my $result = $api_instance->updateFeatureConfiguration(featureId => $featureId, featureConfig => $featureConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigApi->updateFeatureConfiguration: $@\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.ConfigApi()
featureId = featureId_example # String | Feature id (name) (default to null)
featureConfig =  # FeatureConfig |  (optional)

try:
    api_response = api_instance.update_feature_configuration(featureId, featureConfig=featureConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigApi->updateFeatureConfiguration: %s\n" % e)
extern crate ConfigApi;

pub fn main() {
    let featureId = featureId_example; // String
    let featureConfig = ; // FeatureConfig

    let mut context = ConfigApi::Context::default();
    let result = client.updateFeatureConfiguration(featureId, featureConfig, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
featureId*
String
Feature id (name)
Required
Body parameters
Name Description
featureConfig

Responses


updateLanguageConfig

Update language config settings


/search/config/languages/{code}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://folio-dev-spitfire-okapi.ci.folio.org/search/config/languages/{code}" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConfigApi;

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

public class ConfigApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ConfigApi apiInstance = new ConfigApi();
        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 ConfigApi#updateLanguageConfig");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String code = new String(); // String | Language code
final LanguageConfig languageConfig = new LanguageConfig(); // LanguageConfig | 

try {
    final result = await api_instance.updateLanguageConfig(code, languageConfig);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateLanguageConfig: $e\n');
}

import org.openapitools.client.api.ConfigApi;

public class ConfigApiExample {
    public static void main(String[] args) {
        ConfigApi apiInstance = new ConfigApi();
        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 ConfigApi#updateLanguageConfig");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ConfigApi *apiInstance = [[ConfigApi 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.ConfigApi()
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 ConfigApi();
            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 ConfigApi.updateLanguageConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConfigApi();
$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 ConfigApi->updateLanguageConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ConfigApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConfigApi->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 ConfigApi->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.ConfigApi()
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 ConfigApi->updateLanguageConfig: %s\n" % e)
extern crate ConfigApi;

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

    let mut context = ConfigApi::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


Facets

getFacets

Provides list of facets for the record type


/search/{recordType}/facets

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://folio-dev-spitfire-okapi.ci.folio.org/search/{recordType}/facets?query=query_example&facet="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FacetsApi;

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

public class FacetsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        FacetsApi apiInstance = new FacetsApi();
        RecordType recordType = ; // RecordType | 
        String query = query_example; // String | A CQL query string with search conditions.
        array[String] facet = ; // array[String] | List of facet names.
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value

        try {
            facetResult result = apiInstance.getFacets(recordType, query, facet, xOkapiTenant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FacetsApi#getFacets");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final RecordType recordType = new RecordType(); // RecordType | 
final String query = new String(); // String | A CQL query string with search conditions.
final array[String] facet = new array[String](); // array[String] | List of facet names.
final String xOkapiTenant = new String(); // String | X-Okapi-Tenant header value

try {
    final result = await api_instance.getFacets(recordType, query, facet, xOkapiTenant);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getFacets: $e\n');
}

import org.openapitools.client.api.FacetsApi;

public class FacetsApiExample {
    public static void main(String[] args) {
        FacetsApi apiInstance = new FacetsApi();
        RecordType recordType = ; // RecordType | 
        String query = query_example; // String | A CQL query string with search conditions.
        array[String] facet = ; // array[String] | List of facet names.
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value

        try {
            facetResult result = apiInstance.getFacets(recordType, query, facet, xOkapiTenant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FacetsApi#getFacets");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FacetsApi *apiInstance = [[FacetsApi alloc] init];
RecordType *recordType = ; //  (default to null)
String *query = query_example; // A CQL query string with search conditions. (default to null)
array[String] *facet = ; // List of facet names. (default to null)
String *xOkapiTenant = xOkapiTenant_example; // X-Okapi-Tenant header value (default to null)

[apiInstance getFacetsWith:recordType
    query:query
    facet:facet
    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.FacetsApi()
var recordType = ; // {RecordType} 
var query = query_example; // {String} A CQL query string with search conditions.
var facet = ; // {array[String]} List of facet names.
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(recordType, query, facet, 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 FacetsApi();
            var recordType = new RecordType(); // RecordType |  (default to null)
            var query = query_example;  // String | A CQL query string with search conditions. (default to null)
            var facet = new array[String](); // array[String] | List of facet names. (default to null)
            var xOkapiTenant = xOkapiTenant_example;  // String | X-Okapi-Tenant header value (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FacetsApi();
$recordType = ; // RecordType | 
$query = query_example; // String | A CQL query string with search conditions.
$facet = ; // array[String] | List of facet names.
$xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FacetsApi->new();
my $recordType = ; # RecordType | 
my $query = query_example; # String | A CQL query string with search conditions.
my $facet = []; # array[String] | List of facet names.
my $xOkapiTenant = xOkapiTenant_example; # String | X-Okapi-Tenant header value

eval {
    my $result = $api_instance->getFacets(recordType => $recordType, query => $query, facet => $facet, xOkapiTenant => $xOkapiTenant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FacetsApi->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.FacetsApi()
recordType =  # RecordType |  (default to null)
query = query_example # String | A CQL query string with search conditions. (default to null)
facet =  # array[String] | List of facet names. (default to null)
xOkapiTenant = xOkapiTenant_example # String | X-Okapi-Tenant header value (default to null)

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

pub fn main() {
    let recordType = ; // RecordType
    let query = query_example; // String
    let facet = ; // array[String]
    let xOkapiTenant = xOkapiTenant_example; // String

    let mut context = FacetsApi::Context::default();
    let result = client.getFacets(recordType, query, facet, xOkapiTenant, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
recordType*
RecordType
Required
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
facet*
array[String]
List of facet names.
Required

Responses


IndexManagement

createIndices

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


/search/index/indices

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://folio-dev-spitfire-okapi.ci.folio.org/search/index/indices" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.IndexManagementApi;

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

public class IndexManagementApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        IndexManagementApi apiInstance = new IndexManagementApi();
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
        CreateIndexRequest createIndexRequest = examples/indexRequestBody.sample; // CreateIndexRequest | 

        try {
            folioCreateIndexResponse result = apiInstance.createIndices(xOkapiTenant, createIndexRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IndexManagementApi#createIndices");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String xOkapiTenant = new String(); // String | X-Okapi-Tenant header value
final CreateIndexRequest createIndexRequest = new CreateIndexRequest(); // CreateIndexRequest | 

try {
    final result = await api_instance.createIndices(xOkapiTenant, createIndexRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createIndices: $e\n');
}

import org.openapitools.client.api.IndexManagementApi;

public class IndexManagementApiExample {
    public static void main(String[] args) {
        IndexManagementApi apiInstance = new IndexManagementApi();
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
        CreateIndexRequest createIndexRequest = examples/indexRequestBody.sample; // CreateIndexRequest | 

        try {
            folioCreateIndexResponse result = apiInstance.createIndices(xOkapiTenant, createIndexRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IndexManagementApi#createIndices");
            e.printStackTrace();
        }
    }
}


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

[apiInstance createIndicesWith:xOkapiTenant
    createIndexRequest:createIndexRequest
              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.IndexManagementApi()
var xOkapiTenant = xOkapiTenant_example; // {String} X-Okapi-Tenant header value
var opts = {
  'createIndexRequest': examples/indexRequestBody.sample // {CreateIndexRequest} 
};

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 IndexManagementApi();
            var xOkapiTenant = xOkapiTenant_example;  // String | X-Okapi-Tenant header value (default to null)
            var createIndexRequest = new CreateIndexRequest(); // CreateIndexRequest |  (optional) 

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

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

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

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

eval {
    my $result = $api_instance->createIndices(xOkapiTenant => $xOkapiTenant, createIndexRequest => $createIndexRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling IndexManagementApi->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.IndexManagementApi()
xOkapiTenant = xOkapiTenant_example # String | X-Okapi-Tenant header value (default to null)
createIndexRequest = examples/indexRequestBody.sample # CreateIndexRequest |  (optional)

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

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

    let mut context = IndexManagementApi::Context::default();
    let result = client.createIndices(xOkapiTenant, createIndexRequest, &context).wait();

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

Scopes

Parameters

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

Responses


indexRecords

Indexes the records into elasticsearch.


/search/index/records

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://folio-dev-spitfire-okapi.ci.folio.org/search/index/records" \
 -d '{
  "new" : "{}",
  "old" : "{}",
  "resourceName" : "resourceName",
  "id" : "id",
  "tenant" : "tenant"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.IndexManagementApi;

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

public class IndexManagementApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        IndexManagementApi apiInstance = new IndexManagementApi();
        array[resourceEvent] resourceEvent = examples/indexRecordRequestBody.sample; // array[resourceEvent] | 

        try {
            folioIndexOperationResponse result = apiInstance.indexRecords(resourceEvent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IndexManagementApi#indexRecords");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final array[resourceEvent] resourceEvent = new array[resourceEvent](); // array[resourceEvent] | 

try {
    final result = await api_instance.indexRecords(resourceEvent);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->indexRecords: $e\n');
}

import org.openapitools.client.api.IndexManagementApi;

public class IndexManagementApiExample {
    public static void main(String[] args) {
        IndexManagementApi apiInstance = new IndexManagementApi();
        array[resourceEvent] resourceEvent = examples/indexRecordRequestBody.sample; // array[resourceEvent] | 

        try {
            folioIndexOperationResponse result = apiInstance.indexRecords(resourceEvent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IndexManagementApi#indexRecords");
            e.printStackTrace();
        }
    }
}


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

[apiInstance indexRecordsWith:resourceEvent
              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.IndexManagementApi()
var opts = {
  'resourceEvent': examples/indexRecordRequestBody.sample // {array[resourceEvent]} 
};

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 IndexManagementApi();
            var resourceEvent = new array[resourceEvent](); // array[resourceEvent] |  (optional) 

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\IndexManagementApi();
$resourceEvent = examples/indexRecordRequestBody.sample; // array[resourceEvent] | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::IndexManagementApi->new();
my $resourceEvent = [WWW::OPenAPIClient::Object::array[resourceEvent]->new()]; # array[resourceEvent] | 

eval {
    my $result = $api_instance->indexRecords(resourceEvent => $resourceEvent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling IndexManagementApi->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.IndexManagementApi()
resourceEvent = examples/indexRecordRequestBody.sample # array[resourceEvent] |  (optional)

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

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

    let mut context = IndexManagementApi::Context::default();
    let result = client.indexRecords(resourceEvent, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
resourceEvent

Responses


reindexInventoryRecords

Initiates reindex for the inventory records


/search/index/inventory/reindex

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://folio-dev-spitfire-okapi.ci.folio.org/search/index/inventory/reindex" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.IndexManagementApi;

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

public class IndexManagementApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        IndexManagementApi apiInstance = new IndexManagementApi();
        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 IndexManagementApi#reindexInventoryRecords");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String xOkapiTenant = new String(); // String | X-Okapi-Tenant header value
final ReindexRequest reindexRequest = new ReindexRequest(); // ReindexRequest | 

try {
    final result = await api_instance.reindexInventoryRecords(xOkapiTenant, reindexRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->reindexInventoryRecords: $e\n');
}

import org.openapitools.client.api.IndexManagementApi;

public class IndexManagementApiExample {
    public static void main(String[] args) {
        IndexManagementApi apiInstance = new IndexManagementApi();
        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 IndexManagementApi#reindexInventoryRecords");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
IndexManagementApi *apiInstance = [[IndexManagementApi 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.IndexManagementApi()
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 IndexManagementApi();
            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 IndexManagementApi.reindexInventoryRecords: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\IndexManagementApi();
$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 IndexManagementApi->reindexInventoryRecords: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::IndexManagementApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::IndexManagementApi->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 IndexManagementApi->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.IndexManagementApi()
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 IndexManagementApi->reindexInventoryRecords: %s\n" % e)
extern crate IndexManagementApi;

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

    let mut context = IndexManagementApi::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


updateIndexDynamicSettings

Update Index Dynamic Settings data.


/search/index/settings

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://folio-dev-spitfire-okapi.ci.folio.org/search/index/settings" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.IndexManagementApi;

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

public class IndexManagementApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        IndexManagementApi apiInstance = new IndexManagementApi();
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
        UpdateIndexDynamicSettingsRequest updateIndexDynamicSettingsRequest = ; // UpdateIndexDynamicSettingsRequest | 

        try {
            folioIndexOperationResponse result = apiInstance.updateIndexDynamicSettings(xOkapiTenant, updateIndexDynamicSettingsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IndexManagementApi#updateIndexDynamicSettings");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String xOkapiTenant = new String(); // String | X-Okapi-Tenant header value
final UpdateIndexDynamicSettingsRequest updateIndexDynamicSettingsRequest = new UpdateIndexDynamicSettingsRequest(); // UpdateIndexDynamicSettingsRequest | 

try {
    final result = await api_instance.updateIndexDynamicSettings(xOkapiTenant, updateIndexDynamicSettingsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateIndexDynamicSettings: $e\n');
}

import org.openapitools.client.api.IndexManagementApi;

public class IndexManagementApiExample {
    public static void main(String[] args) {
        IndexManagementApi apiInstance = new IndexManagementApi();
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
        UpdateIndexDynamicSettingsRequest updateIndexDynamicSettingsRequest = ; // UpdateIndexDynamicSettingsRequest | 

        try {
            folioIndexOperationResponse result = apiInstance.updateIndexDynamicSettings(xOkapiTenant, updateIndexDynamicSettingsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IndexManagementApi#updateIndexDynamicSettings");
            e.printStackTrace();
        }
    }
}


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

[apiInstance updateIndexDynamicSettingsWith:xOkapiTenant
    updateIndexDynamicSettingsRequest:updateIndexDynamicSettingsRequest
              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.IndexManagementApi()
var xOkapiTenant = xOkapiTenant_example; // {String} X-Okapi-Tenant header value
var opts = {
  'updateIndexDynamicSettingsRequest':  // {UpdateIndexDynamicSettingsRequest} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new IndexManagementApi();
            var xOkapiTenant = xOkapiTenant_example;  // String | X-Okapi-Tenant header value (default to null)
            var updateIndexDynamicSettingsRequest = new UpdateIndexDynamicSettingsRequest(); // UpdateIndexDynamicSettingsRequest |  (optional) 

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\IndexManagementApi();
$xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
$updateIndexDynamicSettingsRequest = ; // UpdateIndexDynamicSettingsRequest | 

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

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

eval {
    my $result = $api_instance->updateIndexDynamicSettings(xOkapiTenant => $xOkapiTenant, updateIndexDynamicSettingsRequest => $updateIndexDynamicSettingsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling IndexManagementApi->updateIndexDynamicSettings: $@\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.IndexManagementApi()
xOkapiTenant = xOkapiTenant_example # String | X-Okapi-Tenant header value (default to null)
updateIndexDynamicSettingsRequest =  # UpdateIndexDynamicSettingsRequest |  (optional)

try:
    api_response = api_instance.update_index_dynamic_settings(xOkapiTenant, updateIndexDynamicSettingsRequest=updateIndexDynamicSettingsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IndexManagementApi->updateIndexDynamicSettings: %s\n" % e)
extern crate IndexManagementApi;

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

    let mut context = IndexManagementApi::Context::default();
    let result = client.updateIndexDynamicSettings(xOkapiTenant, updateIndexDynamicSettingsRequest, &context).wait();

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

Scopes

Parameters

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

Responses


updateMappings

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


/search/index/mappings

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://folio-dev-spitfire-okapi.ci.folio.org/search/index/mappings" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.IndexManagementApi;

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

public class IndexManagementApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        IndexManagementApi apiInstance = new IndexManagementApi();
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
        UpdateMappingsRequest updateMappingsRequest = ; // UpdateMappingsRequest | 

        try {
            folioIndexOperationResponse result = apiInstance.updateMappings(xOkapiTenant, updateMappingsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IndexManagementApi#updateMappings");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String xOkapiTenant = new String(); // String | X-Okapi-Tenant header value
final UpdateMappingsRequest updateMappingsRequest = new UpdateMappingsRequest(); // UpdateMappingsRequest | 

try {
    final result = await api_instance.updateMappings(xOkapiTenant, updateMappingsRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateMappings: $e\n');
}

import org.openapitools.client.api.IndexManagementApi;

public class IndexManagementApiExample {
    public static void main(String[] args) {
        IndexManagementApi apiInstance = new IndexManagementApi();
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
        UpdateMappingsRequest updateMappingsRequest = ; // UpdateMappingsRequest | 

        try {
            folioIndexOperationResponse result = apiInstance.updateMappings(xOkapiTenant, updateMappingsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IndexManagementApi#updateMappings");
            e.printStackTrace();
        }
    }
}


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

[apiInstance updateMappingsWith:xOkapiTenant
    updateMappingsRequest:updateMappingsRequest
              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.IndexManagementApi()
var xOkapiTenant = xOkapiTenant_example; // {String} X-Okapi-Tenant header value
var opts = {
  'updateMappingsRequest':  // {UpdateMappingsRequest} 
};

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 IndexManagementApi();
            var xOkapiTenant = xOkapiTenant_example;  // String | X-Okapi-Tenant header value (default to null)
            var updateMappingsRequest = new UpdateMappingsRequest(); // UpdateMappingsRequest |  (optional) 

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\IndexManagementApi();
$xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
$updateMappingsRequest = ; // UpdateMappingsRequest | 

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

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

eval {
    my $result = $api_instance->updateMappings(xOkapiTenant => $xOkapiTenant, updateMappingsRequest => $updateMappingsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling IndexManagementApi->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.IndexManagementApi()
xOkapiTenant = xOkapiTenant_example # String | X-Okapi-Tenant header value (default to null)
updateMappingsRequest =  # UpdateMappingsRequest |  (optional)

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

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

    let mut context = IndexManagementApi::Context::default();
    let result = client.updateMappings(xOkapiTenant, updateMappingsRequest, &context).wait();

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

Scopes

Parameters

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

Responses


SearchConsortium

getConsortiumHoldings

Get a list of holdings (only for consortium environment)


/search/consortium/holdings

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://folio-dev-spitfire-okapi.ci.folio.org/search/consortium/holdings?instanceId=instanceId_example&tenantId=tenantId_example&limit=56&offset=56&sortBy=sortBy_example&sortOrder="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SearchConsortiumApi;

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

public class SearchConsortiumApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SearchConsortiumApi apiInstance = new SearchConsortiumApi();
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
        String instanceId = instanceId_example; // String | UUID of the instance
        String tenantId = tenantId_example; // String | Tenant ID
        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.
        String sortBy = sortBy_example; // String | Defines a field to sort by. 
Possible values:
  - id
  - hrid
  - tenantId
  - instanceId
  - callNumberPrefix
  - callNumber
  - callNumberSuffix
  - copyNumber
  - permanentLocationId

        SortOrder sortOrder = ; // SortOrder | Defines sorting order

        try {
            consortiumHoldingCollection result = apiInstance.getConsortiumHoldings(xOkapiTenant, instanceId, tenantId, limit, offset, sortBy, sortOrder);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchConsortiumApi#getConsortiumHoldings");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String xOkapiTenant = new String(); // String | X-Okapi-Tenant header value
final String instanceId = new String(); // String | UUID of the instance
final String tenantId = new String(); // String | Tenant ID
final Integer limit = new Integer(); // Integer | Limit the number of elements returned in the response.
final Integer offset = new Integer(); // Integer | Skip over a number of elements by specifying an offset value for the query.
final String sortBy = new String(); // String | Defines a field to sort by. 
Possible values:
  - id
  - hrid
  - tenantId
  - instanceId
  - callNumberPrefix
  - callNumber
  - callNumberSuffix
  - copyNumber
  - permanentLocationId

final SortOrder sortOrder = new SortOrder(); // SortOrder | Defines sorting order

try {
    final result = await api_instance.getConsortiumHoldings(xOkapiTenant, instanceId, tenantId, limit, offset, sortBy, sortOrder);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getConsortiumHoldings: $e\n');
}

import org.openapitools.client.api.SearchConsortiumApi;

public class SearchConsortiumApiExample {
    public static void main(String[] args) {
        SearchConsortiumApi apiInstance = new SearchConsortiumApi();
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
        String instanceId = instanceId_example; // String | UUID of the instance
        String tenantId = tenantId_example; // String | Tenant ID
        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.
        String sortBy = sortBy_example; // String | Defines a field to sort by. 
Possible values:
  - id
  - hrid
  - tenantId
  - instanceId
  - callNumberPrefix
  - callNumber
  - callNumberSuffix
  - copyNumber
  - permanentLocationId

        SortOrder sortOrder = ; // SortOrder | Defines sorting order

        try {
            consortiumHoldingCollection result = apiInstance.getConsortiumHoldings(xOkapiTenant, instanceId, tenantId, limit, offset, sortBy, sortOrder);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchConsortiumApi#getConsortiumHoldings");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SearchConsortiumApi *apiInstance = [[SearchConsortiumApi alloc] init];
String *xOkapiTenant = xOkapiTenant_example; // X-Okapi-Tenant header value (default to null)
String *instanceId = instanceId_example; // UUID of the instance (optional) (default to null)
String *tenantId = tenantId_example; // Tenant ID (optional) (default to null)
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)
String *sortBy = sortBy_example; // Defines a field to sort by. 
Possible values:
  - id
  - hrid
  - tenantId
  - instanceId
  - callNumberPrefix
  - callNumber
  - callNumberSuffix
  - copyNumber
  - permanentLocationId
 (optional) (default to null)
SortOrder *sortOrder = ; // Defines sorting order (optional) (default to null)

[apiInstance getConsortiumHoldingsWith:xOkapiTenant
    instanceId:instanceId
    tenantId:tenantId
    limit:limit
    offset:offset
    sortBy:sortBy
    sortOrder:sortOrder
              completionHandler: ^(consortiumHoldingCollection 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.SearchConsortiumApi()
var xOkapiTenant = xOkapiTenant_example; // {String} X-Okapi-Tenant header value
var opts = {
  'instanceId': instanceId_example, // {String} UUID of the instance
  'tenantId': tenantId_example, // {String} Tenant ID
  '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.
  'sortBy': sortBy_example, // {String} Defines a field to sort by. 
Possible values:
  - id
  - hrid
  - tenantId
  - instanceId
  - callNumberPrefix
  - callNumber
  - callNumberSuffix
  - copyNumber
  - permanentLocationId

  'sortOrder':  // {SortOrder} Defines sorting order
};

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

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

            // Create an instance of the API class
            var apiInstance = new SearchConsortiumApi();
            var xOkapiTenant = xOkapiTenant_example;  // String | X-Okapi-Tenant header value (default to null)
            var instanceId = instanceId_example;  // String | UUID of the instance (optional)  (default to null)
            var tenantId = tenantId_example;  // String | Tenant ID (optional)  (default to null)
            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)
            var sortBy = sortBy_example;  // String | Defines a field to sort by. 
Possible values:
  - id
  - hrid
  - tenantId
  - instanceId
  - callNumberPrefix
  - callNumber
  - callNumberSuffix
  - copyNumber
  - permanentLocationId
 (optional)  (default to null)
            var sortOrder = new SortOrder(); // SortOrder | Defines sorting order (optional)  (default to null)

            try {
                consortiumHoldingCollection result = apiInstance.getConsortiumHoldings(xOkapiTenant, instanceId, tenantId, limit, offset, sortBy, sortOrder);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SearchConsortiumApi.getConsortiumHoldings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SearchConsortiumApi();
$xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
$instanceId = instanceId_example; // String | UUID of the instance
$tenantId = tenantId_example; // String | Tenant ID
$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.
$sortBy = sortBy_example; // String | Defines a field to sort by. 
Possible values:
  - id
  - hrid
  - tenantId
  - instanceId
  - callNumberPrefix
  - callNumber
  - callNumberSuffix
  - copyNumber
  - permanentLocationId

$sortOrder = ; // SortOrder | Defines sorting order

try {
    $result = $api_instance->getConsortiumHoldings($xOkapiTenant, $instanceId, $tenantId, $limit, $offset, $sortBy, $sortOrder);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SearchConsortiumApi->getConsortiumHoldings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SearchConsortiumApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SearchConsortiumApi->new();
my $xOkapiTenant = xOkapiTenant_example; # String | X-Okapi-Tenant header value
my $instanceId = instanceId_example; # String | UUID of the instance
my $tenantId = tenantId_example; # String | Tenant ID
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.
my $sortBy = sortBy_example; # String | Defines a field to sort by. 
Possible values:
  - id
  - hrid
  - tenantId
  - instanceId
  - callNumberPrefix
  - callNumber
  - callNumberSuffix
  - copyNumber
  - permanentLocationId

my $sortOrder = ; # SortOrder | Defines sorting order

eval {
    my $result = $api_instance->getConsortiumHoldings(xOkapiTenant => $xOkapiTenant, instanceId => $instanceId, tenantId => $tenantId, limit => $limit, offset => $offset, sortBy => $sortBy, sortOrder => $sortOrder);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SearchConsortiumApi->getConsortiumHoldings: $@\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.SearchConsortiumApi()
xOkapiTenant = xOkapiTenant_example # String | X-Okapi-Tenant header value (default to null)
instanceId = instanceId_example # String | UUID of the instance (optional) (default to null)
tenantId = tenantId_example # String | Tenant ID (optional) (default to null)
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)
sortBy = sortBy_example # String | Defines a field to sort by. 
Possible values:
  - id
  - hrid
  - tenantId
  - instanceId
  - callNumberPrefix
  - callNumber
  - callNumberSuffix
  - copyNumber
  - permanentLocationId
 (optional) (default to null)
sortOrder =  # SortOrder | Defines sorting order (optional) (default to null)

try:
    api_response = api_instance.get_consortium_holdings(xOkapiTenant, instanceId=instanceId, tenantId=tenantId, limit=limit, offset=offset, sortBy=sortBy, sortOrder=sortOrder)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SearchConsortiumApi->getConsortiumHoldings: %s\n" % e)
extern crate SearchConsortiumApi;

pub fn main() {
    let xOkapiTenant = xOkapiTenant_example; // String
    let instanceId = instanceId_example; // String
    let tenantId = tenantId_example; // String
    let limit = 56; // Integer
    let offset = 56; // Integer
    let sortBy = sortBy_example; // String
    let sortOrder = ; // SortOrder

    let mut context = SearchConsortiumApi::Context::default();
    let result = client.getConsortiumHoldings(xOkapiTenant, instanceId, tenantId, limit, offset, sortBy, sortOrder, &context).wait();

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

Scopes

Parameters

Header parameters
Name Description
x-okapi-tenant*
String
X-Okapi-Tenant header value
Required
Query parameters
Name Description
instanceId
String
UUID of the instance
tenantId
String
Tenant ID
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.
sortBy
String
Defines a field to sort by. Possible values: - id - hrid - tenantId - instanceId - callNumberPrefix - callNumber - callNumberSuffix - copyNumber - permanentLocationId
sortOrder
SortOrder
Defines sorting order

Responses


getConsortiumItems

Get a list of items (only for consortium environment)


/search/consortium/items

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://folio-dev-spitfire-okapi.ci.folio.org/search/consortium/items?instanceId=instanceId_example&holdingsRecordId=holdingsRecordId_example&tenantId=tenantId_example&limit=56&offset=56&sortBy=sortBy_example&sortOrder="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SearchConsortiumApi;

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

public class SearchConsortiumApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SearchConsortiumApi apiInstance = new SearchConsortiumApi();
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
        String instanceId = instanceId_example; // String | UUID of the instance
        String holdingsRecordId = holdingsRecordId_example; // String | UUID of the holdings record
        String tenantId = tenantId_example; // String | Tenant ID
        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.
        String sortBy = sortBy_example; // String | Defines a field to sort by. 
Possible values:
  - id
  - hrid
  - tenantId
  - instanceId
  - holdingsRecordId
  - barcode

        SortOrder sortOrder = ; // SortOrder | Defines sorting order

        try {
            consortiumItemCollection result = apiInstance.getConsortiumItems(xOkapiTenant, instanceId, holdingsRecordId, tenantId, limit, offset, sortBy, sortOrder);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchConsortiumApi#getConsortiumItems");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String xOkapiTenant = new String(); // String | X-Okapi-Tenant header value
final String instanceId = new String(); // String | UUID of the instance
final String holdingsRecordId = new String(); // String | UUID of the holdings record
final String tenantId = new String(); // String | Tenant ID
final Integer limit = new Integer(); // Integer | Limit the number of elements returned in the response.
final Integer offset = new Integer(); // Integer | Skip over a number of elements by specifying an offset value for the query.
final String sortBy = new String(); // String | Defines a field to sort by. 
Possible values:
  - id
  - hrid
  - tenantId
  - instanceId
  - holdingsRecordId
  - barcode

final SortOrder sortOrder = new SortOrder(); // SortOrder | Defines sorting order

try {
    final result = await api_instance.getConsortiumItems(xOkapiTenant, instanceId, holdingsRecordId, tenantId, limit, offset, sortBy, sortOrder);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getConsortiumItems: $e\n');
}

import org.openapitools.client.api.SearchConsortiumApi;

public class SearchConsortiumApiExample {
    public static void main(String[] args) {
        SearchConsortiumApi apiInstance = new SearchConsortiumApi();
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
        String instanceId = instanceId_example; // String | UUID of the instance
        String holdingsRecordId = holdingsRecordId_example; // String | UUID of the holdings record
        String tenantId = tenantId_example; // String | Tenant ID
        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.
        String sortBy = sortBy_example; // String | Defines a field to sort by. 
Possible values:
  - id
  - hrid
  - tenantId
  - instanceId
  - holdingsRecordId
  - barcode

        SortOrder sortOrder = ; // SortOrder | Defines sorting order

        try {
            consortiumItemCollection result = apiInstance.getConsortiumItems(xOkapiTenant, instanceId, holdingsRecordId, tenantId, limit, offset, sortBy, sortOrder);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchConsortiumApi#getConsortiumItems");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SearchConsortiumApi *apiInstance = [[SearchConsortiumApi alloc] init];
String *xOkapiTenant = xOkapiTenant_example; // X-Okapi-Tenant header value (default to null)
String *instanceId = instanceId_example; // UUID of the instance (optional) (default to null)
String *holdingsRecordId = holdingsRecordId_example; // UUID of the holdings record (optional) (default to null)
String *tenantId = tenantId_example; // Tenant ID (optional) (default to null)
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)
String *sortBy = sortBy_example; // Defines a field to sort by. 
Possible values:
  - id
  - hrid
  - tenantId
  - instanceId
  - holdingsRecordId
  - barcode
 (optional) (default to null)
SortOrder *sortOrder = ; // Defines sorting order (optional) (default to null)

[apiInstance getConsortiumItemsWith:xOkapiTenant
    instanceId:instanceId
    holdingsRecordId:holdingsRecordId
    tenantId:tenantId
    limit:limit
    offset:offset
    sortBy:sortBy
    sortOrder:sortOrder
              completionHandler: ^(consortiumItemCollection 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.SearchConsortiumApi()
var xOkapiTenant = xOkapiTenant_example; // {String} X-Okapi-Tenant header value
var opts = {
  'instanceId': instanceId_example, // {String} UUID of the instance
  'holdingsRecordId': holdingsRecordId_example, // {String} UUID of the holdings record
  'tenantId': tenantId_example, // {String} Tenant ID
  '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.
  'sortBy': sortBy_example, // {String} Defines a field to sort by. 
Possible values:
  - id
  - hrid
  - tenantId
  - instanceId
  - holdingsRecordId
  - barcode

  'sortOrder':  // {SortOrder} Defines sorting order
};

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

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

            // Create an instance of the API class
            var apiInstance = new SearchConsortiumApi();
            var xOkapiTenant = xOkapiTenant_example;  // String | X-Okapi-Tenant header value (default to null)
            var instanceId = instanceId_example;  // String | UUID of the instance (optional)  (default to null)
            var holdingsRecordId = holdingsRecordId_example;  // String | UUID of the holdings record (optional)  (default to null)
            var tenantId = tenantId_example;  // String | Tenant ID (optional)  (default to null)
            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)
            var sortBy = sortBy_example;  // String | Defines a field to sort by. 
Possible values:
  - id
  - hrid
  - tenantId
  - instanceId
  - holdingsRecordId
  - barcode
 (optional)  (default to null)
            var sortOrder = new SortOrder(); // SortOrder | Defines sorting order (optional)  (default to null)

            try {
                consortiumItemCollection result = apiInstance.getConsortiumItems(xOkapiTenant, instanceId, holdingsRecordId, tenantId, limit, offset, sortBy, sortOrder);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SearchConsortiumApi.getConsortiumItems: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SearchConsortiumApi();
$xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
$instanceId = instanceId_example; // String | UUID of the instance
$holdingsRecordId = holdingsRecordId_example; // String | UUID of the holdings record
$tenantId = tenantId_example; // String | Tenant ID
$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.
$sortBy = sortBy_example; // String | Defines a field to sort by. 
Possible values:
  - id
  - hrid
  - tenantId
  - instanceId
  - holdingsRecordId
  - barcode

$sortOrder = ; // SortOrder | Defines sorting order

try {
    $result = $api_instance->getConsortiumItems($xOkapiTenant, $instanceId, $holdingsRecordId, $tenantId, $limit, $offset, $sortBy, $sortOrder);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SearchConsortiumApi->getConsortiumItems: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SearchConsortiumApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SearchConsortiumApi->new();
my $xOkapiTenant = xOkapiTenant_example; # String | X-Okapi-Tenant header value
my $instanceId = instanceId_example; # String | UUID of the instance
my $holdingsRecordId = holdingsRecordId_example; # String | UUID of the holdings record
my $tenantId = tenantId_example; # String | Tenant ID
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.
my $sortBy = sortBy_example; # String | Defines a field to sort by. 
Possible values:
  - id
  - hrid
  - tenantId
  - instanceId
  - holdingsRecordId
  - barcode

my $sortOrder = ; # SortOrder | Defines sorting order

eval {
    my $result = $api_instance->getConsortiumItems(xOkapiTenant => $xOkapiTenant, instanceId => $instanceId, holdingsRecordId => $holdingsRecordId, tenantId => $tenantId, limit => $limit, offset => $offset, sortBy => $sortBy, sortOrder => $sortOrder);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SearchConsortiumApi->getConsortiumItems: $@\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.SearchConsortiumApi()
xOkapiTenant = xOkapiTenant_example # String | X-Okapi-Tenant header value (default to null)
instanceId = instanceId_example # String | UUID of the instance (optional) (default to null)
holdingsRecordId = holdingsRecordId_example # String | UUID of the holdings record (optional) (default to null)
tenantId = tenantId_example # String | Tenant ID (optional) (default to null)
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)
sortBy = sortBy_example # String | Defines a field to sort by. 
Possible values:
  - id
  - hrid
  - tenantId
  - instanceId
  - holdingsRecordId
  - barcode
 (optional) (default to null)
sortOrder =  # SortOrder | Defines sorting order (optional) (default to null)

try:
    api_response = api_instance.get_consortium_items(xOkapiTenant, instanceId=instanceId, holdingsRecordId=holdingsRecordId, tenantId=tenantId, limit=limit, offset=offset, sortBy=sortBy, sortOrder=sortOrder)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SearchConsortiumApi->getConsortiumItems: %s\n" % e)
extern crate SearchConsortiumApi;

pub fn main() {
    let xOkapiTenant = xOkapiTenant_example; // String
    let instanceId = instanceId_example; // String
    let holdingsRecordId = holdingsRecordId_example; // String
    let tenantId = tenantId_example; // String
    let limit = 56; // Integer
    let offset = 56; // Integer
    let sortBy = sortBy_example; // String
    let sortOrder = ; // SortOrder

    let mut context = SearchConsortiumApi::Context::default();
    let result = client.getConsortiumItems(xOkapiTenant, instanceId, holdingsRecordId, tenantId, limit, offset, sortBy, sortOrder, &context).wait();

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

Scopes

Parameters

Header parameters
Name Description
x-okapi-tenant*
String
X-Okapi-Tenant header value
Required
Query parameters
Name Description
instanceId
String
UUID of the instance
holdingsRecordId
String
UUID of the holdings record
tenantId
String
Tenant ID
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.
sortBy
String
Defines a field to sort by. Possible values: - id - hrid - tenantId - instanceId - holdingsRecordId - barcode
sortOrder
SortOrder
Defines sorting order

Responses


SearchResourcesIds

getHoldingIds

Get a list of holding ids linked to instances found by the CQL query


/search/holdings/ids

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,application/text" \
 "https://folio-dev-spitfire-okapi.ci.folio.org/search/holdings/ids?query=query_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SearchResourcesIdsApi;

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

public class SearchResourcesIdsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SearchResourcesIdsApi apiInstance = new SearchResourcesIdsApi();
        String query = query_example; // String | A CQL query string with search conditions.
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
        String contentType = contentType_example; // String | Content-Type header value

        try {
            apiInstance.getHoldingIds(query, xOkapiTenant, contentType);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchResourcesIdsApi#getHoldingIds");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String query = new String(); // String | A CQL query string with search conditions.
final String xOkapiTenant = new String(); // String | X-Okapi-Tenant header value
final String contentType = new String(); // String | Content-Type header value

try {
    final result = await api_instance.getHoldingIds(query, xOkapiTenant, contentType);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getHoldingIds: $e\n');
}

import org.openapitools.client.api.SearchResourcesIdsApi;

public class SearchResourcesIdsApiExample {
    public static void main(String[] args) {
        SearchResourcesIdsApi apiInstance = new SearchResourcesIdsApi();
        String query = query_example; // String | A CQL query string with search conditions.
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
        String contentType = contentType_example; // String | Content-Type header value

        try {
            apiInstance.getHoldingIds(query, xOkapiTenant, contentType);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchResourcesIdsApi#getHoldingIds");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SearchResourcesIdsApi *apiInstance = [[SearchResourcesIdsApi 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)
String *contentType = contentType_example; // Content-Type header value (optional) (default to null)

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

// Create an instance of the API class
var api = new SearchApi.SearchResourcesIdsApi()
var query = query_example; // {String} A CQL query string with search conditions.
var xOkapiTenant = xOkapiTenant_example; // {String} X-Okapi-Tenant header value
var opts = {
  'contentType': contentType_example // {String} Content-Type header value
};

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

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

            // Create an instance of the API class
            var apiInstance = new SearchResourcesIdsApi();
            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 contentType = contentType_example;  // String | Content-Type header value (optional)  (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SearchResourcesIdsApi();
$query = query_example; // String | A CQL query string with search conditions.
$xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
$contentType = contentType_example; // String | Content-Type header value

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SearchResourcesIdsApi->new();
my $query = query_example; # String | A CQL query string with search conditions.
my $xOkapiTenant = xOkapiTenant_example; # String | X-Okapi-Tenant header value
my $contentType = contentType_example; # String | Content-Type header value

eval {
    $api_instance->getHoldingIds(query => $query, xOkapiTenant => $xOkapiTenant, contentType => $contentType);
};
if ($@) {
    warn "Exception when calling SearchResourcesIdsApi->getHoldingIds: $@\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.SearchResourcesIdsApi()
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)
contentType = contentType_example # String | Content-Type header value (optional) (default to null)

try:
    api_instance.get_holding_ids(query, xOkapiTenant, contentType=contentType)
except ApiException as e:
    print("Exception when calling SearchResourcesIdsApi->getHoldingIds: %s\n" % e)
extern crate SearchResourcesIdsApi;

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

    let mut context = SearchResourcesIdsApi::Context::default();
    let result = client.getHoldingIds(query, xOkapiTenant, contentType, &context).wait();

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

Scopes

Parameters

Header parameters
Name Description
x-okapi-tenant*
String
X-Okapi-Tenant header value
Required
Content-Type
String
Content-Type header value
Query parameters
Name Description
query*
String
A CQL query string with search conditions.
Required

Responses


getIdsJob

Get a job for the stream of resource ids.


/search/resources/jobs/{jobId}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://folio-dev-spitfire-okapi.ci.folio.org/search/resources/jobs/{jobId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SearchResourcesIdsApi;

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

public class SearchResourcesIdsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SearchResourcesIdsApi apiInstance = new SearchResourcesIdsApi();
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
        String jobId = jobId_example; // String | UUID of the job to get

        try {
            resourceIdsJob result = apiInstance.getIdsJob(xOkapiTenant, jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchResourcesIdsApi#getIdsJob");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String xOkapiTenant = new String(); // String | X-Okapi-Tenant header value
final String jobId = new String(); // String | UUID of the job to get

try {
    final result = await api_instance.getIdsJob(xOkapiTenant, jobId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getIdsJob: $e\n');
}

import org.openapitools.client.api.SearchResourcesIdsApi;

public class SearchResourcesIdsApiExample {
    public static void main(String[] args) {
        SearchResourcesIdsApi apiInstance = new SearchResourcesIdsApi();
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
        String jobId = jobId_example; // String | UUID of the job to get

        try {
            resourceIdsJob result = apiInstance.getIdsJob(xOkapiTenant, jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchResourcesIdsApi#getIdsJob");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SearchResourcesIdsApi *apiInstance = [[SearchResourcesIdsApi alloc] init];
String *xOkapiTenant = xOkapiTenant_example; // X-Okapi-Tenant header value (default to null)
String *jobId = jobId_example; // UUID of the job to get (default to null)

[apiInstance getIdsJobWith:xOkapiTenant
    jobId:jobId
              completionHandler: ^(resourceIdsJob 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.SearchResourcesIdsApi()
var xOkapiTenant = xOkapiTenant_example; // {String} X-Okapi-Tenant header value
var jobId = jobId_example; // {String} UUID of the job to get

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

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

            // Create an instance of the API class
            var apiInstance = new SearchResourcesIdsApi();
            var xOkapiTenant = xOkapiTenant_example;  // String | X-Okapi-Tenant header value (default to null)
            var jobId = jobId_example;  // String | UUID of the job to get (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SearchResourcesIdsApi();
$xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
$jobId = jobId_example; // String | UUID of the job to get

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SearchResourcesIdsApi->new();
my $xOkapiTenant = xOkapiTenant_example; # String | X-Okapi-Tenant header value
my $jobId = jobId_example; # String | UUID of the job to get

eval {
    my $result = $api_instance->getIdsJob(xOkapiTenant => $xOkapiTenant, jobId => $jobId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SearchResourcesIdsApi->getIdsJob: $@\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.SearchResourcesIdsApi()
xOkapiTenant = xOkapiTenant_example # String | X-Okapi-Tenant header value (default to null)
jobId = jobId_example # String | UUID of the job to get (default to null)

try:
    api_response = api_instance.get_ids_job(xOkapiTenant, jobId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SearchResourcesIdsApi->getIdsJob: %s\n" % e)
extern crate SearchResourcesIdsApi;

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

    let mut context = SearchResourcesIdsApi::Context::default();
    let result = client.getIdsJob(xOkapiTenant, jobId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
jobId*
String
UUID of the job to get
Required
Header parameters
Name Description
x-okapi-tenant*
String
X-Okapi-Tenant header value
Required

Responses


getInstanceIds

Get a list of instance ids for CQL query


/search/instances/ids

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,application/text" \
 "https://folio-dev-spitfire-okapi.ci.folio.org/search/instances/ids?query=query_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SearchResourcesIdsApi;

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

public class SearchResourcesIdsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SearchResourcesIdsApi apiInstance = new SearchResourcesIdsApi();
        String query = query_example; // String | A CQL query string with search conditions.
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
        String contentType = contentType_example; // String | Content-Type header value

        try {
            apiInstance.getInstanceIds(query, xOkapiTenant, contentType);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchResourcesIdsApi#getInstanceIds");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String query = new String(); // String | A CQL query string with search conditions.
final String xOkapiTenant = new String(); // String | X-Okapi-Tenant header value
final String contentType = new String(); // String | Content-Type header value

try {
    final result = await api_instance.getInstanceIds(query, xOkapiTenant, contentType);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getInstanceIds: $e\n');
}

import org.openapitools.client.api.SearchResourcesIdsApi;

public class SearchResourcesIdsApiExample {
    public static void main(String[] args) {
        SearchResourcesIdsApi apiInstance = new SearchResourcesIdsApi();
        String query = query_example; // String | A CQL query string with search conditions.
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
        String contentType = contentType_example; // String | Content-Type header value

        try {
            apiInstance.getInstanceIds(query, xOkapiTenant, contentType);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchResourcesIdsApi#getInstanceIds");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SearchResourcesIdsApi *apiInstance = [[SearchResourcesIdsApi 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)
String *contentType = contentType_example; // Content-Type header value (optional) (default to null)

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

// Create an instance of the API class
var api = new SearchApi.SearchResourcesIdsApi()
var query = query_example; // {String} A CQL query string with search conditions.
var xOkapiTenant = xOkapiTenant_example; // {String} X-Okapi-Tenant header value
var opts = {
  'contentType': contentType_example // {String} Content-Type header value
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getInstanceIds(query, xOkapiTenant, opts, 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 SearchResourcesIdsApi();
            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 contentType = contentType_example;  // String | Content-Type header value (optional)  (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SearchResourcesIdsApi();
$query = query_example; // String | A CQL query string with search conditions.
$xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
$contentType = contentType_example; // String | Content-Type header value

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SearchResourcesIdsApi->new();
my $query = query_example; # String | A CQL query string with search conditions.
my $xOkapiTenant = xOkapiTenant_example; # String | X-Okapi-Tenant header value
my $contentType = contentType_example; # String | Content-Type header value

eval {
    $api_instance->getInstanceIds(query => $query, xOkapiTenant => $xOkapiTenant, contentType => $contentType);
};
if ($@) {
    warn "Exception when calling SearchResourcesIdsApi->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.SearchResourcesIdsApi()
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)
contentType = contentType_example # String | Content-Type header value (optional) (default to null)

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

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

    let mut context = SearchResourcesIdsApi::Context::default();
    let result = client.getInstanceIds(query, xOkapiTenant, contentType, &context).wait();

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

Scopes

Parameters

Header parameters
Name Description
x-okapi-tenant*
String
X-Okapi-Tenant header value
Required
Content-Type
String
Content-Type header value
Query parameters
Name Description
query*
String
A CQL query string with search conditions.
Required

Responses


getResourceIds

Get a list of resource ids by job id


/search/resources/jobs/{jobId}/ids

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://folio-dev-spitfire-okapi.ci.folio.org/search/resources/jobs/{jobId}/ids"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SearchResourcesIdsApi;

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

public class SearchResourcesIdsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SearchResourcesIdsApi apiInstance = new SearchResourcesIdsApi();
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
        String jobId = jobId_example; // String | UUID of the job to get

        try {
            apiInstance.getResourceIds(xOkapiTenant, jobId);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchResourcesIdsApi#getResourceIds");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String xOkapiTenant = new String(); // String | X-Okapi-Tenant header value
final String jobId = new String(); // String | UUID of the job to get

try {
    final result = await api_instance.getResourceIds(xOkapiTenant, jobId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getResourceIds: $e\n');
}

import org.openapitools.client.api.SearchResourcesIdsApi;

public class SearchResourcesIdsApiExample {
    public static void main(String[] args) {
        SearchResourcesIdsApi apiInstance = new SearchResourcesIdsApi();
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
        String jobId = jobId_example; // String | UUID of the job to get

        try {
            apiInstance.getResourceIds(xOkapiTenant, jobId);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchResourcesIdsApi#getResourceIds");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SearchResourcesIdsApi *apiInstance = [[SearchResourcesIdsApi alloc] init];
String *xOkapiTenant = xOkapiTenant_example; // X-Okapi-Tenant header value (default to null)
String *jobId = jobId_example; // UUID of the job to get (default to null)

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

// Create an instance of the API class
var api = new SearchApi.SearchResourcesIdsApi()
var xOkapiTenant = xOkapiTenant_example; // {String} X-Okapi-Tenant header value
var jobId = jobId_example; // {String} UUID of the job to get

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

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

            // Create an instance of the API class
            var apiInstance = new SearchResourcesIdsApi();
            var xOkapiTenant = xOkapiTenant_example;  // String | X-Okapi-Tenant header value (default to null)
            var jobId = jobId_example;  // String | UUID of the job to get (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SearchResourcesIdsApi();
$xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
$jobId = jobId_example; // String | UUID of the job to get

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SearchResourcesIdsApi->new();
my $xOkapiTenant = xOkapiTenant_example; # String | X-Okapi-Tenant header value
my $jobId = jobId_example; # String | UUID of the job to get

eval {
    $api_instance->getResourceIds(xOkapiTenant => $xOkapiTenant, jobId => $jobId);
};
if ($@) {
    warn "Exception when calling SearchResourcesIdsApi->getResourceIds: $@\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.SearchResourcesIdsApi()
xOkapiTenant = xOkapiTenant_example # String | X-Okapi-Tenant header value (default to null)
jobId = jobId_example # String | UUID of the job to get (default to null)

try:
    api_instance.get_resource_ids(xOkapiTenant, jobId)
except ApiException as e:
    print("Exception when calling SearchResourcesIdsApi->getResourceIds: %s\n" % e)
extern crate SearchResourcesIdsApi;

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

    let mut context = SearchResourcesIdsApi::Context::default();
    let result = client.getResourceIds(xOkapiTenant, jobId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
jobId*
String
UUID of the job to get
Required
Header parameters
Name Description
x-okapi-tenant*
String
X-Okapi-Tenant header value
Required

Responses


submitIdsJob

Creates a job for the stream of resource ids.


/search/resources/jobs

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://folio-dev-spitfire-okapi.ci.folio.org/search/resources/jobs" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SearchResourcesIdsApi;

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

public class SearchResourcesIdsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SearchResourcesIdsApi apiInstance = new SearchResourcesIdsApi();
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
        ResourceIdsJob resourceIdsJob = examples/streamIdsJobRequest.sample; // ResourceIdsJob | 

        try {
            resourceIdsJob result = apiInstance.submitIdsJob(xOkapiTenant, resourceIdsJob);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchResourcesIdsApi#submitIdsJob");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String xOkapiTenant = new String(); // String | X-Okapi-Tenant header value
final ResourceIdsJob resourceIdsJob = new ResourceIdsJob(); // ResourceIdsJob | 

try {
    final result = await api_instance.submitIdsJob(xOkapiTenant, resourceIdsJob);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->submitIdsJob: $e\n');
}

import org.openapitools.client.api.SearchResourcesIdsApi;

public class SearchResourcesIdsApiExample {
    public static void main(String[] args) {
        SearchResourcesIdsApi apiInstance = new SearchResourcesIdsApi();
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
        ResourceIdsJob resourceIdsJob = examples/streamIdsJobRequest.sample; // ResourceIdsJob | 

        try {
            resourceIdsJob result = apiInstance.submitIdsJob(xOkapiTenant, resourceIdsJob);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchResourcesIdsApi#submitIdsJob");
            e.printStackTrace();
        }
    }
}


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

[apiInstance submitIdsJobWith:xOkapiTenant
    resourceIdsJob:resourceIdsJob
              completionHandler: ^(resourceIdsJob 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.SearchResourcesIdsApi()
var xOkapiTenant = xOkapiTenant_example; // {String} X-Okapi-Tenant header value
var opts = {
  'resourceIdsJob': examples/streamIdsJobRequest.sample // {ResourceIdsJob} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new SearchResourcesIdsApi();
            var xOkapiTenant = xOkapiTenant_example;  // String | X-Okapi-Tenant header value (default to null)
            var resourceIdsJob = new ResourceIdsJob(); // ResourceIdsJob |  (optional) 

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

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

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

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

eval {
    my $result = $api_instance->submitIdsJob(xOkapiTenant => $xOkapiTenant, resourceIdsJob => $resourceIdsJob);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SearchResourcesIdsApi->submitIdsJob: $@\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.SearchResourcesIdsApi()
xOkapiTenant = xOkapiTenant_example # String | X-Okapi-Tenant header value (default to null)
resourceIdsJob = examples/streamIdsJobRequest.sample # ResourceIdsJob |  (optional)

try:
    api_response = api_instance.submit_ids_job(xOkapiTenant, resourceIdsJob=resourceIdsJob)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SearchResourcesIdsApi->submitIdsJob: %s\n" % e)
extern crate SearchResourcesIdsApi;

pub fn main() {
    let xOkapiTenant = xOkapiTenant_example; // String
    let resourceIdsJob = examples/streamIdsJobRequest.sample; // ResourceIdsJob

    let mut context = SearchResourcesIdsApi::Context::default();
    let result = client.submitIdsJob(xOkapiTenant, resourceIdsJob, &context).wait();

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

Scopes

Parameters

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

Responses