Search API

Browse

browseAuthorities

Browse Authorities

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=headingRef >= "Comic-Con" or headingRef < "Comic-Con"&expandAll=true&highlightMatch=true&precedingRecordsCount=56&limit=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 = headingRef >= "Comic-Con" or headingRef < "Comic-Con"; // String | A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is `headingRef`.
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
tenantId string == Filter by tenant ID in consortium
shared boolean == Filter by shared/non-shared in consortium
sourceFileId uuid == Filter by authority source file ID. `NULL` value to filter by non-specified.
headingType string == Filter by heading type: `Personal Name`, `Corporate Name`, `Conference Name`, `Geographic Name`, `Uniform Title`, `Topical`, `Genre`
isTitleHeadingRef boolean == Filter title/non-title heading
authRefType boolean == Filter by reference type: `Authorized`, `Reference`, `Auth/Ref`
subjectHeadings char == Filter by subject heading code
metadata.createdDate date ==, >, <, <=, >= Filter by authority create date
metadata.updatedDate date ==, >, <, <=, >= Filter by authority update date
String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value Boolean expandAll = true; // Boolean | Whether to return only basic properties or entire authority record.
Basic fields are: - id - tenantId - shared - headingType - authRefType - headingRef - sourceFileId - naturalId - numberOfTitles 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 queries Integer limit = 56; // Integer | Limit the number of elements returned in the response. try { authorityBrowseResult result = apiInstance.browseAuthorities(query, xOkapiTenant, expandAll, highlightMatch, precedingRecordsCount, limit); 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 filter conditions must include anchor query with range conditions. Anchor field is `headingRef`.
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
tenantId string == Filter by tenant ID in consortium
shared boolean == Filter by shared/non-shared in consortium
sourceFileId uuid == Filter by authority source file ID. `NULL` value to filter by non-specified.
headingType string == Filter by heading type: `Personal Name`, `Corporate Name`, `Conference Name`, `Geographic Name`, `Uniform Title`, `Topical`, `Genre`
isTitleHeadingRef boolean == Filter title/non-title heading
authRefType boolean == Filter by reference type: `Authorized`, `Reference`, `Auth/Ref`
subjectHeadings char == Filter by subject heading code
metadata.createdDate date ==, >, <, <=, >= Filter by authority create date
metadata.updatedDate date ==, >, <, <=, >= Filter by authority update date
final String xOkapiTenant = new String(); // String | X-Okapi-Tenant header value final Boolean expandAll = new Boolean(); // Boolean | Whether to return only basic properties or entire authority record.
Basic fields are: - id - tenantId - shared - headingType - authRefType - headingRef - sourceFileId - naturalId - numberOfTitles 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 queries final Integer limit = new Integer(); // Integer | Limit the number of elements returned in the response. try { final result = await api_instance.browseAuthorities(query, xOkapiTenant, expandAll, highlightMatch, precedingRecordsCount, limit); 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 = headingRef >= "Comic-Con" or headingRef < "Comic-Con"; // String | A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is `headingRef`.
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
tenantId string == Filter by tenant ID in consortium
shared boolean == Filter by shared/non-shared in consortium
sourceFileId uuid == Filter by authority source file ID. `NULL` value to filter by non-specified.
headingType string == Filter by heading type: `Personal Name`, `Corporate Name`, `Conference Name`, `Geographic Name`, `Uniform Title`, `Topical`, `Genre`
isTitleHeadingRef boolean == Filter title/non-title heading
authRefType boolean == Filter by reference type: `Authorized`, `Reference`, `Auth/Ref`
subjectHeadings char == Filter by subject heading code
metadata.createdDate date ==, >, <, <=, >= Filter by authority create date
metadata.updatedDate date ==, >, <, <=, >= Filter by authority update date
String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value Boolean expandAll = true; // Boolean | Whether to return only basic properties or entire authority record.
Basic fields are: - id - tenantId - shared - headingType - authRefType - headingRef - sourceFileId - naturalId - numberOfTitles 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 queries Integer limit = 56; // Integer | Limit the number of elements returned in the response. try { authorityBrowseResult result = apiInstance.browseAuthorities(query, xOkapiTenant, expandAll, highlightMatch, precedingRecordsCount, limit); 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 = headingRef >= "Comic-Con" or headingRef < "Comic-Con"; // A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is `headingRef`.
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
tenantId string == Filter by tenant ID in consortium
shared boolean == Filter by shared/non-shared in consortium
sourceFileId uuid == Filter by authority source file ID. `NULL` value to filter by non-specified.
headingType string == Filter by heading type: `Personal Name`, `Corporate Name`, `Conference Name`, `Geographic Name`, `Uniform Title`, `Topical`, `Genre`
isTitleHeadingRef boolean == Filter title/non-title heading
authRefType boolean == Filter by reference type: `Authorized`, `Reference`, `Auth/Ref`
subjectHeadings char == Filter by subject heading code
metadata.createdDate date ==, >, <, <=, >= Filter by authority create date
metadata.updatedDate date ==, >, <, <=, >= Filter by authority update date
(default to null) String *xOkapiTenant = xOkapiTenant_example; // X-Okapi-Tenant header value (default to null) Boolean *expandAll = true; // Whether to return only basic properties or entire authority record.
Basic fields are: - id - tenantId - shared - headingType - authRefType - headingRef - sourceFileId - naturalId - numberOfTitles (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 queries (optional) (default to null) Integer *limit = 56; // Limit the number of elements returned in the response. (optional) (default to 100) // Browse Authorities [apiInstance browseAuthoritiesWith:query xOkapiTenant:xOkapiTenant expandAll:expandAll highlightMatch:highlightMatch precedingRecordsCount:precedingRecordsCount limit:limit 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 = headingRef >= "Comic-Con" or headingRef < "Comic-Con"; // {String} A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is `headingRef`.
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
tenantId string == Filter by tenant ID in consortium
shared boolean == Filter by shared/non-shared in consortium
sourceFileId uuid == Filter by authority source file ID. `NULL` value to filter by non-specified.
headingType string == Filter by heading type: `Personal Name`, `Corporate Name`, `Conference Name`, `Geographic Name`, `Uniform Title`, `Topical`, `Genre`
isTitleHeadingRef boolean == Filter title/non-title heading
authRefType boolean == Filter by reference type: `Authorized`, `Reference`, `Auth/Ref`
subjectHeadings char == Filter by subject heading code
metadata.createdDate date ==, >, <, <=, >= Filter by authority create date
metadata.updatedDate date ==, >, <, <=, >= Filter by authority update date
var xOkapiTenant = xOkapiTenant_example; // {String} X-Okapi-Tenant header value var opts = { 'expandAll': true, // {Boolean} Whether to return only basic properties or entire authority record.
Basic fields are: - id - tenantId - shared - headingType - authRefType - headingRef - sourceFileId - naturalId - numberOfTitles '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 queries 'limit': 56 // {Integer} Limit the number of elements returned in the response. }; 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 = headingRef >= "Comic-Con" or headingRef < "Comic-Con";  // String | A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is `headingRef`.
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
tenantId string == Filter by tenant ID in consortium
shared boolean == Filter by shared/non-shared in consortium
sourceFileId uuid == Filter by authority source file ID. `NULL` value to filter by non-specified.
headingType string == Filter by heading type: `Personal Name`, `Corporate Name`, `Conference Name`, `Geographic Name`, `Uniform Title`, `Topical`, `Genre`
isTitleHeadingRef boolean == Filter title/non-title heading
authRefType boolean == Filter by reference type: `Authorized`, `Reference`, `Auth/Ref`
subjectHeadings char == Filter by subject heading code
metadata.createdDate date ==, >, <, <=, >= Filter by authority create date
metadata.updatedDate date ==, >, <, <=, >= Filter by authority update date
(default to null) var xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value (default to null) var expandAll = true; // Boolean | Whether to return only basic properties or entire authority record.
Basic fields are: - id - tenantId - shared - headingType - authRefType - headingRef - sourceFileId - naturalId - numberOfTitles (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 queries (optional) (default to null) var limit = 56; // Integer | Limit the number of elements returned in the response. (optional) (default to 100) try { // Browse Authorities authorityBrowseResult result = apiInstance.browseAuthorities(query, xOkapiTenant, expandAll, highlightMatch, precedingRecordsCount, limit); 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 = headingRef >= "Comic-Con" or headingRef < "Comic-Con"; // String | A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is `headingRef`.
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
tenantId string == Filter by tenant ID in consortium
shared boolean == Filter by shared/non-shared in consortium
sourceFileId uuid == Filter by authority source file ID. `NULL` value to filter by non-specified.
headingType string == Filter by heading type: `Personal Name`, `Corporate Name`, `Conference Name`, `Geographic Name`, `Uniform Title`, `Topical`, `Genre`
isTitleHeadingRef boolean == Filter title/non-title heading
authRefType boolean == Filter by reference type: `Authorized`, `Reference`, `Auth/Ref`
subjectHeadings char == Filter by subject heading code
metadata.createdDate date ==, >, <, <=, >= Filter by authority create date
metadata.updatedDate date ==, >, <, <=, >= Filter by authority update date
$xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value $expandAll = true; // Boolean | Whether to return only basic properties or entire authority record.
Basic fields are: - id - tenantId - shared - headingType - authRefType - headingRef - sourceFileId - naturalId - numberOfTitles $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 queries $limit = 56; // Integer | Limit the number of elements returned in the response. try { $result = $api_instance->browseAuthorities($query, $xOkapiTenant, $expandAll, $highlightMatch, $precedingRecordsCount, $limit); 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 = headingRef >= "Comic-Con" or headingRef < "Comic-Con"; # String | A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is `headingRef`.
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
tenantId string == Filter by tenant ID in consortium
shared boolean == Filter by shared/non-shared in consortium
sourceFileId uuid == Filter by authority source file ID. `NULL` value to filter by non-specified.
headingType string == Filter by heading type: `Personal Name`, `Corporate Name`, `Conference Name`, `Geographic Name`, `Uniform Title`, `Topical`, `Genre`
isTitleHeadingRef boolean == Filter title/non-title heading
authRefType boolean == Filter by reference type: `Authorized`, `Reference`, `Auth/Ref`
subjectHeadings char == Filter by subject heading code
metadata.createdDate date ==, >, <, <=, >= Filter by authority create date
metadata.updatedDate date ==, >, <, <=, >= Filter by authority update date
my $xOkapiTenant = xOkapiTenant_example; # String | X-Okapi-Tenant header value my $expandAll = true; # Boolean | Whether to return only basic properties or entire authority record.
Basic fields are: - id - tenantId - shared - headingType - authRefType - headingRef - sourceFileId - naturalId - numberOfTitles 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 queries my $limit = 56; # Integer | Limit the number of elements returned in the response. eval { my $result = $api_instance->browseAuthorities(query => $query, xOkapiTenant => $xOkapiTenant, expandAll => $expandAll, highlightMatch => $highlightMatch, precedingRecordsCount => $precedingRecordsCount, limit => $limit); 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 = headingRef >= "Comic-Con" or headingRef < "Comic-Con" # String | A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is `headingRef`.
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
tenantId string == Filter by tenant ID in consortium
shared boolean == Filter by shared/non-shared in consortium
sourceFileId uuid == Filter by authority source file ID. `NULL` value to filter by non-specified.
headingType string == Filter by heading type: `Personal Name`, `Corporate Name`, `Conference Name`, `Geographic Name`, `Uniform Title`, `Topical`, `Genre`
isTitleHeadingRef boolean == Filter title/non-title heading
authRefType boolean == Filter by reference type: `Authorized`, `Reference`, `Auth/Ref`
subjectHeadings char == Filter by subject heading code
metadata.createdDate date ==, >, <, <=, >= Filter by authority create date
metadata.updatedDate date ==, >, <, <=, >= Filter by authority update date
(default to null) xOkapiTenant = xOkapiTenant_example # String | X-Okapi-Tenant header value (default to null) expandAll = true # Boolean | Whether to return only basic properties or entire authority record.
Basic fields are: - id - tenantId - shared - headingType - authRefType - headingRef - sourceFileId - naturalId - numberOfTitles (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 queries (optional) (default to null) limit = 56 # Integer | Limit the number of elements returned in the response. (optional) (default to 100) try: # Browse Authorities api_response = api_instance.browse_authorities(query, xOkapiTenant, expandAll=expandAll, highlightMatch=highlightMatch, precedingRecordsCount=precedingRecordsCount, limit=limit) pprint(api_response) except ApiException as e: print("Exception when calling BrowseApi->browseAuthorities: %s\n" % e)
extern crate BrowseApi;

pub fn main() {
    let query = headingRef >= "Comic-Con" or headingRef < "Comic-Con"; // String
    let xOkapiTenant = xOkapiTenant_example; // String
    let expandAll = true; // Boolean
    let highlightMatch = true; // Boolean
    let precedingRecordsCount = 56; // Integer
    let limit = 56; // Integer

    let mut context = BrowseApi::Context::default();
    let result = client.browseAuthorities(query, xOkapiTenant, expandAll, highlightMatch, precedingRecordsCount, limit, &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 filter conditions must include anchor query with range conditions. Anchor field is `headingRef`. Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses. Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`. <table> <caption> Supported filter options </caption> <thead> <tr> <th>Option</th> <th>Data type</th> <th>Supported operators</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>tenantId</td> <td>string</td> <td>==</td> <td>Filter by tenant ID in consortium</td> </tr> <tr> <td>shared</td> <td>boolean</td> <td>==</td> <td>Filter by shared/non-shared in consortium</td> </tr> <tr> <td>sourceFileId</td> <td>uuid</td> <td>==</td> <td>Filter by authority source file ID. `NULL` value to filter by non-specified.</td> </tr> <tr> <td>headingType</td> <td>string</td> <td>==</td> <td>Filter by heading type: `Personal Name`, `Corporate Name`, `Conference Name`, `Geographic Name`, `Uniform Title`, `Topical`, `Genre` </td> </tr> <tr> <td>isTitleHeadingRef</td> <td>boolean</td> <td>==</td> <td>Filter title/non-title heading</td> </tr> <tr> <td>authRefType</td> <td>boolean</td> <td>==</td> <td>Filter by reference type: `Authorized`, `Reference`, `Auth/Ref`</td> </tr> <tr> <td>subjectHeadings</td> <td>char</td> <td>==</td> <td>Filter by subject heading code</td> </tr> <tr> <td>metadata.createdDate</td> <td>date</td> <td>==, >, <, <=, >=</td> <td>Filter by authority create date</td> </tr> <tr> <td>metadata.updatedDate</td> <td>date</td> <td>==, >, <, <=, >=</td> <td>Filter by authority update date</td> </tr> </tbody> </table>
Required
expandAll
Boolean
Whether to return only basic properties or entire authority record.<br> Basic fields are: - id - tenantId - shared - headingType - authRefType - headingRef - sourceFileId - naturalId - numberOfTitles
highlightMatch
Boolean
Whether to highlight matched resource by query input or not.
precedingRecordsCount
Integer
Number of preceding records for browsing around and around-including queries
limit
Integer
Limit the number of elements returned in the response.

Responses


browseInstancesByCallNumber

Browse Instance Call Numbers

Provides list of call numbers


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

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://folio-dev-spitfire-okapi.ci.folio.org/browse/call-numbers/{browseOptionId}/instances?query=number >= "DT571.F84" or number < "DT571.F84"&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();
        BrowseOptionType browseOptionId = ; // BrowseOptionType | Browse option type
        String query = number >= "DT571.F84" or number < "DT571.F84"; // String | A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is `fullCallNumber`. 
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
instances.tenantId string == Filter by tenant ID in consortium
instances.shared boolean == Filter by shared/non-shared in consortium
instances.locationId string == Filter by location ID
callNumberTypeId string == Filter by call-number type ID
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 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 queries try { callNumberBrowseResult result = apiInstance.browseInstancesByCallNumber(browseOptionId, query, xOkapiTenant, limit, highlightMatch, precedingRecordsCount); 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 BrowseOptionType browseOptionId = new BrowseOptionType(); // BrowseOptionType | Browse option type
final String query = new String(); // String | A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is `fullCallNumber`. 
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
instances.tenantId string == Filter by tenant ID in consortium
instances.shared boolean == Filter by shared/non-shared in consortium
instances.locationId string == Filter by location ID
callNumberTypeId string == Filter by call-number type ID
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 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 queries try { final result = await api_instance.browseInstancesByCallNumber(browseOptionId, query, xOkapiTenant, limit, highlightMatch, precedingRecordsCount); 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();
        BrowseOptionType browseOptionId = ; // BrowseOptionType | Browse option type
        String query = number >= "DT571.F84" or number < "DT571.F84"; // String | A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is `fullCallNumber`. 
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
instances.tenantId string == Filter by tenant ID in consortium
instances.shared boolean == Filter by shared/non-shared in consortium
instances.locationId string == Filter by location ID
callNumberTypeId string == Filter by call-number type ID
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 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 queries try { callNumberBrowseResult result = apiInstance.browseInstancesByCallNumber(browseOptionId, query, xOkapiTenant, limit, highlightMatch, precedingRecordsCount); 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];
BrowseOptionType *browseOptionId = ; // Browse option type (default to null)
String *query = number >= "DT571.F84" or number < "DT571.F84"; // A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is `fullCallNumber`. 
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
instances.tenantId string == Filter by tenant ID in consortium
instances.shared boolean == Filter by shared/non-shared in consortium
instances.locationId string == Filter by location ID
callNumberTypeId string == Filter by call-number type ID
(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 *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 queries (optional) (default to null) // Browse Instance Call Numbers [apiInstance browseInstancesByCallNumberWith:browseOptionId query:query xOkapiTenant:xOkapiTenant limit:limit highlightMatch:highlightMatch precedingRecordsCount:precedingRecordsCount 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 browseOptionId = ; // {BrowseOptionType} Browse option type
var query = number >= "DT571.F84" or number < "DT571.F84"; // {String} A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is `fullCallNumber`. 
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
instances.tenantId string == Filter by tenant ID in consortium
instances.shared boolean == Filter by shared/non-shared in consortium
instances.locationId string == Filter by location ID
callNumberTypeId string == Filter by call-number type ID
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. '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 queries }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; api.browseInstancesByCallNumber(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 browseInstancesByCallNumberExample
    {
        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 = number >= "DT571.F84" or number < "DT571.F84";  // String | A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is `fullCallNumber`. 
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
instances.tenantId string == Filter by tenant ID in consortium
instances.shared boolean == Filter by shared/non-shared in consortium
instances.locationId string == Filter by location ID
callNumberTypeId string == Filter by call-number type ID
(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 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 queries (optional) (default to null) try { // Browse Instance Call Numbers callNumberBrowseResult result = apiInstance.browseInstancesByCallNumber(browseOptionId, query, xOkapiTenant, limit, highlightMatch, precedingRecordsCount); 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();
$browseOptionId = ; // BrowseOptionType | Browse option type
$query = number >= "DT571.F84" or number < "DT571.F84"; // String | A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is `fullCallNumber`. 
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
instances.tenantId string == Filter by tenant ID in consortium
instances.shared boolean == Filter by shared/non-shared in consortium
instances.locationId string == Filter by location ID
callNumberTypeId string == Filter by call-number type ID
$xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value $limit = 56; // Integer | Limit the number of elements returned in the browse 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 queries try { $result = $api_instance->browseInstancesByCallNumber($browseOptionId, $query, $xOkapiTenant, $limit, $highlightMatch, $precedingRecordsCount); 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 $browseOptionId = ; # BrowseOptionType | Browse option type
my $query = number >= "DT571.F84" or number < "DT571.F84"; # String | A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is `fullCallNumber`. 
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
instances.tenantId string == Filter by tenant ID in consortium
instances.shared boolean == Filter by shared/non-shared in consortium
instances.locationId string == Filter by location ID
callNumberTypeId string == Filter by call-number type ID
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 $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 queries eval { my $result = $api_instance->browseInstancesByCallNumber(browseOptionId => $browseOptionId, query => $query, xOkapiTenant => $xOkapiTenant, limit => $limit, highlightMatch => $highlightMatch, precedingRecordsCount => $precedingRecordsCount); 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()
browseOptionId =  # BrowseOptionType | Browse option type (default to null)
query = number >= "DT571.F84" or number < "DT571.F84" # String | A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is `fullCallNumber`. 
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
instances.tenantId string == Filter by tenant ID in consortium
instances.shared boolean == Filter by shared/non-shared in consortium
instances.locationId string == Filter by location ID
callNumberTypeId string == Filter by call-number type ID
(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) 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 queries (optional) (default to null) try: # Browse Instance Call Numbers api_response = api_instance.browse_instances_by_call_number(browseOptionId, query, xOkapiTenant, limit=limit, highlightMatch=highlightMatch, precedingRecordsCount=precedingRecordsCount) pprint(api_response) except ApiException as e: print("Exception when calling BrowseApi->browseInstancesByCallNumber: %s\n" % e)
extern crate BrowseApi;

pub fn main() {
    let browseOptionId = ; // BrowseOptionType
    let query = number >= "DT571.F84" or number < "DT571.F84"; // 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.browseInstancesByCallNumber(browseOptionId, query, xOkapiTenant, limit, 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 filter conditions must include anchor query with range conditions. Anchor field is `fullCallNumber`. Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses. Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`. <table> <caption> Supported filter options </caption> <thead> <tr> <th>Option</th> <th>Data type</th> <th>Supported operators</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>instances.tenantId</td> <td>string</td> <td>==</td> <td>Filter by tenant ID in consortium</td> </tr> <tr> <td>instances.shared</td> <td>boolean</td> <td>==</td> <td>Filter by shared/non-shared in consortium</td> </tr> <tr> <td>instances.locationId</td> <td>string</td> <td>==</td> <td>Filter by location ID</td> </tr> <tr> <td>callNumberTypeId</td> <td>string</td> <td>==</td> <td>Filter by call-number type ID</td> </tr> </tbody> </table>
Required
limit
Integer
Limit the number of elements returned in the browse 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 queries

Responses


browseInstancesByClassificationNumber

Browse Instance Classifications

Provides list of classification numbers


/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=number >= "DT571.F84" or number < "DT571.F84"&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();
        BrowseOptionType browseOptionId = ; // BrowseOptionType | Browse option type
        String query = number >= "DT571.F84" or number < "DT571.F84"; // String | A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is `number`. 
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
instances.tenantId string == Filter by tenant ID in consortium
instances.shared boolean == Filter by shared/non-shared in consortium
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 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 queries try { classificationNumberBrowseResult result = apiInstance.browseInstancesByClassificationNumber(browseOptionId, query, xOkapiTenant, limit, 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 filter conditions must include anchor query with range conditions. Anchor field is `number`. 
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
instances.tenantId string == Filter by tenant ID in consortium
instances.shared boolean == Filter by shared/non-shared in consortium
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 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 queries try { final result = await api_instance.browseInstancesByClassificationNumber(browseOptionId, query, xOkapiTenant, limit, 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 = number >= "DT571.F84" or number < "DT571.F84"; // String | A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is `number`. 
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
instances.tenantId string == Filter by tenant ID in consortium
instances.shared boolean == Filter by shared/non-shared in consortium
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 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 queries try { classificationNumberBrowseResult result = apiInstance.browseInstancesByClassificationNumber(browseOptionId, query, xOkapiTenant, limit, 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 = number >= "DT571.F84" or number < "DT571.F84"; // A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is `number`. 
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
instances.tenantId string == Filter by tenant ID in consortium
instances.shared boolean == Filter by shared/non-shared in consortium
(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 *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 queries (optional) (default to null) // Browse Instance Classifications [apiInstance browseInstancesByClassificationNumberWith:browseOptionId query:query xOkapiTenant:xOkapiTenant limit:limit 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 = number >= "DT571.F84" or number < "DT571.F84"; // {String} A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is `number`. 
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
instances.tenantId string == Filter by tenant ID in consortium
instances.shared boolean == Filter by shared/non-shared in consortium
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. '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 queries }; 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 = number >= "DT571.F84" or number < "DT571.F84";  // String | A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is `number`. 
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
instances.tenantId string == Filter by tenant ID in consortium
instances.shared boolean == Filter by shared/non-shared in consortium
(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 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 queries (optional) (default to null) try { // Browse Instance Classifications classificationNumberBrowseResult result = apiInstance.browseInstancesByClassificationNumber(browseOptionId, query, xOkapiTenant, limit, 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 = number >= "DT571.F84" or number < "DT571.F84"; // String | A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is `number`. 
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
instances.tenantId string == Filter by tenant ID in consortium
instances.shared boolean == Filter by shared/non-shared in consortium
$xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value $limit = 56; // Integer | Limit the number of elements returned in the browse 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 queries try { $result = $api_instance->browseInstancesByClassificationNumber($browseOptionId, $query, $xOkapiTenant, $limit, $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 = number >= "DT571.F84" or number < "DT571.F84"; # String | A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is `number`. 
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
instances.tenantId string == Filter by tenant ID in consortium
instances.shared boolean == Filter by shared/non-shared in consortium
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 $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 queries eval { my $result = $api_instance->browseInstancesByClassificationNumber(browseOptionId => $browseOptionId, query => $query, xOkapiTenant => $xOkapiTenant, limit => $limit, 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 = number >= "DT571.F84" or number < "DT571.F84" # String | A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is `number`. 
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
instances.tenantId string == Filter by tenant ID in consortium
instances.shared boolean == Filter by shared/non-shared in consortium
(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) 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 queries (optional) (default to null) try: # Browse Instance Classifications api_response = api_instance.browse_instances_by_classification_number(browseOptionId, query, xOkapiTenant, limit=limit, 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 = number >= "DT571.F84" or number < "DT571.F84"; // 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.browseInstancesByClassificationNumber(browseOptionId, query, xOkapiTenant, limit, 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 filter conditions must include anchor query with range conditions. Anchor field is `number`. Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses. Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`. <table> <caption> Supported filter options </caption> <thead> <tr> <th>Option</th> <th>Data type</th> <th>Supported operators</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>instances.tenantId</td> <td>string</td> <td>==</td> <td>Filter by tenant ID in consortium</td> </tr> <tr> <td>instances.shared</td> <td>boolean</td> <td>==</td> <td>Filter by shared/non-shared in consortium</td> </tr> </tbody> </table>
Required
limit
Integer
Limit the number of elements returned in the browse 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 queries

Responses


browseInstancesByContributor

Browse Instance Contributors

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=name >= "Abedi, Ali" or name < "Abedi, Ali"&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 = name >= "Abedi, Ali" or name < "Abedi, Ali"; // String | A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is `name`. 
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
contributorNameTypeId uuid == Filter by contributor name type
instances.tenantId string == Filter by tenant ID in consortium
instances.shared boolean == Filter by shared/non-shared in consortium
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 queries 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 filter conditions must include anchor query with range conditions. Anchor field is `name`. 
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
contributorNameTypeId uuid == Filter by contributor name type
instances.tenantId string == Filter by tenant ID in consortium
instances.shared boolean == Filter by shared/non-shared in consortium
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 queries 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 = name >= "Abedi, Ali" or name < "Abedi, Ali"; // String | A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is `name`. 
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
contributorNameTypeId uuid == Filter by contributor name type
instances.tenantId string == Filter by tenant ID in consortium
instances.shared boolean == Filter by shared/non-shared in consortium
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 queries 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 = name >= "Abedi, Ali" or name < "Abedi, Ali"; // A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is `name`. 
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
contributorNameTypeId uuid == Filter by contributor name type
instances.tenantId string == Filter by tenant ID in consortium
instances.shared boolean == Filter by shared/non-shared in consortium
(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 queries (optional) (default to null) // Browse Instance Contributors [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 = name >= "Abedi, Ali" or name < "Abedi, Ali"; // {String} A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is `name`. 
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
contributorNameTypeId uuid == Filter by contributor name type
instances.tenantId string == Filter by tenant ID in consortium
instances.shared boolean == Filter by shared/non-shared in consortium
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 queries }; 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 = name >= "Abedi, Ali" or name < "Abedi, Ali";  // String | A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is `name`. 
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
contributorNameTypeId uuid == Filter by contributor name type
instances.tenantId string == Filter by tenant ID in consortium
instances.shared boolean == Filter by shared/non-shared in consortium
(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 queries (optional) (default to null) try { // Browse Instance Contributors 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 = name >= "Abedi, Ali" or name < "Abedi, Ali"; // String | A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is `name`. 
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
contributorNameTypeId uuid == Filter by contributor name type
instances.tenantId string == Filter by tenant ID in consortium
instances.shared boolean == Filter by shared/non-shared in consortium
$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 queries 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 = name >= "Abedi, Ali" or name < "Abedi, Ali"; # String | A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is `name`. 
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
contributorNameTypeId uuid == Filter by contributor name type
instances.tenantId string == Filter by tenant ID in consortium
instances.shared boolean == Filter by shared/non-shared in consortium
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 queries 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 = name >= "Abedi, Ali" or name < "Abedi, Ali" # String | A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is `name`. 
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
contributorNameTypeId uuid == Filter by contributor name type
instances.tenantId string == Filter by tenant ID in consortium
instances.shared boolean == Filter by shared/non-shared in consortium
(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 queries (optional) (default to null) try: # Browse Instance Contributors 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 = name >= "Abedi, Ali" or name < "Abedi, Ali"; // 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 filter conditions must include anchor query with range conditions. Anchor field is `name`. Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses. Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`. <table> <caption> Supported filter options </caption> <thead> <tr> <th>Option</th> <th>Data type</th> <th>Supported operators</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>contributorNameTypeId</td> <td>uuid</td> <td>==</td> <td>Filter by contributor name type</td> </tr> <tr> <td>instances.tenantId</td> <td>string</td> <td>==</td> <td>Filter by tenant ID in consortium</td> </tr> <tr> <td>instances.shared</td> <td>boolean</td> <td>==</td> <td>Filter by shared/non-shared in consortium</td> </tr> </tbody> </table>
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 queries

Responses


browseInstancesBySubject

Browse Instance Subjects

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=value >= "Fantasy" or value < "Fantasy"&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 = value >= "Fantasy" or value < "Fantasy"; // String | A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is `value`. 
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
typeId uuid == Filter by subject type
sourceId uuid == Filter by subject source
instances.tenantId string == Filter by tenant ID in consortium
instances.shared boolean == Filter by shared/non-shared in consortium
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 queries 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 filter conditions must include anchor query with range conditions. Anchor field is `value`. 
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
typeId uuid == Filter by subject type
sourceId uuid == Filter by subject source
instances.tenantId string == Filter by tenant ID in consortium
instances.shared boolean == Filter by shared/non-shared in consortium
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 queries 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 = value >= "Fantasy" or value < "Fantasy"; // String | A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is `value`. 
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
typeId uuid == Filter by subject type
sourceId uuid == Filter by subject source
instances.tenantId string == Filter by tenant ID in consortium
instances.shared boolean == Filter by shared/non-shared in consortium
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 queries 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 = value >= "Fantasy" or value < "Fantasy"; // A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is `value`. 
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
typeId uuid == Filter by subject type
sourceId uuid == Filter by subject source
instances.tenantId string == Filter by tenant ID in consortium
instances.shared boolean == Filter by shared/non-shared in consortium
(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 queries (optional) (default to null) // Browse Instance Subjects [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 = value >= "Fantasy" or value < "Fantasy"; // {String} A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is `value`. 
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
typeId uuid == Filter by subject type
sourceId uuid == Filter by subject source
instances.tenantId string == Filter by tenant ID in consortium
instances.shared boolean == Filter by shared/non-shared in consortium
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 queries }; 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 = value >= "Fantasy" or value < "Fantasy";  // String | A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is `value`. 
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
typeId uuid == Filter by subject type
sourceId uuid == Filter by subject source
instances.tenantId string == Filter by tenant ID in consortium
instances.shared boolean == Filter by shared/non-shared in consortium
(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 queries (optional) (default to null) try { // Browse Instance Subjects 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 = value >= "Fantasy" or value < "Fantasy"; // String | A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is `value`. 
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
typeId uuid == Filter by subject type
sourceId uuid == Filter by subject source
instances.tenantId string == Filter by tenant ID in consortium
instances.shared boolean == Filter by shared/non-shared in consortium
$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 queries 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 = value >= "Fantasy" or value < "Fantasy"; # String | A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is `value`. 
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
typeId uuid == Filter by subject type
sourceId uuid == Filter by subject source
instances.tenantId string == Filter by tenant ID in consortium
instances.shared boolean == Filter by shared/non-shared in consortium
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 queries 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 = value >= "Fantasy" or value < "Fantasy" # String | A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is `value`. 
Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses.
Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`.
Supported filter options
Option Data type Supported operators Description
typeId uuid == Filter by subject type
sourceId uuid == Filter by subject source
instances.tenantId string == Filter by tenant ID in consortium
instances.shared boolean == Filter by shared/non-shared in consortium
(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 queries (optional) (default to null) try: # Browse Instance Subjects 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 = value >= "Fantasy" or value < "Fantasy"; // 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 filter conditions must include anchor query with range conditions. Anchor field is `value`. Filters support logic operators `AND` and `OR`. All filters should be combined in parentheses. Anchor will be included only if `<=` or `>=` are used in the query. Otherwise, the empty row will be added if `highlightMatch` is equal to `true`. <table> <caption> Supported filter options </caption> <thead> <tr> <th>Option</th> <th>Data type</th> <th>Supported operators</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>typeId</td> <td>uuid</td> <td>==</td> <td>Filter by subject type</td> </tr> <tr> <td>sourceId</td> <td>uuid</td> <td>==</td> <td>Filter by subject source</td> </tr> <tr> <td>instances.tenantId</td> <td>string</td> <td>==</td> <td>Filter by tenant ID in consortium</td> </tr> <tr> <td>instances.shared</td> <td>boolean</td> <td>==</td> <td>Filter by shared/non-shared in consortium</td> </tr> </tbody> </table>
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 queries

Responses


Config

createLanguageConfig

Create Language Configuration

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 = {code=eng, languageAnalyzer=eng-analyzer}; // 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 = {code=eng, languageAnalyzer=eng-analyzer}; // 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 = {code=eng, languageAnalyzer=eng-analyzer}; //  (optional)

// Create Language Configuration
[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': {code=eng, languageAnalyzer=eng-analyzer} // {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 {
                // Create Language Configuration
                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 = {code=eng, languageAnalyzer=eng-analyzer}; // 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 = {code=eng, languageAnalyzer=eng-analyzer} # LanguageConfig |  (optional)

try:
    # Create Language Configuration
    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 = {code=eng, languageAnalyzer=eng-analyzer}; // 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

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)

// Delete Feature Configuration
[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 {
                // Delete Feature Configuration
                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:
    # Delete Feature Configuration
    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 Language Configuration

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)

// Delete Language Configuration
[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 {
                // Delete Language Configuration
                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:
    # Delete Language Configuration
    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 Feature Configurations

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];

// Get Feature Configurations
[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 {
                // Get Feature Configurations
                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:
    # Get Feature Configurations
    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 Language Configurations

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];

// Get Language Configurations
[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 {
                // Get Language Configurations
                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:
    # Get Language Configurations
    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 Browse Configurations

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)

// Get Browse Configurations
[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 {
                // Get Browse Configurations
                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:
    # Get Browse Configurations
    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 Browse Configurations

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 = ; // 

// Update Browse Configurations
[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 {
                // Update Browse Configurations
                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:
    # Update Browse Configurations
    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

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)

// Save Feature Configuration
[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 {
                // Save Feature Configuration
                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:
    # Save Feature Configuration
    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

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)

// Update Feature Configuration
[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 {
                // Update Feature Configuration
                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:
    # Update Feature Configuration
    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 Configuration

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 = {code=eng, languageAnalyzer=eng-analyzer}; // 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 = {code=eng, languageAnalyzer=eng-analyzer}; // 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 = {code=eng, languageAnalyzer=eng-analyzer}; //  (optional)

// Update Language Configuration
[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': {code=eng, languageAnalyzer=eng-analyzer} // {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 {
                // Update Language Configuration
                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 = {code=eng, languageAnalyzer=eng-analyzer}; // 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 = {code=eng, languageAnalyzer=eng-analyzer} # LanguageConfig |  (optional)

try:
    # Update Language Configuration
    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 = {code=eng, languageAnalyzer=eng-analyzer}; // 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

Get Facets

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 | Type of record to get facets for.
        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 | Type of record to get facets for.
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 | Type of record to get facets for.
        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 = ; // Type of record to get facets for. (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)

// Get Facets
[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} Type of record to get facets for.
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 | Type of record to get facets for. (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 {
                // Get Facets
                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 | Type of record to get facets for.
$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 | Type of record to get facets for.
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 | Type of record to get facets for. (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:
    # Get Facets
    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
Type of record to get facets for.
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

Create Index

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 = ; // 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 = ; // 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 = ; //  (optional)

// Create Index
[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':  // {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 {
                // Create Index
                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 = ; // 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 =  # CreateIndexRequest |  (optional)

try:
    # Create Index
    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 = ; // 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


getReindexStatus

Get Reindex Status

Get a list of statuses for each resource reindexing


/search/index/instance-records/reindex/status

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://folio-dev-spitfire-okapi.ci.folio.org/search/index/instance-records/reindex/status"
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

        try {
            array[reindexStatusItem] result = apiInstance.getReindexStatus(xOkapiTenant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IndexManagementApi#getReindexStatus");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

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

try {
    final result = await api_instance.getReindexStatus(xOkapiTenant);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getReindexStatus: $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

        try {
            array[reindexStatusItem] result = apiInstance.getReindexStatus(xOkapiTenant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IndexManagementApi#getReindexStatus");
            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)

// Get Reindex Status
[apiInstance getReindexStatusWith:xOkapiTenant
              completionHandler: ^(array[reindexStatusItem] 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 callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getReindexStatus(xOkapiTenant, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getReindexStatusExample
    {
        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)

            try {
                // Get Reindex Status
                array[reindexStatusItem] result = apiInstance.getReindexStatus(xOkapiTenant);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling IndexManagementApi.getReindexStatus: " + 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

try {
    $result = $api_instance->getReindexStatus($xOkapiTenant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IndexManagementApi->getReindexStatus: ', $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

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

try:
    # Get Reindex Status
    api_response = api_instance.get_reindex_status(xOkapiTenant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IndexManagementApi->getReindexStatus: %s\n" % e)
extern crate IndexManagementApi;

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

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

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

Scopes

Parameters

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

Responses


indexRecords

Index Records

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 '{
  "deleteEventSubType" : "SOFT_DELETE",
  "new" : "{}",
  "old" : "{}",
  "resourceName" : "resourceName",
  "id" : "id",
  "type" : "UPDATE",
  "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 = ; // 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 = ; // 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 = ; //  (optional)

// Index Records
[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':  // {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 {
                // Index Records
                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 = ; // 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 =  # array[resourceEvent] |  (optional)

try:
    # Index Records
    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 = ; // 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


reindexFailedMergeRanges

Failed Merge Ranges Re-Index

Initiates reindexing of failed merge ranges for inventory instance records


/search/index/instance-records/reindex/merge/failed

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 "https://folio-dev-spitfire-okapi.ci.folio.org/search/index/instance-records/reindex/merge/failed"
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

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

final api_instance = DefaultApi();

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

try {
    final result = await api_instance.reindexFailedMergeRanges(xOkapiTenant);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->reindexFailedMergeRanges: $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

        try {
            apiInstance.reindexFailedMergeRanges(xOkapiTenant);
        } catch (ApiException e) {
            System.err.println("Exception when calling IndexManagementApi#reindexFailedMergeRanges");
            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)

// Failed Merge Ranges Re-Index
[apiInstance reindexFailedMergeRangesWith:xOkapiTenant
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var SearchApi = require('search_api');

// Create an instance of the API class
var api = new SearchApi.IndexManagementApi()
var xOkapiTenant = xOkapiTenant_example; // {String} X-Okapi-Tenant header value

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

namespace Example
{
    public class reindexFailedMergeRangesExample
    {
        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)

            try {
                // Failed Merge Ranges Re-Index
                apiInstance.reindexFailedMergeRanges(xOkapiTenant);
            } catch (Exception e) {
                Debug.Print("Exception when calling IndexManagementApi.reindexFailedMergeRanges: " + 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

try {
    $api_instance->reindexFailedMergeRanges($xOkapiTenant);
} catch (Exception $e) {
    echo 'Exception when calling IndexManagementApi->reindexFailedMergeRanges: ', $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

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

try:
    # Failed Merge Ranges Re-Index
    api_instance.reindex_failed_merge_ranges(xOkapiTenant)
except ApiException as e:
    print("Exception when calling IndexManagementApi->reindexFailedMergeRanges: %s\n" % e)
extern crate IndexManagementApi;

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

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

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

Scopes

Parameters

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

Responses


reindexInstanceRecords

Re-Index

Initiates the full reindex for the inventory instance records


/search/index/instance-records/reindex/full

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/instance-records/reindex/full" \
 -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
        IndexSettings indexSettings = ; // IndexSettings | 

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

final api_instance = DefaultApi();

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

try {
    final result = await api_instance.reindexInstanceRecords(xOkapiTenant, indexSettings);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->reindexInstanceRecords: $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
        IndexSettings indexSettings = ; // IndexSettings | 

        try {
            apiInstance.reindexInstanceRecords(xOkapiTenant, indexSettings);
        } catch (ApiException e) {
            System.err.println("Exception when calling IndexManagementApi#reindexInstanceRecords");
            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)
IndexSettings *indexSettings = ; //  (optional)

// Re-Index
[apiInstance reindexInstanceRecordsWith:xOkapiTenant
    indexSettings:indexSettings
              completionHandler: ^(NSError* error) {
    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 = {
  'indexSettings':  // {IndexSettings} 
};

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

namespace Example
{
    public class reindexInstanceRecordsExample
    {
        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 indexSettings = new IndexSettings(); // IndexSettings |  (optional) 

            try {
                // Re-Index
                apiInstance.reindexInstanceRecords(xOkapiTenant, indexSettings);
            } catch (Exception e) {
                Debug.Print("Exception when calling IndexManagementApi.reindexInstanceRecords: " + 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
$indexSettings = ; // IndexSettings | 

try {
    $api_instance->reindexInstanceRecords($xOkapiTenant, $indexSettings);
} catch (Exception $e) {
    echo 'Exception when calling IndexManagementApi->reindexInstanceRecords: ', $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 $indexSettings = WWW::OPenAPIClient::Object::IndexSettings->new(); # IndexSettings | 

eval {
    $api_instance->reindexInstanceRecords(xOkapiTenant => $xOkapiTenant, indexSettings => $indexSettings);
};
if ($@) {
    warn "Exception when calling IndexManagementApi->reindexInstanceRecords: $@\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)
indexSettings =  # IndexSettings |  (optional)

try:
    # Re-Index
    api_instance.reindex_instance_records(xOkapiTenant, indexSettings=indexSettings)
except ApiException as e:
    print("Exception when calling IndexManagementApi->reindexInstanceRecords: %s\n" % e)
extern crate IndexManagementApi;

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

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

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

Scopes

Parameters

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

Responses


reindexInventoryRecords

Re-Index

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 = ; // 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 = ; // 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 = ; // 

// Re-Index
[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 reindexRequest = ; // {ReindexRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.reindexInventoryRecords(xOkapiTenant, reindexRequest, 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 | 

            try {
                // Re-Index
                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 = ; // 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 =  # ReindexRequest | 

try:
    # Re-Index
    api_response = api_instance.reindex_inventory_records(xOkapiTenant, 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 = ; // 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


reindexUploadInstanceRecords

Upload Re-Index

Initiates reindex upload for inventory instance records


/search/index/instance-records/reindex/upload

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/instance-records/reindex/upload" \
 -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
        ReindexUploadDto reindexUploadDto = ; // ReindexUploadDto | 

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

final api_instance = DefaultApi();

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

try {
    final result = await api_instance.reindexUploadInstanceRecords(xOkapiTenant, reindexUploadDto);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->reindexUploadInstanceRecords: $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
        ReindexUploadDto reindexUploadDto = ; // ReindexUploadDto | 

        try {
            apiInstance.reindexUploadInstanceRecords(xOkapiTenant, reindexUploadDto);
        } catch (ApiException e) {
            System.err.println("Exception when calling IndexManagementApi#reindexUploadInstanceRecords");
            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)
ReindexUploadDto *reindexUploadDto = ; //  (optional)

// Upload Re-Index
[apiInstance reindexUploadInstanceRecordsWith:xOkapiTenant
    reindexUploadDto:reindexUploadDto
              completionHandler: ^(NSError* error) {
    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 = {
  'reindexUploadDto':  // {ReindexUploadDto} 
};

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

namespace Example
{
    public class reindexUploadInstanceRecordsExample
    {
        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 reindexUploadDto = new ReindexUploadDto(); // ReindexUploadDto |  (optional) 

            try {
                // Upload Re-Index
                apiInstance.reindexUploadInstanceRecords(xOkapiTenant, reindexUploadDto);
            } catch (Exception e) {
                Debug.Print("Exception when calling IndexManagementApi.reindexUploadInstanceRecords: " + 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
$reindexUploadDto = ; // ReindexUploadDto | 

try {
    $api_instance->reindexUploadInstanceRecords($xOkapiTenant, $reindexUploadDto);
} catch (Exception $e) {
    echo 'Exception when calling IndexManagementApi->reindexUploadInstanceRecords: ', $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 $reindexUploadDto = WWW::OPenAPIClient::Object::ReindexUploadDto->new(); # ReindexUploadDto | 

eval {
    $api_instance->reindexUploadInstanceRecords(xOkapiTenant => $xOkapiTenant, reindexUploadDto => $reindexUploadDto);
};
if ($@) {
    warn "Exception when calling IndexManagementApi->reindexUploadInstanceRecords: $@\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)
reindexUploadDto =  # ReindexUploadDto |  (optional)

try:
    # Upload Re-Index
    api_instance.reindex_upload_instance_records(xOkapiTenant, reindexUploadDto=reindexUploadDto)
except ApiException as e:
    print("Exception when calling IndexManagementApi->reindexUploadInstanceRecords: %s\n" % e)
extern crate IndexManagementApi;

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

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

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

Scopes

Parameters

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

Responses


updateIndexDynamicSettings

Update Index Settings

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)

// Update Index Settings
[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 {
                // Update Index Settings
                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:
    # Update Index Settings
    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

Create Index Mappings

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)

// Create Index Mappings
[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 {
                // Create Index Mappings
                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:
    # Create Index Mappings
    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

fetchConsortiumBatchHoldings

Fetch Consolidated Holdings

Fetch a list of holdings (only for consortium environment)


/search/consortium/batch/holdings

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/consortium/batch/holdings" \
 -d ''
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
        BatchIdsDto batchIdsDto = ; // BatchIdsDto | 

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

final api_instance = DefaultApi();

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

try {
    final result = await api_instance.fetchConsortiumBatchHoldings(xOkapiTenant, batchIdsDto);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->fetchConsortiumBatchHoldings: $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
        BatchIdsDto batchIdsDto = ; // BatchIdsDto | 

        try {
            consortiumHoldingCollection result = apiInstance.fetchConsortiumBatchHoldings(xOkapiTenant, batchIdsDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchConsortiumApi#fetchConsortiumBatchHoldings");
            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)
BatchIdsDto *batchIdsDto = ; //  (optional)

// Fetch Consolidated Holdings
[apiInstance fetchConsortiumBatchHoldingsWith:xOkapiTenant
    batchIdsDto:batchIdsDto
              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 = {
  'batchIdsDto':  // {BatchIdsDto} 
};

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

namespace Example
{
    public class fetchConsortiumBatchHoldingsExample
    {
        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 batchIdsDto = new BatchIdsDto(); // BatchIdsDto |  (optional) 

            try {
                // Fetch Consolidated Holdings
                consortiumHoldingCollection result = apiInstance.fetchConsortiumBatchHoldings(xOkapiTenant, batchIdsDto);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SearchConsortiumApi.fetchConsortiumBatchHoldings: " + 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
$batchIdsDto = ; // BatchIdsDto | 

try {
    $result = $api_instance->fetchConsortiumBatchHoldings($xOkapiTenant, $batchIdsDto);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SearchConsortiumApi->fetchConsortiumBatchHoldings: ', $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 $batchIdsDto = WWW::OPenAPIClient::Object::BatchIdsDto->new(); # BatchIdsDto | 

eval {
    my $result = $api_instance->fetchConsortiumBatchHoldings(xOkapiTenant => $xOkapiTenant, batchIdsDto => $batchIdsDto);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SearchConsortiumApi->fetchConsortiumBatchHoldings: $@\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)
batchIdsDto =  # BatchIdsDto |  (optional)

try:
    # Fetch Consolidated Holdings
    api_response = api_instance.fetch_consortium_batch_holdings(xOkapiTenant, batchIdsDto=batchIdsDto)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SearchConsortiumApi->fetchConsortiumBatchHoldings: %s\n" % e)
extern crate SearchConsortiumApi;

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

    let mut context = SearchConsortiumApi::Context::default();
    let result = client.fetchConsortiumBatchHoldings(xOkapiTenant, batchIdsDto, &context).wait();

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

Scopes

Parameters

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

Responses


fetchConsortiumBatchItems

Fetch Consolidated Items

Fetch a list of items (only for consortium environment)


/search/consortium/batch/items

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/consortium/batch/items" \
 -d ''
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
        BatchIdsDto batchIdsDto = ; // BatchIdsDto | 

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

final api_instance = DefaultApi();

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

try {
    final result = await api_instance.fetchConsortiumBatchItems(xOkapiTenant, batchIdsDto);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->fetchConsortiumBatchItems: $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
        BatchIdsDto batchIdsDto = ; // BatchIdsDto | 

        try {
            consortiumItemCollection result = apiInstance.fetchConsortiumBatchItems(xOkapiTenant, batchIdsDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchConsortiumApi#fetchConsortiumBatchItems");
            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)
BatchIdsDto *batchIdsDto = ; //  (optional)

// Fetch Consolidated Items
[apiInstance fetchConsortiumBatchItemsWith:xOkapiTenant
    batchIdsDto:batchIdsDto
              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 = {
  'batchIdsDto':  // {BatchIdsDto} 
};

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

namespace Example
{
    public class fetchConsortiumBatchItemsExample
    {
        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 batchIdsDto = new BatchIdsDto(); // BatchIdsDto |  (optional) 

            try {
                // Fetch Consolidated Items
                consortiumItemCollection result = apiInstance.fetchConsortiumBatchItems(xOkapiTenant, batchIdsDto);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SearchConsortiumApi.fetchConsortiumBatchItems: " + 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
$batchIdsDto = ; // BatchIdsDto | 

try {
    $result = $api_instance->fetchConsortiumBatchItems($xOkapiTenant, $batchIdsDto);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SearchConsortiumApi->fetchConsortiumBatchItems: ', $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 $batchIdsDto = WWW::OPenAPIClient::Object::BatchIdsDto->new(); # BatchIdsDto | 

eval {
    my $result = $api_instance->fetchConsortiumBatchItems(xOkapiTenant => $xOkapiTenant, batchIdsDto => $batchIdsDto);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SearchConsortiumApi->fetchConsortiumBatchItems: $@\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)
batchIdsDto =  # BatchIdsDto |  (optional)

try:
    # Fetch Consolidated Items
    api_response = api_instance.fetch_consortium_batch_items(xOkapiTenant, batchIdsDto=batchIdsDto)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SearchConsortiumApi->fetchConsortiumBatchItems: %s\n" % e)
extern crate SearchConsortiumApi;

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

    let mut context = SearchConsortiumApi::Context::default();
    let result = client.fetchConsortiumBatchItems(xOkapiTenant, batchIdsDto, &context).wait();

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

Scopes

Parameters

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

Responses


getConsortiumCampuses

Get Consortium Campuses

Get a list of campuses (only for consortium environment)


/search/consortium/campuses

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://folio-dev-spitfire-okapi.ci.folio.org/search/consortium/campuses?tenantId=tenantId_example&id=id_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 tenantId = tenantId_example; // String | Tenant ID to filter by
        String id = id_example; // String | ID to filter by
        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
  - tenantId
  - institutionId
  - name

        SortOrder sortOrder = ; // SortOrder | Defines sorting order

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

final api_instance = DefaultApi();

final String xOkapiTenant = new String(); // String | X-Okapi-Tenant header value
final String tenantId = new String(); // String | Tenant ID to filter by
final String id = new String(); // String | ID to filter by
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
  - tenantId
  - institutionId
  - name

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

try {
    final result = await api_instance.getConsortiumCampuses(xOkapiTenant, tenantId, id, limit, offset, sortBy, sortOrder);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getConsortiumCampuses: $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 tenantId = tenantId_example; // String | Tenant ID to filter by
        String id = id_example; // String | ID to filter by
        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
  - tenantId
  - institutionId
  - name

        SortOrder sortOrder = ; // SortOrder | Defines sorting order

        try {
            consortiumCampusCollection result = apiInstance.getConsortiumCampuses(xOkapiTenant, tenantId, id, limit, offset, sortBy, sortOrder);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchConsortiumApi#getConsortiumCampuses");
            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 *tenantId = tenantId_example; // Tenant ID to filter by (optional) (default to null)
String *id = id_example; // ID to filter by (optional) (default to null)
Integer *limit = 56; // Limit the number of elements returned in the response. (optional) (default to 1000)
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
  - tenantId
  - institutionId
  - name
 (optional) (default to name)
SortOrder *sortOrder = ; // Defines sorting order (optional) (default to null)

// Get Consortium Campuses
[apiInstance getConsortiumCampusesWith:xOkapiTenant
    tenantId:tenantId
    id:id
    limit:limit
    offset:offset
    sortBy:sortBy
    sortOrder:sortOrder
              completionHandler: ^(consortiumCampusCollection 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 = {
  'tenantId': tenantId_example, // {String} Tenant ID to filter by
  'id': id_example, // {String} ID to filter by
  '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
  - tenantId
  - institutionId
  - name

  '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.getConsortiumCampuses(xOkapiTenant, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getConsortiumCampusesExample
    {
        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 tenantId = tenantId_example;  // String | Tenant ID to filter by (optional)  (default to null)
            var id = id_example;  // String | ID to filter by (optional)  (default to null)
            var limit = 56;  // Integer | Limit the number of elements returned in the response. (optional)  (default to 1000)
            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
  - tenantId
  - institutionId
  - name
 (optional)  (default to name)
            var sortOrder = new SortOrder(); // SortOrder | Defines sorting order (optional)  (default to null)

            try {
                // Get Consortium Campuses
                consortiumCampusCollection result = apiInstance.getConsortiumCampuses(xOkapiTenant, tenantId, id, limit, offset, sortBy, sortOrder);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SearchConsortiumApi.getConsortiumCampuses: " + 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
$tenantId = tenantId_example; // String | Tenant ID to filter by
$id = id_example; // String | ID to filter by
$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
  - tenantId
  - institutionId
  - name

$sortOrder = ; // SortOrder | Defines sorting order

try {
    $result = $api_instance->getConsortiumCampuses($xOkapiTenant, $tenantId, $id, $limit, $offset, $sortBy, $sortOrder);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SearchConsortiumApi->getConsortiumCampuses: ', $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 $tenantId = tenantId_example; # String | Tenant ID to filter by
my $id = id_example; # String | ID to filter by
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
  - tenantId
  - institutionId
  - name

my $sortOrder = ; # SortOrder | Defines sorting order

eval {
    my $result = $api_instance->getConsortiumCampuses(xOkapiTenant => $xOkapiTenant, tenantId => $tenantId, id => $id, limit => $limit, offset => $offset, sortBy => $sortBy, sortOrder => $sortOrder);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SearchConsortiumApi->getConsortiumCampuses: $@\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)
tenantId = tenantId_example # String | Tenant ID to filter by (optional) (default to null)
id = id_example # String | ID to filter by (optional) (default to null)
limit = 56 # Integer | Limit the number of elements returned in the response. (optional) (default to 1000)
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
  - tenantId
  - institutionId
  - name
 (optional) (default to name)
sortOrder =  # SortOrder | Defines sorting order (optional) (default to null)

try:
    # Get Consortium Campuses
    api_response = api_instance.get_consortium_campuses(xOkapiTenant, tenantId=tenantId, id=id, limit=limit, offset=offset, sortBy=sortBy, sortOrder=sortOrder)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SearchConsortiumApi->getConsortiumCampuses: %s\n" % e)
extern crate SearchConsortiumApi;

pub fn main() {
    let xOkapiTenant = xOkapiTenant_example; // String
    let tenantId = tenantId_example; // String
    let id = id_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.getConsortiumCampuses(xOkapiTenant, tenantId, id, 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
tenantId
String
Tenant ID to filter by
id
String
ID to filter by
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 - tenantId - institutionId - name
sortOrder
SortOrder
Defines sorting order

Responses


getConsortiumHolding

Fetch consolidated holding by id

Get holding by id (only for consortium environment)


/search/consortium/holding/{id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://folio-dev-spitfire-okapi.ci.folio.org/search/consortium/holding/{id}"
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();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The UUID of a record
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value

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

final api_instance = DefaultApi();

final UUID id = new UUID(); // UUID | The UUID of a record
final String xOkapiTenant = new String(); // String | X-Okapi-Tenant header value

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

import org.openapitools.client.api.SearchConsortiumApi;

public class SearchConsortiumApiExample {
    public static void main(String[] args) {
        SearchConsortiumApi apiInstance = new SearchConsortiumApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The UUID of a record
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value

        try {
            consortiumHolding result = apiInstance.getConsortiumHolding(id, xOkapiTenant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchConsortiumApi#getConsortiumHolding");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SearchConsortiumApi *apiInstance = [[SearchConsortiumApi alloc] init];
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The UUID of a record (default to null)
String *xOkapiTenant = xOkapiTenant_example; // X-Okapi-Tenant header value (default to null)

// Fetch consolidated holding by id
[apiInstance getConsortiumHoldingWith:id
    xOkapiTenant:xOkapiTenant
              completionHandler: ^(consortiumHolding 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 id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The UUID of a record
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.getConsortiumHolding(id, xOkapiTenant, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new SearchConsortiumApi();
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The UUID of a record (default to null)
            var xOkapiTenant = xOkapiTenant_example;  // String | X-Okapi-Tenant header value (default to null)

            try {
                // Fetch consolidated holding by id
                consortiumHolding result = apiInstance.getConsortiumHolding(id, xOkapiTenant);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SearchConsortiumApi.getConsortiumHolding: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SearchConsortiumApi();
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The UUID of a record
$xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value

try {
    $result = $api_instance->getConsortiumHolding($id, $xOkapiTenant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SearchConsortiumApi->getConsortiumHolding: ', $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 $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The UUID of a record
my $xOkapiTenant = xOkapiTenant_example; # String | X-Okapi-Tenant header value

eval {
    my $result = $api_instance->getConsortiumHolding(id => $id, xOkapiTenant => $xOkapiTenant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SearchConsortiumApi->getConsortiumHolding: $@\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()
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The UUID of a record (default to null)
xOkapiTenant = xOkapiTenant_example # String | X-Okapi-Tenant header value (default to null)

try:
    # Fetch consolidated holding by id
    api_response = api_instance.get_consortium_holding(id, xOkapiTenant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SearchConsortiumApi->getConsortiumHolding: %s\n" % e)
extern crate SearchConsortiumApi;

pub fn main() {
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let xOkapiTenant = xOkapiTenant_example; // String

    let mut context = SearchConsortiumApi::Context::default();
    let result = client.getConsortiumHolding(id, xOkapiTenant, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
The UUID of a record
Required
Header parameters
Name Description
x-okapi-tenant*
String
X-Okapi-Tenant header value
Required

Responses


getConsortiumHoldings

Get Consolidated Holdings

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 to filter by
        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
  - 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 to filter by
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
  - 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 to filter by
        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
  - 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 to filter by (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
  - copyNumber
  - permanentLocationId
 (optional) (default to null)
SortOrder *sortOrder = ; // Defines sorting order (optional) (default to null)

// Get Consolidated Holdings
[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 to filter by
  '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
  - 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 to filter by (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
  - copyNumber
  - permanentLocationId
 (optional)  (default to null)
            var sortOrder = new SortOrder(); // SortOrder | Defines sorting order (optional)  (default to null)

            try {
                // Get Consolidated Holdings
                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 to filter by
$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
  - 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 to filter by
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
  - 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 to filter by (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
  - copyNumber
  - permanentLocationId
 (optional) (default to null)
sortOrder =  # SortOrder | Defines sorting order (optional) (default to null)

try:
    # Get Consolidated Holdings
    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 to filter by
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 - copyNumber - permanentLocationId
sortOrder
SortOrder
Defines sorting order

Responses


getConsortiumInstitutions

Get Consortium Institutions

Get a list of institutions (only for consortium environment)


/search/consortium/institutions

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://folio-dev-spitfire-okapi.ci.folio.org/search/consortium/institutions?tenantId=tenantId_example&id=id_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 tenantId = tenantId_example; // String | Tenant ID to filter by
        String id = id_example; // String | ID to filter by
        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
  - tenantId
  - name

        SortOrder sortOrder = ; // SortOrder | Defines sorting order

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

final api_instance = DefaultApi();

final String xOkapiTenant = new String(); // String | X-Okapi-Tenant header value
final String tenantId = new String(); // String | Tenant ID to filter by
final String id = new String(); // String | ID to filter by
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
  - tenantId
  - name

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

try {
    final result = await api_instance.getConsortiumInstitutions(xOkapiTenant, tenantId, id, limit, offset, sortBy, sortOrder);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getConsortiumInstitutions: $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 tenantId = tenantId_example; // String | Tenant ID to filter by
        String id = id_example; // String | ID to filter by
        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
  - tenantId
  - name

        SortOrder sortOrder = ; // SortOrder | Defines sorting order

        try {
            consortiumInstitutionCollection result = apiInstance.getConsortiumInstitutions(xOkapiTenant, tenantId, id, limit, offset, sortBy, sortOrder);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchConsortiumApi#getConsortiumInstitutions");
            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 *tenantId = tenantId_example; // Tenant ID to filter by (optional) (default to null)
String *id = id_example; // ID to filter by (optional) (default to null)
Integer *limit = 56; // Limit the number of elements returned in the response. (optional) (default to 1000)
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
  - tenantId
  - name
 (optional) (default to name)
SortOrder *sortOrder = ; // Defines sorting order (optional) (default to null)

// Get Consortium Institutions
[apiInstance getConsortiumInstitutionsWith:xOkapiTenant
    tenantId:tenantId
    id:id
    limit:limit
    offset:offset
    sortBy:sortBy
    sortOrder:sortOrder
              completionHandler: ^(consortiumInstitutionCollection 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 = {
  'tenantId': tenantId_example, // {String} Tenant ID to filter by
  'id': id_example, // {String} ID to filter by
  '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
  - tenantId
  - name

  '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.getConsortiumInstitutions(xOkapiTenant, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getConsortiumInstitutionsExample
    {
        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 tenantId = tenantId_example;  // String | Tenant ID to filter by (optional)  (default to null)
            var id = id_example;  // String | ID to filter by (optional)  (default to null)
            var limit = 56;  // Integer | Limit the number of elements returned in the response. (optional)  (default to 1000)
            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
  - tenantId
  - name
 (optional)  (default to name)
            var sortOrder = new SortOrder(); // SortOrder | Defines sorting order (optional)  (default to null)

            try {
                // Get Consortium Institutions
                consortiumInstitutionCollection result = apiInstance.getConsortiumInstitutions(xOkapiTenant, tenantId, id, limit, offset, sortBy, sortOrder);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SearchConsortiumApi.getConsortiumInstitutions: " + 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
$tenantId = tenantId_example; // String | Tenant ID to filter by
$id = id_example; // String | ID to filter by
$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
  - tenantId
  - name

$sortOrder = ; // SortOrder | Defines sorting order

try {
    $result = $api_instance->getConsortiumInstitutions($xOkapiTenant, $tenantId, $id, $limit, $offset, $sortBy, $sortOrder);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SearchConsortiumApi->getConsortiumInstitutions: ', $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 $tenantId = tenantId_example; # String | Tenant ID to filter by
my $id = id_example; # String | ID to filter by
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
  - tenantId
  - name

my $sortOrder = ; # SortOrder | Defines sorting order

eval {
    my $result = $api_instance->getConsortiumInstitutions(xOkapiTenant => $xOkapiTenant, tenantId => $tenantId, id => $id, limit => $limit, offset => $offset, sortBy => $sortBy, sortOrder => $sortOrder);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SearchConsortiumApi->getConsortiumInstitutions: $@\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)
tenantId = tenantId_example # String | Tenant ID to filter by (optional) (default to null)
id = id_example # String | ID to filter by (optional) (default to null)
limit = 56 # Integer | Limit the number of elements returned in the response. (optional) (default to 1000)
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
  - tenantId
  - name
 (optional) (default to name)
sortOrder =  # SortOrder | Defines sorting order (optional) (default to null)

try:
    # Get Consortium Institutions
    api_response = api_instance.get_consortium_institutions(xOkapiTenant, tenantId=tenantId, id=id, limit=limit, offset=offset, sortBy=sortBy, sortOrder=sortOrder)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SearchConsortiumApi->getConsortiumInstitutions: %s\n" % e)
extern crate SearchConsortiumApi;

pub fn main() {
    let xOkapiTenant = xOkapiTenant_example; // String
    let tenantId = tenantId_example; // String
    let id = id_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.getConsortiumInstitutions(xOkapiTenant, tenantId, id, 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
tenantId
String
Tenant ID to filter by
id
String
ID to filter by
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 - tenantId - name
sortOrder
SortOrder
Defines sorting order

Responses


getConsortiumItem

Fetch consolidated item by id

Get an item (only for consortium environment)


/search/consortium/item/{id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://folio-dev-spitfire-okapi.ci.folio.org/search/consortium/item/{id}"
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();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The UUID of a record
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value

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

final api_instance = DefaultApi();

final UUID id = new UUID(); // UUID | The UUID of a record
final String xOkapiTenant = new String(); // String | X-Okapi-Tenant header value

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

import org.openapitools.client.api.SearchConsortiumApi;

public class SearchConsortiumApiExample {
    public static void main(String[] args) {
        SearchConsortiumApi apiInstance = new SearchConsortiumApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The UUID of a record
        String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value

        try {
            consortiumItem result = apiInstance.getConsortiumItem(id, xOkapiTenant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchConsortiumApi#getConsortiumItem");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SearchConsortiumApi *apiInstance = [[SearchConsortiumApi alloc] init];
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The UUID of a record (default to null)
String *xOkapiTenant = xOkapiTenant_example; // X-Okapi-Tenant header value (default to null)

// Fetch consolidated item by id
[apiInstance getConsortiumItemWith:id
    xOkapiTenant:xOkapiTenant
              completionHandler: ^(consortiumItem 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 id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The UUID of a record
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.getConsortiumItem(id, xOkapiTenant, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new SearchConsortiumApi();
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The UUID of a record (default to null)
            var xOkapiTenant = xOkapiTenant_example;  // String | X-Okapi-Tenant header value (default to null)

            try {
                // Fetch consolidated item by id
                consortiumItem result = apiInstance.getConsortiumItem(id, xOkapiTenant);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SearchConsortiumApi.getConsortiumItem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SearchConsortiumApi();
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The UUID of a record
$xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value

try {
    $result = $api_instance->getConsortiumItem($id, $xOkapiTenant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SearchConsortiumApi->getConsortiumItem: ', $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 $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The UUID of a record
my $xOkapiTenant = xOkapiTenant_example; # String | X-Okapi-Tenant header value

eval {
    my $result = $api_instance->getConsortiumItem(id => $id, xOkapiTenant => $xOkapiTenant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SearchConsortiumApi->getConsortiumItem: $@\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()
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The UUID of a record (default to null)
xOkapiTenant = xOkapiTenant_example # String | X-Okapi-Tenant header value (default to null)

try:
    # Fetch consolidated item by id
    api_response = api_instance.get_consortium_item(id, xOkapiTenant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SearchConsortiumApi->getConsortiumItem: %s\n" % e)
extern crate SearchConsortiumApi;

pub fn main() {
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let xOkapiTenant = xOkapiTenant_example; // String

    let mut context = SearchConsortiumApi::Context::default();
    let result = client.getConsortiumItem(id, xOkapiTenant, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
The UUID of a record
Required
Header parameters
Name Description
x-okapi-tenant*
String
X-Okapi-Tenant header value
Required

Responses


getConsortiumItems

Get Consolidated Items

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 to filter by
        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 to filter by
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 to filter by
        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 to filter by (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)

// Get Consolidated Items
[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 to filter by
  '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 to filter by (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 {
                // Get Consolidated Items
                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 to filter by
$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 to filter by
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 to filter by (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:
    # Get Consolidated Items
    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 to filter by
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


getConsortiumLibraries

Get Consortium Libraries

Get a list of libraries (only for consortium environment)


/search/consortium/libraries

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://folio-dev-spitfire-okapi.ci.folio.org/search/consortium/libraries?tenantId=tenantId_example&id=id_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 tenantId = tenantId_example; // String | Tenant ID to filter by
        String id = id_example; // String | ID to filter by
        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
  - tenantId
  - campusId
  - name

        SortOrder sortOrder = ; // SortOrder | Defines sorting order

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

final api_instance = DefaultApi();

final String xOkapiTenant = new String(); // String | X-Okapi-Tenant header value
final String tenantId = new String(); // String | Tenant ID to filter by
final String id = new String(); // String | ID to filter by
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
  - tenantId
  - campusId
  - name

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

try {
    final result = await api_instance.getConsortiumLibraries(xOkapiTenant, tenantId, id, limit, offset, sortBy, sortOrder);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getConsortiumLibraries: $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 tenantId = tenantId_example; // String | Tenant ID to filter by
        String id = id_example; // String | ID to filter by
        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
  - tenantId
  - campusId
  - name

        SortOrder sortOrder = ; // SortOrder | Defines sorting order

        try {
            consortiumLibraryCollection result = apiInstance.getConsortiumLibraries(xOkapiTenant, tenantId, id, limit, offset, sortBy, sortOrder);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchConsortiumApi#getConsortiumLibraries");
            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 *tenantId = tenantId_example; // Tenant ID to filter by (optional) (default to null)
String *id = id_example; // ID to filter by (optional) (default to null)
Integer *limit = 56; // Limit the number of elements returned in the response. (optional) (default to 1000)
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
  - tenantId
  - campusId
  - name
 (optional) (default to name)
SortOrder *sortOrder = ; // Defines sorting order (optional) (default to null)

// Get Consortium Libraries
[apiInstance getConsortiumLibrariesWith:xOkapiTenant
    tenantId:tenantId
    id:id
    limit:limit
    offset:offset
    sortBy:sortBy
    sortOrder:sortOrder
              completionHandler: ^(consortiumLibraryCollection 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 = {
  'tenantId': tenantId_example, // {String} Tenant ID to filter by
  'id': id_example, // {String} ID to filter by
  '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
  - tenantId
  - campusId
  - name

  '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.getConsortiumLibraries(xOkapiTenant, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getConsortiumLibrariesExample
    {
        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 tenantId = tenantId_example;  // String | Tenant ID to filter by (optional)  (default to null)
            var id = id_example;  // String | ID to filter by (optional)  (default to null)
            var limit = 56;  // Integer | Limit the number of elements returned in the response. (optional)  (default to 1000)
            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
  - tenantId
  - campusId
  - name
 (optional)  (default to name)
            var sortOrder = new SortOrder(); // SortOrder | Defines sorting order (optional)  (default to null)

            try {
                // Get Consortium Libraries
                consortiumLibraryCollection result = apiInstance.getConsortiumLibraries(xOkapiTenant, tenantId, id, limit, offset, sortBy, sortOrder);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SearchConsortiumApi.getConsortiumLibraries: " + 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
$tenantId = tenantId_example; // String | Tenant ID to filter by
$id = id_example; // String | ID to filter by
$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
  - tenantId
  - campusId
  - name

$sortOrder = ; // SortOrder | Defines sorting order

try {
    $result = $api_instance->getConsortiumLibraries($xOkapiTenant, $tenantId, $id, $limit, $offset, $sortBy, $sortOrder);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SearchConsortiumApi->getConsortiumLibraries: ', $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 $tenantId = tenantId_example; # String | Tenant ID to filter by
my $id = id_example; # String | ID to filter by
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
  - tenantId
  - campusId
  - name

my $sortOrder = ; # SortOrder | Defines sorting order

eval {
    my $result = $api_instance->getConsortiumLibraries(xOkapiTenant => $xOkapiTenant, tenantId => $tenantId, id => $id, limit => $limit, offset => $offset, sortBy => $sortBy, sortOrder => $sortOrder);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SearchConsortiumApi->getConsortiumLibraries: $@\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)
tenantId = tenantId_example # String | Tenant ID to filter by (optional) (default to null)
id = id_example # String | ID to filter by (optional) (default to null)
limit = 56 # Integer | Limit the number of elements returned in the response. (optional) (default to 1000)
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
  - tenantId
  - campusId
  - name
 (optional) (default to name)
sortOrder =  # SortOrder | Defines sorting order (optional) (default to null)

try:
    # Get Consortium Libraries
    api_response = api_instance.get_consortium_libraries(xOkapiTenant, tenantId=tenantId, id=id, limit=limit, offset=offset, sortBy=sortBy, sortOrder=sortOrder)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SearchConsortiumApi->getConsortiumLibraries: %s\n" % e)
extern crate SearchConsortiumApi;

pub fn main() {
    let xOkapiTenant = xOkapiTenant_example; // String
    let tenantId = tenantId_example; // String
    let id = id_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.getConsortiumLibraries(xOkapiTenant, tenantId, id, 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
tenantId
String
Tenant ID to filter by
id
String
ID to filter by
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 - tenantId - campusId - name
sortOrder
SortOrder
Defines sorting order

Responses


getConsortiumLocations

Get Consortium Locations

Get a list of locations (only for consortium environment)


/search/consortium/locations

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://folio-dev-spitfire-okapi.ci.folio.org/search/consortium/locations?tenantId=tenantId_example&id=id_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 tenantId = tenantId_example; // String | Tenant ID to filter by
        String id = id_example; // String | ID to filter by
        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
  - tenantId
  - name

        SortOrder sortOrder = ; // SortOrder | Defines sorting order

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

final api_instance = DefaultApi();

final String xOkapiTenant = new String(); // String | X-Okapi-Tenant header value
final String tenantId = new String(); // String | Tenant ID to filter by
final String id = new String(); // String | ID to filter by
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
  - tenantId
  - name

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

try {
    final result = await api_instance.getConsortiumLocations(xOkapiTenant, tenantId, id, limit, offset, sortBy, sortOrder);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getConsortiumLocations: $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 tenantId = tenantId_example; // String | Tenant ID to filter by
        String id = id_example; // String | ID to filter by
        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
  - tenantId
  - name

        SortOrder sortOrder = ; // SortOrder | Defines sorting order

        try {
            consortiumLocationCollection result = apiInstance.getConsortiumLocations(xOkapiTenant, tenantId, id, limit, offset, sortBy, sortOrder);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchConsortiumApi#getConsortiumLocations");
            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 *tenantId = tenantId_example; // Tenant ID to filter by (optional) (default to null)
String *id = id_example; // ID to filter by (optional) (default to null)
Integer *limit = 56; // Limit the number of elements returned in the response. (optional) (default to 10000)
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
  - tenantId
  - name
 (optional) (default to name)
SortOrder *sortOrder = ; // Defines sorting order (optional) (default to null)

// Get Consortium Locations
[apiInstance getConsortiumLocationsWith:xOkapiTenant
    tenantId:tenantId
    id:id
    limit:limit
    offset:offset
    sortBy:sortBy
    sortOrder:sortOrder
              completionHandler: ^(consortiumLocationCollection 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 = {
  'tenantId': tenantId_example, // {String} Tenant ID to filter by
  'id': id_example, // {String} ID to filter by
  '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
  - tenantId
  - name

  '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.getConsortiumLocations(xOkapiTenant, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getConsortiumLocationsExample
    {
        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 tenantId = tenantId_example;  // String | Tenant ID to filter by (optional)  (default to null)
            var id = id_example;  // String | ID to filter by (optional)  (default to null)
            var limit = 56;  // Integer | Limit the number of elements returned in the response. (optional)  (default to 10000)
            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
  - tenantId
  - name
 (optional)  (default to name)
            var sortOrder = new SortOrder(); // SortOrder | Defines sorting order (optional)  (default to null)

            try {
                // Get Consortium Locations
                consortiumLocationCollection result = apiInstance.getConsortiumLocations(xOkapiTenant, tenantId, id, limit, offset, sortBy, sortOrder);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SearchConsortiumApi.getConsortiumLocations: " + 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
$tenantId = tenantId_example; // String | Tenant ID to filter by
$id = id_example; // String | ID to filter by
$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
  - tenantId
  - name

$sortOrder = ; // SortOrder | Defines sorting order

try {
    $result = $api_instance->getConsortiumLocations($xOkapiTenant, $tenantId, $id, $limit, $offset, $sortBy, $sortOrder);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SearchConsortiumApi->getConsortiumLocations: ', $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 $tenantId = tenantId_example; # String | Tenant ID to filter by
my $id = id_example; # String | ID to filter by
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
  - tenantId
  - name

my $sortOrder = ; # SortOrder | Defines sorting order

eval {
    my $result = $api_instance->getConsortiumLocations(xOkapiTenant => $xOkapiTenant, tenantId => $tenantId, id => $id, limit => $limit, offset => $offset, sortBy => $sortBy, sortOrder => $sortOrder);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SearchConsortiumApi->getConsortiumLocations: $@\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)
tenantId = tenantId_example # String | Tenant ID to filter by (optional) (default to null)
id = id_example # String | ID to filter by (optional) (default to null)
limit = 56 # Integer | Limit the number of elements returned in the response. (optional) (default to 10000)
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
  - tenantId
  - name
 (optional) (default to name)
sortOrder =  # SortOrder | Defines sorting order (optional) (default to null)

try:
    # Get Consortium Locations
    api_response = api_instance.get_consortium_locations(xOkapiTenant, tenantId=tenantId, id=id, limit=limit, offset=offset, sortBy=sortBy, sortOrder=sortOrder)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SearchConsortiumApi->getConsortiumLocations: %s\n" % e)
extern crate SearchConsortiumApi;

pub fn main() {
    let xOkapiTenant = xOkapiTenant_example; // String
    let tenantId = tenantId_example; // String
    let id = id_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.getConsortiumLocations(xOkapiTenant, tenantId, id, 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
tenantId
String
Tenant ID to filter by
id
String
ID to filter by
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 - tenantId - name
sortOrder
SortOrder
Defines sorting order

Responses


SearchResourcesIds

getIdsJob

Get Job

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)

// Get Job
[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 {
                // Get Job
                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:
    # Get Job
    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


getResourceIds

Get Resource IDs

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)

// Get Resource IDs
[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 {
                // Get Resource IDs
                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:
    # Get Resource IDs
    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

Trigger new Job

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 = ; // 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 = ; // 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 = ; // 

// Trigger new Job
[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 resourceIdsJob = ; // {ResourceIdsJob} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.submitIdsJob(xOkapiTenant, resourceIdsJob, 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 | 

            try {
                // Trigger new Job
                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 = ; // 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 =  # ResourceIdsJob | 

try:
    # Trigger new Job
    api_response = api_instance.submit_ids_job(xOkapiTenant, 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 = ; // 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