browseAuthorities
Provides list of authorities by headingRef
/browse/authorities
Usage and SDK Samples
curl -X GET \
-H "Accept: application/json" \
"https://folio-dev-spitfire-okapi.ci.folio.org/browse/authorities?query=query_example&limit=56&expandAll=true&highlightMatch=true&precedingRecordsCount=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BrowseApi;
import java.io.File;
import java.util.*;
public class BrowseApiExample {
public static void main(String[] args) {
// Create an instance of the API class
BrowseApi apiInstance = new BrowseApi();
String query = query_example; // String | A CQL query string with search conditions.
String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
Integer limit = 56; // Integer | Limit the number of elements returned in the response.
Boolean expandAll = true; // Boolean | Whether to return only basic properties or entire instance.
Boolean highlightMatch = true; // Boolean | Whether to highlight matched resource by query input or not.
Integer precedingRecordsCount = 56; // Integer | Number of preceding records for browsing around and around-including options
try {
authorityBrowseResult result = apiInstance.browseAuthorities(query, xOkapiTenant, limit, expandAll, highlightMatch, precedingRecordsCount);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling BrowseApi#browseAuthorities");
e.printStackTrace();
}
}
}
import 'package:openapi/api.dart';
final api_instance = DefaultApi();
final String query = new String(); // String | A CQL query string with search conditions.
final String xOkapiTenant = new String(); // String | X-Okapi-Tenant header value
final Integer limit = new Integer(); // Integer | Limit the number of elements returned in the response.
final Boolean expandAll = new Boolean(); // Boolean | Whether to return only basic properties or entire instance.
final Boolean highlightMatch = new Boolean(); // Boolean | Whether to highlight matched resource by query input or not.
final Integer precedingRecordsCount = new Integer(); // Integer | Number of preceding records for browsing around and around-including options
try {
final result = await api_instance.browseAuthorities(query, xOkapiTenant, limit, expandAll, highlightMatch, precedingRecordsCount);
print(result);
} catch (e) {
print('Exception when calling DefaultApi->browseAuthorities: $e\n');
}
import org.openapitools.client.api.BrowseApi;
public class BrowseApiExample {
public static void main(String[] args) {
BrowseApi apiInstance = new BrowseApi();
String query = query_example; // String | A CQL query string with search conditions.
String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
Integer limit = 56; // Integer | Limit the number of elements returned in the response.
Boolean expandAll = true; // Boolean | Whether to return only basic properties or entire instance.
Boolean highlightMatch = true; // Boolean | Whether to highlight matched resource by query input or not.
Integer precedingRecordsCount = 56; // Integer | Number of preceding records for browsing around and around-including options
try {
authorityBrowseResult result = apiInstance.browseAuthorities(query, xOkapiTenant, limit, expandAll, highlightMatch, precedingRecordsCount);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling BrowseApi#browseAuthorities");
e.printStackTrace();
}
}
}
// Create an instance of the API class
BrowseApi *apiInstance = [[BrowseApi alloc] init];
String *query = query_example; // A CQL query string with search conditions. (default to null)
String *xOkapiTenant = xOkapiTenant_example; // X-Okapi-Tenant header value (default to null)
Integer *limit = 56; // Limit the number of elements returned in the response. (optional) (default to 100)
Boolean *expandAll = true; // Whether to return only basic properties or entire instance. (optional) (default to false)
Boolean *highlightMatch = true; // Whether to highlight matched resource by query input or not. (optional) (default to true)
Integer *precedingRecordsCount = 56; // Number of preceding records for browsing around and around-including options (optional) (default to null)
[apiInstance browseAuthoritiesWith:query
xOkapiTenant:xOkapiTenant
limit:limit
expandAll:expandAll
highlightMatch:highlightMatch
precedingRecordsCount:precedingRecordsCount
completionHandler: ^(authorityBrowseResult output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var SearchApi = require('search_api');
// Create an instance of the API class
var api = new SearchApi.BrowseApi()
var query = query_example; // {String} A CQL query string with search conditions.
var xOkapiTenant = xOkapiTenant_example; // {String} X-Okapi-Tenant header value
var opts = {
'limit': 56, // {Integer} Limit the number of elements returned in the response.
'expandAll': true, // {Boolean} Whether to return only basic properties or entire instance.
'highlightMatch': true, // {Boolean} Whether to highlight matched resource by query input or not.
'precedingRecordsCount': 56 // {Integer} Number of preceding records for browsing around and around-including options
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.browseAuthorities(query, xOkapiTenant, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;
namespace Example
{
public class browseAuthoritiesExample
{
public void main()
{
// Create an instance of the API class
var apiInstance = new BrowseApi();
var query = query_example; // String | A CQL query string with search conditions. (default to null)
var xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value (default to null)
var limit = 56; // Integer | Limit the number of elements returned in the response. (optional) (default to 100)
var expandAll = true; // Boolean | Whether to return only basic properties or entire instance. (optional) (default to false)
var highlightMatch = true; // Boolean | Whether to highlight matched resource by query input or not. (optional) (default to true)
var precedingRecordsCount = 56; // Integer | Number of preceding records for browsing around and around-including options (optional) (default to null)
try {
authorityBrowseResult result = apiInstance.browseAuthorities(query, xOkapiTenant, limit, expandAll, highlightMatch, precedingRecordsCount);
Debug.WriteLine(result);
} catch (Exception e) {
Debug.Print("Exception when calling BrowseApi.browseAuthorities: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BrowseApi();
$query = query_example; // String | A CQL query string with search conditions.
$xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
$limit = 56; // Integer | Limit the number of elements returned in the response.
$expandAll = true; // Boolean | Whether to return only basic properties or entire instance.
$highlightMatch = true; // Boolean | Whether to highlight matched resource by query input or not.
$precedingRecordsCount = 56; // Integer | Number of preceding records for browsing around and around-including options
try {
$result = $api_instance->browseAuthorities($query, $xOkapiTenant, $limit, $expandAll, $highlightMatch, $precedingRecordsCount);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BrowseApi->browseAuthorities: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::BrowseApi;
# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BrowseApi->new();
my $query = query_example; # String | A CQL query string with search conditions.
my $xOkapiTenant = xOkapiTenant_example; # String | X-Okapi-Tenant header value
my $limit = 56; # Integer | Limit the number of elements returned in the response.
my $expandAll = true; # Boolean | Whether to return only basic properties or entire instance.
my $highlightMatch = true; # Boolean | Whether to highlight matched resource by query input or not.
my $precedingRecordsCount = 56; # Integer | Number of preceding records for browsing around and around-including options
eval {
my $result = $api_instance->browseAuthorities(query => $query, xOkapiTenant => $xOkapiTenant, limit => $limit, expandAll => $expandAll, highlightMatch => $highlightMatch, precedingRecordsCount => $precedingRecordsCount);
print Dumper($result);
};
if ($@) {
warn "Exception when calling BrowseApi->browseAuthorities: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
# Create an instance of the API class
api_instance = openapi_client.BrowseApi()
query = query_example # String | A CQL query string with search conditions. (default to null)
xOkapiTenant = xOkapiTenant_example # String | X-Okapi-Tenant header value (default to null)
limit = 56 # Integer | Limit the number of elements returned in the response. (optional) (default to 100)
expandAll = true # Boolean | Whether to return only basic properties or entire instance. (optional) (default to false)
highlightMatch = true # Boolean | Whether to highlight matched resource by query input or not. (optional) (default to true)
precedingRecordsCount = 56 # Integer | Number of preceding records for browsing around and around-including options (optional) (default to null)
try:
api_response = api_instance.browse_authorities(query, xOkapiTenant, limit=limit, expandAll=expandAll, highlightMatch=highlightMatch, precedingRecordsCount=precedingRecordsCount)
pprint(api_response)
except ApiException as e:
print("Exception when calling BrowseApi->browseAuthorities: %s\n" % e)
extern crate BrowseApi;
pub fn main() {
let query = query_example; // String
let xOkapiTenant = xOkapiTenant_example; // String
let limit = 56; // Integer
let expandAll = true; // Boolean
let highlightMatch = true; // Boolean
let precedingRecordsCount = 56; // Integer
let mut context = BrowseApi::Context::default();
let result = client.browseAuthorities(query, xOkapiTenant, limit, expandAll, highlightMatch, precedingRecordsCount, &context).wait();
println!("{:?}", result);
}
Scopes
Parameters
Name | Description |
---|---|
x-okapi-tenant* |
String
X-Okapi-Tenant header value
Required
|
Name | Description |
---|---|
query* |
String
A CQL query string with search conditions.
Required
|
limit |
Integer
Limit the number of elements returned in the response.
|
expandAll |
Boolean
Whether to return only basic properties or entire instance.
|
highlightMatch |
Boolean
Whether to highlight matched resource by query input or not.
|
precedingRecordsCount |
Integer
Number of preceding records for browsing around and around-including options
|