OlsApiProvider

OLS API V2.

The Ontology Lookup Service (OLS) hosts ontologies. Implementation is not fully completed yet.

Individual are not supported. Properties are only supported partially.

const provider = new OlsApiProvider({
  endpoint: "https://api.terminology.tib.eu/api/v2/",     // OLS API V2 base URL 
  language: "en",         // default language to use for labels and descriptions
})

Constructor

new OlsApiProvider()

Source

Extends

Members

(readonly) has :Object

A dictionary with functionality of the registry (e.g. registry.has.schemes).

Type:
  • Object
Overrides
Source

languages :Array.<string>

A list of RFC 3066 language tags in lowercase in order of priority.

Type:
  • Array.<string>
Overrides
Source

Methods

_getApiUrl()

Constructs the full API URL for a given endpoint.

Source

(async) deleteMappings(config) → {Array.<Object>}

DELETEs multiple mappings. Do not override in subclass!

Parameters:
NameTypeDescription
configObject
Properties
NameTypeDescription
mappingsArray

array of mapping objects

Overrides
Source
Returns:

array of results (true if successful); in case of failure, consult the _errors property on the array at the index of the failed request

Type: 
Array.<Object>

getCancelTokenSource() → {Object}

Returns a source for a axios cancel token.

Overrides
Source
Returns:

axios cancel token source

Type: 
Object

(async) init() → {Promise}

Load data about registry via the status endpoint.

Overrides
Source
Returns:

Promise that resolves when initialization is complete.

Type: 
Promise

isAuthorizedFor(options) → {boolean}

Returns whether a user is authorized for a certain request.

Parameters:
NameTypeDescription
optionsObject
Properties
NameTypeAttributesDescription
typestring

type of item (e.g. mappings)

actionstring

action to be performed (read/create/update/delete)

userObject

user object

crossUserboolean<optional>

whether the request is a crossUser request (i.e. updading/deleting another user's item)

Overrides
Source
Returns:
Type: 
boolean

(async) postMappings(config) → {Array.<Object>}

POSTs multiple mappings. Do not override in subclass!

Parameters:
NameTypeDescription
configObject
Properties
NameTypeDescription
mappingsArray

array of mapping objects

Overrides
Source
Returns:

array of created mapping objects; in case of failure, consult the _errors property on the array at the index of the failed request

Type: 
Array.<Object>

setAuth(options)

Sets authentication credentials.

Parameters:
NameTypeDescription
optionsObject
Properties
NameTypeDescription
keystring

public key of login-server instance the user is authorized for

bearerTokenstring

token that is sent with each request

Overrides
Source

setRetryConfig(config)

Sets retry configuration.

Parameters:
NameTypeDescription
configObject
Properties
NameTypeAttributesDefaultDescription
methodsArray.<string><optional>
["get", "head", "options"]

HTTP methods to retry (lowercase)

statusCodesArray.<number><optional>
[401, 403]

status codes to retry

countnumber<optional>
3

maximum number of retries

delaynumber | function<optional>
300*count

a delay in ms or a function that takes the number of current retries and returns a delay in ms

Overrides
Source

(async) suggest(config) → {Array}

Returns suggestion result in OpenSearch Suggest Format.

Parameters:
NameTypeDescription
configObject
Properties
NameTypeAttributesDefaultDescription
searchstring

search string

schemeObject<optional>

concept scheme to search in

limitnumber<optional>
100

maximum number of search results (default might be overridden by registry)

typesArray.<string><optional>
[]

list of type URIs

Overrides
Source
Returns:

result in OpenSearch Suggest Format

Type: 
Array

supportsScheme(scheme) → {boolean}

Returns a boolean whether a certain target scheme is supported or not.

Parameters:
NameTypeDescription
schemeObject
Overrides
Source
Returns:
Type: 
boolean

(static) _registryConfigForBartocApiConfig()

Used by registryForScheme (see src/lib/CocodaSDK.js) to determine a provider config for a concept schceme. TODO: make this obsolete

Source