OSDB  OSDB Service Actions

Actions for Service: nih_lookup_service

Action IDDescription
getvalidyearsReturns the current status of various years in MeSH RDF
Action options:

-u, --url_only [url_only]
	Return only the action URL, not the action results
	Required: no
-r, --response_format [response_format]
	Sets the response media type through an Accept header.
	Required: no
	Permitted values: application/json
-q, --quality_values [quality_values]
	Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5. 
	--response_format takes precedence.
	Required: no
lookupdescriptorsSearch for Descriptors, also known as Headings.
Action options:

-m, --match [match]
	Determines how the label parameter is matched against Descriptor labels.
	Required: no
	Permitted values: contains, exact, startswith
-y, --year [year]
	Which year to query
	Required: no
	Permitted values: 2019, 2020, 2021, current, interim
-l, --limit [limit]
	Specifies the maximum number of matches to return.
	Required: no
-n, --label <label>
	Provides the text to search for in the label of each Descriptor.
	Required: yes
-u, --url_only [url_only]
	Return only the action URL, not the action results
	Required: no
-r, --response_format [response_format]
	Sets the response media type through an Accept header.
	Required: no
	Permitted values: application/json
-q, --quality_values [quality_values]
	Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5. 
	--response_format takes precedence.
	Required: no
lookupdetailsLookup some details for a descriptor
Action options:

-i, --includes [includes]
	Comma-separated list of categories from the set 'seealso','qualifiers','terms'
	Required: no
-d, --descriptor <descriptor>
	Specifies the full URI or identifier of a Descriptor.
	Required: yes
-u, --url_only [url_only]
	Return only the action URL, not the action results
	Required: no
-r, --response_format [response_format]
	Sets the response media type through an Accept header.
	Required: no
	Permitted values: application/json
-q, --quality_values [quality_values]
	Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5. 
	--response_format takes precedence.
	Required: no
lookuplabelsReturn the label or labels for a Resource URI.
Action options:

-r, --resource <resource>
	Specifies the full URI or identifier of a resource.
	Required: yes
-u, --url_only [url_only]
	Return only the action URL, not the action results
	Required: no
-s, --response_format [response_format]
	Sets the response media type through an Accept header.
	Required: no
	Permitted values: application/json
-q, --quality_values [quality_values]
	Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5. 
	--response_format takes precedence.
	Required: no
lookuppairsSearch for Descriptor-Qualifier pairs, also known as Subheadings.
Action options:

-d, --descriptor <descriptor>
	Specifies the full URI or identifier of a Descriptor.
	Required: yes
-l, --limit [limit]
	Specifies the maximum number of matches to return.
	Required: no
-m, --match [match]
	Determines how the label parameter is matched against Qualifier labels.
	Required: no
	Permitted values: contains, exact, startswith
-n, --label <label>
	Provides the text to search for in the label of each Quallifier.
	Required: yes
-u, --url_only [url_only]
	Return only the action URL, not the action results
	Required: no
-r, --response_format [response_format]
	Sets the response media type through an Accept header.
	Required: no
	Permitted values: application/json
-q, --quality_values [quality_values]
	Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5. 
	--response_format takes precedence.
	Required: no
lookupqualifiersReturn all allowed Qualifiers for a Descriptor.
Action options:

-d, --descriptor <descriptor>
	Specifies the full URI or identifier of a Descriptor.
	Required: yes
-u, --url_only [url_only]
	Return only the action URL, not the action results
	Required: no
-r, --response_format [response_format]
	Sets the response media type through an Accept header.
	Required: no
	Permitted values: application/json
-q, --quality_values [quality_values]
	Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5. 
	--response_format takes precedence.
	Required: no
lookuptermsSearch for Entry Terms
Action options:

-m, --match [match]
	Determines how the label parameter is matched against preferred labels.
	Required: no
	Permitted values: contains, exact, startswith
-l, --limit [limit]
	Specifies the maximum number of matches to return.
	Required: no
-n, --label <label>
	Provides the text to search for in the label of each Term.
	Required: yes
-u, --url_only [url_only]
	Return only the action URL, not the action results
	Required: no
-r, --response_format [response_format]
	Sets the response media type through an Accept header.
	Required: no
	Permitted values: application/json
-q, --quality_values [quality_values]
	Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5. 
	--response_format takes precedence.
	Required: no
sparqlqueryPerform SPARQL query
Action options:

-i, --inference [inference]
	Controls whether the service will use RDFS inference
	Required: no
	Permitted values: false, true
-f, --format [format]
	Overrides Accept header based content negotation
	Required: no
	Permitted values: CSV, JSON, JSON-LD, N3, RDF/XML, TSV, TURTLE, XML
-l, --limit [limit]
	Controls the maximum number of resulting rows or triples to return
	Required: no
-q, --query <query>
	This parameter is required and must contain a SPARQL query.
	Required: yes
-o, --offset [offset]
	Controls the offset into the query results
	Required: no
-u, --url_only [url_only]
	Return only the action URL, not the action results
	Required: no
-r, --response_format [response_format]
	Sets the response media type through an Accept header.
	Required: no
	Permitted values: application/ld+json, application/rdf+n3, application/rdf+xml, application/sparql-results+json, application/sparql-results+xml, text/csv, text/tab-separated-values, text/turtle
-s, --quality_values [quality_values]
	Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5. 
	--response_format takes precedence.
	Required: no