getConceptByConceptScheme
Get concepts - by Concept Scheme
# Get a collection of resources of class Concept by the universal identifier (~ URI) of a Concept Scheme. This service is a bulk operation on the Get concept service.
/resource/concept
Usage and SDK Samples
curl -X GET\
-H "Accept: application/json,application/json;charset=UTF-8"\
"http://127.0.0.1:8082/resource/concept?isInScheme=&language=&offset=&limit=&selectedVersion=&viewObsolete="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BulkOperationApi;
import java.io.File;
import java.util.*;
public class BulkOperationApiExample {
public static void main(String[] args) {
BulkOperationApi apiInstance = new BulkOperationApi();
String isInScheme = isInScheme_example; // String | The unique identifier of the requested concept scheme.
String language = language_example; // String | The default language of the returned response. Overwrites the Accept-Language header.
Integer offset = 56; // Integer | The offset of the returned resources in the response. Supports paging where the 'offset' specifies the page number
Integer limit = 56; // Integer | The maximum number of returned resources in the response.
String selectedVersion = selectedVersion_example; // String | The selected ESCO dataset version.
Boolean viewObsolete = true; // Boolean | If set to 'true', the obsoleted concepts will be returned
String acceptLanguage = acceptLanguage_example; // String | The default language of the returned response. Optional and might be overwritten by the language request parameter.
try {
Concepts result = apiInstance.getConceptByConceptScheme(isInScheme, language, offset, limit, selectedVersion, viewObsolete, acceptLanguage);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling BulkOperationApi#getConceptByConceptScheme");
e.printStackTrace();
}
}
}
import io.swagger.client.api.BulkOperationApi;
public class BulkOperationApiExample {
public static void main(String[] args) {
BulkOperationApi apiInstance = new BulkOperationApi();
String isInScheme = isInScheme_example; // String | The unique identifier of the requested concept scheme.
String language = language_example; // String | The default language of the returned response. Overwrites the Accept-Language header.
Integer offset = 56; // Integer | The offset of the returned resources in the response. Supports paging where the 'offset' specifies the page number
Integer limit = 56; // Integer | The maximum number of returned resources in the response.
String selectedVersion = selectedVersion_example; // String | The selected ESCO dataset version.
Boolean viewObsolete = true; // Boolean | If set to 'true', the obsoleted concepts will be returned
String acceptLanguage = acceptLanguage_example; // String | The default language of the returned response. Optional and might be overwritten by the language request parameter.
try {
Concepts result = apiInstance.getConceptByConceptScheme(isInScheme, language, offset, limit, selectedVersion, viewObsolete, acceptLanguage);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling BulkOperationApi#getConceptByConceptScheme");
e.printStackTrace();
}
}
}
String *isInScheme = isInScheme_example; // The unique identifier of the requested concept scheme.
String *language = language_example; // The default language of the returned response. Overwrites the Accept-Language header. (optional)
Integer *offset = 56; // The offset of the returned resources in the response. Supports paging where the 'offset' specifies the page number (optional) (default to 0)
Integer *limit = 56; // The maximum number of returned resources in the response. (optional) (default to 20)
String *selectedVersion = selectedVersion_example; // The selected ESCO dataset version. (optional) (default to latest)
Boolean *viewObsolete = true; // If set to 'true', the obsoleted concepts will be returned (optional) (default to false)
String *acceptLanguage = acceptLanguage_example; // The default language of the returned response. Optional and might be overwritten by the language request parameter. (optional)
BulkOperationApi *apiInstance = [[BulkOperationApi alloc] init];
// Get concepts - by Concept Scheme
[apiInstance getConceptByConceptSchemeWith:isInScheme
language:language
offset:offset
limit:limit
selectedVersion:selectedVersion
viewObsolete:viewObsolete
acceptLanguage:acceptLanguage
completionHandler: ^(Concepts output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var EscoRestApiDocs = require('esco_rest_api_docs');
var api = new EscoRestApiDocs.BulkOperationApi()
var isInScheme = isInScheme_example; // {{String}} The unique identifier of the requested concept scheme.
var opts = {
'language': language_example, // {{String}} The default language of the returned response. Overwrites the Accept-Language header.
'offset': 56, // {{Integer}} The offset of the returned resources in the response. Supports paging where the 'offset' specifies the page number
'limit': 56, // {{Integer}} The maximum number of returned resources in the response.
'selectedVersion': selectedVersion_example, // {{String}} The selected ESCO dataset version.
'viewObsolete': true, // {{Boolean}} If set to 'true', the obsoleted concepts will be returned
'acceptLanguage': acceptLanguage_example // {{String}} The default language of the returned response. Optional and might be overwritten by the language request parameter.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getConceptByConceptScheme(isInScheme, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class getConceptByConceptSchemeExample
{
public void main()
{
var apiInstance = new BulkOperationApi();
var isInScheme = isInScheme_example; // String | The unique identifier of the requested concept scheme.
var language = language_example; // String | The default language of the returned response. Overwrites the Accept-Language header. (optional)
var offset = 56; // Integer | The offset of the returned resources in the response. Supports paging where the 'offset' specifies the page number (optional) (default to 0)
var limit = 56; // Integer | The maximum number of returned resources in the response. (optional) (default to 20)
var selectedVersion = selectedVersion_example; // String | The selected ESCO dataset version. (optional) (default to latest)
var viewObsolete = true; // Boolean | If set to 'true', the obsoleted concepts will be returned (optional) (default to false)
var acceptLanguage = acceptLanguage_example; // String | The default language of the returned response. Optional and might be overwritten by the language request parameter. (optional)
try
{
// Get concepts - by Concept Scheme
Concepts result = apiInstance.getConceptByConceptScheme(isInScheme, language, offset, limit, selectedVersion, viewObsolete, acceptLanguage);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling BulkOperationApi.getConceptByConceptScheme: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\ApiBulkOperationApi();
$isInScheme = isInScheme_example; // String | The unique identifier of the requested concept scheme.
$language = language_example; // String | The default language of the returned response. Overwrites the Accept-Language header.
$offset = 56; // Integer | The offset of the returned resources in the response. Supports paging where the 'offset' specifies the page number
$limit = 56; // Integer | The maximum number of returned resources in the response.
$selectedVersion = selectedVersion_example; // String | The selected ESCO dataset version.
$viewObsolete = true; // Boolean | If set to 'true', the obsoleted concepts will be returned
$acceptLanguage = acceptLanguage_example; // String | The default language of the returned response. Optional and might be overwritten by the language request parameter.
try {
$result = $api_instance->getConceptByConceptScheme($isInScheme, $language, $offset, $limit, $selectedVersion, $viewObsolete, $acceptLanguage);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BulkOperationApi->getConceptByConceptScheme: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BulkOperationApi;
my $api_instance = WWW::SwaggerClient::BulkOperationApi->new();
my $isInScheme = isInScheme_example; # String | The unique identifier of the requested concept scheme.
my $language = language_example; # String | The default language of the returned response. Overwrites the Accept-Language header.
my $offset = 56; # Integer | The offset of the returned resources in the response. Supports paging where the 'offset' specifies the page number
my $limit = 56; # Integer | The maximum number of returned resources in the response.
my $selectedVersion = selectedVersion_example; # String | The selected ESCO dataset version.
my $viewObsolete = true; # Boolean | If set to 'true', the obsoleted concepts will be returned
my $acceptLanguage = acceptLanguage_example; # String | The default language of the returned response. Optional and might be overwritten by the language request parameter.
eval {
my $result = $api_instance->getConceptByConceptScheme(isInScheme => $isInScheme, language => $language, offset => $offset, limit => $limit, selectedVersion => $selectedVersion, viewObsolete => $viewObsolete, acceptLanguage => $acceptLanguage);
print Dumper($result);
};
if ($@) {
warn "Exception when calling BulkOperationApi->getConceptByConceptScheme: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.BulkOperationApi()
isInScheme = isInScheme_example # String | The unique identifier of the requested concept scheme.
language = language_example # String | The default language of the returned response. Overwrites the Accept-Language header. (optional)
offset = 56 # Integer | The offset of the returned resources in the response. Supports paging where the 'offset' specifies the page number (optional) (default to 0)
limit = 56 # Integer | The maximum number of returned resources in the response. (optional) (default to 20)
selectedVersion = selectedVersion_example # String | The selected ESCO dataset version. (optional) (default to latest)
viewObsolete = true # Boolean | If set to 'true', the obsoleted concepts will be returned (optional) (default to false)
acceptLanguage = acceptLanguage_example # String | The default language of the returned response. Optional and might be overwritten by the language request parameter. (optional)
try:
# Get concepts - by Concept Scheme
api_response = api_instance.get_concept_by_concept_scheme(isInScheme, language=language, offset=offset, limit=limit, selectedVersion=selectedVersion, viewObsolete=viewObsolete, acceptLanguage=acceptLanguage)
pprint(api_response)
except ApiException as e:
print("Exception when calling BulkOperationApi->getConceptByConceptScheme: %s\n" % e)
Parameters
Name | Description |
---|---|
Accept-Language |
String
The default language of the returned response. Optional and
might be overwritten by the language request parameter.
|
Name | Description |
---|---|
isInScheme* |
String
The unique identifier of the requested concept scheme.
Required
|
language |
String
The default language of the returned response. Overwrites the
Accept-Language header.
|
offset |
Integer
The offset of the returned resources in the response. Supports
paging where the 'offset' specifies the page number
|
limit |
Integer
The maximum number of returned resources in the response.
|
selectedVersion |
String
The selected ESCO dataset version.
|
viewObsolete |
Boolean
If set to 'true', the obsoleted concepts will be
returned
|
Responses
Status: 200 - The payload of the response is a JSON HAL Collection representation of a set of Concept resources.
Status: 400 - The request was malformed (e.g. illegal value for a given path variable or query parameter). The response body will include an error providing further information
Name | Type | Format | Description |
---|---|---|---|
Content-Type | String | ||
Content-Length | Integer |
Status: 404 - The requested resource did not exist
Name | Type | Format | Description |
---|---|---|---|
Content-Type | String | ||
Content-Length | Integer |
Status: 5XX - An exception was raised
Name | Type | Format | Description |
---|---|---|---|
Content-Type | String | ||
Content-Length | Integer |