ESCO REST API Docs

BulkOperation

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

Header parameters
Name Description
Accept-Language
String
The default language of the returned response. Optional and might be overwritten by the language request parameter.
Query parameters
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

getConceptByUri

Get concepts - by URIs

# Get a collection of resources of class Concept by their universal identifiers (~ URIs). 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?curie=&uris=&language=&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 curie = curie_example; // String | The prefix of the provided URIs as parameters. CURIE (or Compact URI) defines a generic, abbreviated syntax for expressing Uniform Resource Identifiers (URIs).
        array[String] uris = ; // array[String] | The array of unique identifiers of the requested resources or the array of the end of unique identifiers if CURIE is defined.
        String language = language_example; // String | The default language of the returned response. Overwrites the Accept-Language header.
        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.getConceptByUri(curie, uris, language, selectedVersion, viewObsolete, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BulkOperationApi#getConceptByUri");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BulkOperationApi;

public class BulkOperationApiExample {

    public static void main(String[] args) {
        BulkOperationApi apiInstance = new BulkOperationApi();
        String curie = curie_example; // String | The prefix of the provided URIs as parameters. CURIE (or Compact URI) defines a generic, abbreviated syntax for expressing Uniform Resource Identifiers (URIs).
        array[String] uris = ; // array[String] | The array of unique identifiers of the requested resources or the array of the end of unique identifiers if CURIE is defined.
        String language = language_example; // String | The default language of the returned response. Overwrites the Accept-Language header.
        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.getConceptByUri(curie, uris, language, selectedVersion, viewObsolete, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BulkOperationApi#getConceptByUri");
            e.printStackTrace();
        }
    }
}
String *curie = curie_example; // The prefix of the provided URIs as parameters. CURIE (or Compact URI) defines a generic, abbreviated syntax for expressing Uniform Resource Identifiers (URIs). (optional)
array[String] *uris = ; // The array of unique identifiers of the requested resources or the array of the end of unique identifiers if CURIE is defined. (optional)
String *language = language_example; // The default language of the returned response. Overwrites the Accept-Language header. (optional)
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 URIs
[apiInstance getConceptByUriWith:curie
    uris:uris
    language:language
    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 opts = {
  'curie': curie_example, // {{String}} The prefix of the provided URIs as parameters. CURIE (or Compact URI) defines a generic, abbreviated syntax for expressing Uniform Resource Identifiers (URIs).
  'uris': , // {{array[String]}} The array of unique identifiers of the requested resources or the array of the end of unique identifiers if CURIE is defined.
  'language': language_example, // {{String}} The default language of the returned response. Overwrites the Accept-Language header.
  '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.getConceptByUri(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BulkOperationApi();
            var curie = curie_example;  // String | The prefix of the provided URIs as parameters. CURIE (or Compact URI) defines a generic, abbreviated syntax for expressing Uniform Resource Identifiers (URIs). (optional)
            var uris = new array[String](); // array[String] | The array of unique identifiers of the requested resources or the array of the end of unique identifiers if CURIE is defined. (optional)
            var language = language_example;  // String | The default language of the returned response. Overwrites the Accept-Language header. (optional)
            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 URIs
                Concepts result = apiInstance.getConceptByUri(curie, uris, language, selectedVersion, viewObsolete, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BulkOperationApi.getConceptByUri: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBulkOperationApi();
$curie = curie_example; // String | The prefix of the provided URIs as parameters. CURIE (or Compact URI) defines a generic, abbreviated syntax for expressing Uniform Resource Identifiers (URIs).
$uris = ; // array[String] | The array of unique identifiers of the requested resources or the array of the end of unique identifiers if CURIE is defined.
$language = language_example; // String | The default language of the returned response. Overwrites the Accept-Language header.
$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->getConceptByUri($curie, $uris, $language, $selectedVersion, $viewObsolete, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BulkOperationApi->getConceptByUri: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BulkOperationApi;

my $api_instance = WWW::SwaggerClient::BulkOperationApi->new();
my $curie = curie_example; # String | The prefix of the provided URIs as parameters. CURIE (or Compact URI) defines a generic, abbreviated syntax for expressing Uniform Resource Identifiers (URIs).
my $uris = []; # array[String] | The array of unique identifiers of the requested resources or the array of the end of unique identifiers if CURIE is defined.
my $language = language_example; # String | The default language of the returned response. Overwrites the Accept-Language header.
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->getConceptByUri(curie => $curie, uris => $uris, language => $language, selectedVersion => $selectedVersion, viewObsolete => $viewObsolete, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BulkOperationApi->getConceptByUri: $@\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()
curie = curie_example # String | The prefix of the provided URIs as parameters. CURIE (or Compact URI) defines a generic, abbreviated syntax for expressing Uniform Resource Identifiers (URIs). (optional)
uris =  # array[String] | The array of unique identifiers of the requested resources or the array of the end of unique identifiers if CURIE is defined. (optional)
language = language_example # String | The default language of the returned response. Overwrites the Accept-Language header. (optional)
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 URIs
    api_response = api_instance.get_concept_by_uri(curie=curie, uris=uris, language=language, selectedVersion=selectedVersion, viewObsolete=viewObsolete, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BulkOperationApi->getConceptByUri: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
The default language of the returned response. Optional and might be overwritten by the language request parameter.
Query parameters
Name Description
curie
String
The prefix of the provided URIs as parameters. CURIE (or Compact URI) defines a generic, abbreviated syntax for expressing Uniform Resource Identifiers (URIs).
uris
array[String]
The array of unique identifiers of the requested resources or the array of the end of unique identifiers if CURIE is defined.
language
String
The default language of the returned response. Overwrites the Accept-Language header.
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

getOccupationByConceptScheme

Get occupations - by Concept Scheme

# Get a collection of resources of class Occupation by the universal identifier (~ URI) of a Concept Scheme. This service is a bulk operation on the Get occupation service.


/resource/occupation

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json,application/json;charset=UTF-8"\
"http://127.0.0.1:8082/resource/occupation?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 {
            Occupations result = apiInstance.getOccupationByConceptScheme(isInScheme, language, offset, limit, selectedVersion, viewObsolete, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BulkOperationApi#getOccupationByConceptScheme");
            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 {
            Occupations result = apiInstance.getOccupationByConceptScheme(isInScheme, language, offset, limit, selectedVersion, viewObsolete, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BulkOperationApi#getOccupationByConceptScheme");
            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 occupations - by Concept Scheme
[apiInstance getOccupationByConceptSchemeWith:isInScheme
    language:language
    offset:offset
    limit:limit
    selectedVersion:selectedVersion
    viewObsolete:viewObsolete
    acceptLanguage:acceptLanguage
              completionHandler: ^(Occupations 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.getOccupationByConceptScheme(isInScheme, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getOccupationByConceptSchemeExample
    {
        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 occupations - by Concept Scheme
                Occupations result = apiInstance.getOccupationByConceptScheme(isInScheme, language, offset, limit, selectedVersion, viewObsolete, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BulkOperationApi.getOccupationByConceptScheme: " + 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->getOccupationByConceptScheme($isInScheme, $language, $offset, $limit, $selectedVersion, $viewObsolete, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BulkOperationApi->getOccupationByConceptScheme: ', $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->getOccupationByConceptScheme(isInScheme => $isInScheme, language => $language, offset => $offset, limit => $limit, selectedVersion => $selectedVersion, viewObsolete => $viewObsolete, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BulkOperationApi->getOccupationByConceptScheme: $@\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 occupations - by Concept Scheme
    api_response = api_instance.get_occupation_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->getOccupationByConceptScheme: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
The default language of the returned response. Optional and might be overwritten by the language request parameter.
Query parameters
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 Occupation 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

getOccupationByUri

Get occupations - by URIs

# Get a collection of resources of class Occupation by their universal identifiers (~ URIs). This service is a bulk operation on the Get occupation service.


/resource/occupation

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json,application/json;charset=UTF-8"\
"http://127.0.0.1:8082/resource/occupation?curie=&uris=&language=&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 curie = curie_example; // String | The prefix of the provided URIs as parameters. CURIE (or Compact URI) defines a generic, abbreviated syntax for expressing Uniform Resource Identifiers (URIs).
        array[String] uris = ; // array[String] | The array of unique identifiers of the requested resources or the array of the end of unique identifiers if CURIE is defined.
        String language = language_example; // String | The default language of the returned response. Overwrites the Accept-Language header.
        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 {
            Occupations result = apiInstance.getOccupationByUri(curie, uris, language, selectedVersion, viewObsolete, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BulkOperationApi#getOccupationByUri");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BulkOperationApi;

public class BulkOperationApiExample {

    public static void main(String[] args) {
        BulkOperationApi apiInstance = new BulkOperationApi();
        String curie = curie_example; // String | The prefix of the provided URIs as parameters. CURIE (or Compact URI) defines a generic, abbreviated syntax for expressing Uniform Resource Identifiers (URIs).
        array[String] uris = ; // array[String] | The array of unique identifiers of the requested resources or the array of the end of unique identifiers if CURIE is defined.
        String language = language_example; // String | The default language of the returned response. Overwrites the Accept-Language header.
        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 {
            Occupations result = apiInstance.getOccupationByUri(curie, uris, language, selectedVersion, viewObsolete, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BulkOperationApi#getOccupationByUri");
            e.printStackTrace();
        }
    }
}
String *curie = curie_example; // The prefix of the provided URIs as parameters. CURIE (or Compact URI) defines a generic, abbreviated syntax for expressing Uniform Resource Identifiers (URIs). (optional)
array[String] *uris = ; // The array of unique identifiers of the requested resources or the array of the end of unique identifiers if CURIE is defined. (optional)
String *language = language_example; // The default language of the returned response. Overwrites the Accept-Language header. (optional)
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 occupations - by URIs
[apiInstance getOccupationByUriWith:curie
    uris:uris
    language:language
    selectedVersion:selectedVersion
    viewObsolete:viewObsolete
    acceptLanguage:acceptLanguage
              completionHandler: ^(Occupations 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 opts = {
  'curie': curie_example, // {{String}} The prefix of the provided URIs as parameters. CURIE (or Compact URI) defines a generic, abbreviated syntax for expressing Uniform Resource Identifiers (URIs).
  'uris': , // {{array[String]}} The array of unique identifiers of the requested resources or the array of the end of unique identifiers if CURIE is defined.
  'language': language_example, // {{String}} The default language of the returned response. Overwrites the Accept-Language header.
  '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.getOccupationByUri(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BulkOperationApi();
            var curie = curie_example;  // String | The prefix of the provided URIs as parameters. CURIE (or Compact URI) defines a generic, abbreviated syntax for expressing Uniform Resource Identifiers (URIs). (optional)
            var uris = new array[String](); // array[String] | The array of unique identifiers of the requested resources or the array of the end of unique identifiers if CURIE is defined. (optional)
            var language = language_example;  // String | The default language of the returned response. Overwrites the Accept-Language header. (optional)
            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 occupations - by URIs
                Occupations result = apiInstance.getOccupationByUri(curie, uris, language, selectedVersion, viewObsolete, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BulkOperationApi.getOccupationByUri: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBulkOperationApi();
$curie = curie_example; // String | The prefix of the provided URIs as parameters. CURIE (or Compact URI) defines a generic, abbreviated syntax for expressing Uniform Resource Identifiers (URIs).
$uris = ; // array[String] | The array of unique identifiers of the requested resources or the array of the end of unique identifiers if CURIE is defined.
$language = language_example; // String | The default language of the returned response. Overwrites the Accept-Language header.
$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->getOccupationByUri($curie, $uris, $language, $selectedVersion, $viewObsolete, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BulkOperationApi->getOccupationByUri: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BulkOperationApi;

my $api_instance = WWW::SwaggerClient::BulkOperationApi->new();
my $curie = curie_example; # String | The prefix of the provided URIs as parameters. CURIE (or Compact URI) defines a generic, abbreviated syntax for expressing Uniform Resource Identifiers (URIs).
my $uris = []; # array[String] | The array of unique identifiers of the requested resources or the array of the end of unique identifiers if CURIE is defined.
my $language = language_example; # String | The default language of the returned response. Overwrites the Accept-Language header.
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->getOccupationByUri(curie => $curie, uris => $uris, language => $language, selectedVersion => $selectedVersion, viewObsolete => $viewObsolete, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BulkOperationApi->getOccupationByUri: $@\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()
curie = curie_example # String | The prefix of the provided URIs as parameters. CURIE (or Compact URI) defines a generic, abbreviated syntax for expressing Uniform Resource Identifiers (URIs). (optional)
uris =  # array[String] | The array of unique identifiers of the requested resources or the array of the end of unique identifiers if CURIE is defined. (optional)
language = language_example # String | The default language of the returned response. Overwrites the Accept-Language header. (optional)
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 occupations - by URIs
    api_response = api_instance.get_occupation_by_uri(curie=curie, uris=uris, language=language, selectedVersion=selectedVersion, viewObsolete=viewObsolete, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BulkOperationApi->getOccupationByUri: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
The default language of the returned response. Optional and might be overwritten by the language request parameter.
Query parameters
Name Description
curie
String
The prefix of the provided URIs as parameters. CURIE (or Compact URI) defines a generic, abbreviated syntax for expressing Uniform Resource Identifiers (URIs).
uris
array[String]
The array of unique identifiers of the requested resources or the array of the end of unique identifiers if CURIE is defined.
language
String
The default language of the returned response. Overwrites the Accept-Language header.
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 Occupation 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

getSkillByConceptScheme

Get skills - by Concept Scheme

# Get a collection of resources of class Skill by the universal identifier (~ URI) of a Concept Scheme. This service is a bulk operation on the Get skill service.


/resource/skill

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json,application/json;charset=UTF-8"\
"http://127.0.0.1:8082/resource/skill?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 {
            Skills result = apiInstance.getSkillByConceptScheme(isInScheme, language, offset, limit, selectedVersion, viewObsolete, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BulkOperationApi#getSkillByConceptScheme");
            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 {
            Skills result = apiInstance.getSkillByConceptScheme(isInScheme, language, offset, limit, selectedVersion, viewObsolete, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BulkOperationApi#getSkillByConceptScheme");
            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 skills - by Concept Scheme
[apiInstance getSkillByConceptSchemeWith:isInScheme
    language:language
    offset:offset
    limit:limit
    selectedVersion:selectedVersion
    viewObsolete:viewObsolete
    acceptLanguage:acceptLanguage
              completionHandler: ^(Skills 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.getSkillByConceptScheme(isInScheme, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSkillByConceptSchemeExample
    {
        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 skills - by Concept Scheme
                Skills result = apiInstance.getSkillByConceptScheme(isInScheme, language, offset, limit, selectedVersion, viewObsolete, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BulkOperationApi.getSkillByConceptScheme: " + 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->getSkillByConceptScheme($isInScheme, $language, $offset, $limit, $selectedVersion, $viewObsolete, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BulkOperationApi->getSkillByConceptScheme: ', $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->getSkillByConceptScheme(isInScheme => $isInScheme, language => $language, offset => $offset, limit => $limit, selectedVersion => $selectedVersion, viewObsolete => $viewObsolete, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BulkOperationApi->getSkillByConceptScheme: $@\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 skills - by Concept Scheme
    api_response = api_instance.get_skill_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->getSkillByConceptScheme: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
The default language of the returned response. Optional and might be overwritten by the language request parameter.
Query parameters
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 Skill 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

getSkillByUri

Get skills - by URIs

# Get a collection of resources of class Skill by their universal identifiers (~ URIs). This service is a bulk operation on the Get skill service.


/resource/skill

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json,application/json;charset=UTF-8"\
"http://127.0.0.1:8082/resource/skill?curie=&uris=&language=&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 curie = curie_example; // String | The prefix of the provided URIs as parameters. CURIE (or Compact URI) defines a generic, abbreviated syntax for expressing Uniform Resource Identifiers (URIs).
        array[String] uris = ; // array[String] | The array of unique identifiers of the requested resources or the array of the end of unique identifiers if CURIE is defined.
        String language = language_example; // String | The default language of the returned response. Overwrites the Accept-Language header.
        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 {
            Skills result = apiInstance.getSkillByUri(curie, uris, language, selectedVersion, viewObsolete, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BulkOperationApi#getSkillByUri");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BulkOperationApi;

public class BulkOperationApiExample {

    public static void main(String[] args) {
        BulkOperationApi apiInstance = new BulkOperationApi();
        String curie = curie_example; // String | The prefix of the provided URIs as parameters. CURIE (or Compact URI) defines a generic, abbreviated syntax for expressing Uniform Resource Identifiers (URIs).
        array[String] uris = ; // array[String] | The array of unique identifiers of the requested resources or the array of the end of unique identifiers if CURIE is defined.
        String language = language_example; // String | The default language of the returned response. Overwrites the Accept-Language header.
        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 {
            Skills result = apiInstance.getSkillByUri(curie, uris, language, selectedVersion, viewObsolete, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BulkOperationApi#getSkillByUri");
            e.printStackTrace();
        }
    }
}
String *curie = curie_example; // The prefix of the provided URIs as parameters. CURIE (or Compact URI) defines a generic, abbreviated syntax for expressing Uniform Resource Identifiers (URIs). (optional)
array[String] *uris = ; // The array of unique identifiers of the requested resources or the array of the end of unique identifiers if CURIE is defined. (optional)
String *language = language_example; // The default language of the returned response. Overwrites the Accept-Language header. (optional)
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 skills - by URIs
[apiInstance getSkillByUriWith:curie
    uris:uris
    language:language
    selectedVersion:selectedVersion
    viewObsolete:viewObsolete
    acceptLanguage:acceptLanguage
              completionHandler: ^(Skills 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 opts = {
  'curie': curie_example, // {{String}} The prefix of the provided URIs as parameters. CURIE (or Compact URI) defines a generic, abbreviated syntax for expressing Uniform Resource Identifiers (URIs).
  'uris': , // {{array[String]}} The array of unique identifiers of the requested resources or the array of the end of unique identifiers if CURIE is defined.
  'language': language_example, // {{String}} The default language of the returned response. Overwrites the Accept-Language header.
  '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.getSkillByUri(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BulkOperationApi();
            var curie = curie_example;  // String | The prefix of the provided URIs as parameters. CURIE (or Compact URI) defines a generic, abbreviated syntax for expressing Uniform Resource Identifiers (URIs). (optional)
            var uris = new array[String](); // array[String] | The array of unique identifiers of the requested resources or the array of the end of unique identifiers if CURIE is defined. (optional)
            var language = language_example;  // String | The default language of the returned response. Overwrites the Accept-Language header. (optional)
            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 skills - by URIs
                Skills result = apiInstance.getSkillByUri(curie, uris, language, selectedVersion, viewObsolete, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BulkOperationApi.getSkillByUri: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBulkOperationApi();
$curie = curie_example; // String | The prefix of the provided URIs as parameters. CURIE (or Compact URI) defines a generic, abbreviated syntax for expressing Uniform Resource Identifiers (URIs).
$uris = ; // array[String] | The array of unique identifiers of the requested resources or the array of the end of unique identifiers if CURIE is defined.
$language = language_example; // String | The default language of the returned response. Overwrites the Accept-Language header.
$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->getSkillByUri($curie, $uris, $language, $selectedVersion, $viewObsolete, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BulkOperationApi->getSkillByUri: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BulkOperationApi;

my $api_instance = WWW::SwaggerClient::BulkOperationApi->new();
my $curie = curie_example; # String | The prefix of the provided URIs as parameters. CURIE (or Compact URI) defines a generic, abbreviated syntax for expressing Uniform Resource Identifiers (URIs).
my $uris = []; # array[String] | The array of unique identifiers of the requested resources or the array of the end of unique identifiers if CURIE is defined.
my $language = language_example; # String | The default language of the returned response. Overwrites the Accept-Language header.
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->getSkillByUri(curie => $curie, uris => $uris, language => $language, selectedVersion => $selectedVersion, viewObsolete => $viewObsolete, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BulkOperationApi->getSkillByUri: $@\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()
curie = curie_example # String | The prefix of the provided URIs as parameters. CURIE (or Compact URI) defines a generic, abbreviated syntax for expressing Uniform Resource Identifiers (URIs). (optional)
uris =  # array[String] | The array of unique identifiers of the requested resources or the array of the end of unique identifiers if CURIE is defined. (optional)
language = language_example # String | The default language of the returned response. Overwrites the Accept-Language header. (optional)
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 skills - by URIs
    api_response = api_instance.get_skill_by_uri(curie=curie, uris=uris, language=language, selectedVersion=selectedVersion, viewObsolete=viewObsolete, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BulkOperationApi->getSkillByUri: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
The default language of the returned response. Optional and might be overwritten by the language request parameter.
Query parameters
Name Description
curie
String
The prefix of the provided URIs as parameters. CURIE (or Compact URI) defines a generic, abbreviated syntax for expressing Uniform Resource Identifiers (URIs).
uris
array[String]
The array of unique identifiers of the requested resources or the array of the end of unique identifiers if CURIE is defined.
language
String
The default language of the returned response. Overwrites the Accept-Language header.
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 Skill 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

getTaxonomyByUri

Get concept schemes - by URIs

# Get a collection of resources of class Taxonomy (~ a concept scheme) by their universal identifiers (~ URIs). This service can be used as entry point for hierarchical display of ESCO resources. The returned Taxonomy resources include links to the top level concepts within the concept hierarchy of the concept scheme. This service is a bulk operation on the Get concept scheme service. **When curie parameter is defined then all the values in the uris list are prefixed by the CURIE value automatically and the twovalues together should provide real URIs of resources.**


/resource/taxonomy

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json,application/json;charset=UTF-8"\
"http://127.0.0.1:8082/resource/taxonomy?curie=&uris=&language=&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 curie = curie_example; // String | The prefix of the provided URIs as parameters. CURIE (or Compact URI) defines a generic, abbreviated syntax for expressing Uniform Resource Identifiers (URIs).
        array[String] uris = ; // array[String] | The array of unique identifiers of the requested resources or the array of the end of unique identifiers if CURIE is defined.
        String language = language_example; // String | The default language of the returned response. Overwrites the Accept-Language header.
        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 {
            Taxonomies result = apiInstance.getTaxonomyByUri(curie, uris, language, selectedVersion, viewObsolete, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BulkOperationApi#getTaxonomyByUri");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BulkOperationApi;

public class BulkOperationApiExample {

    public static void main(String[] args) {
        BulkOperationApi apiInstance = new BulkOperationApi();
        String curie = curie_example; // String | The prefix of the provided URIs as parameters. CURIE (or Compact URI) defines a generic, abbreviated syntax for expressing Uniform Resource Identifiers (URIs).
        array[String] uris = ; // array[String] | The array of unique identifiers of the requested resources or the array of the end of unique identifiers if CURIE is defined.
        String language = language_example; // String | The default language of the returned response. Overwrites the Accept-Language header.
        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 {
            Taxonomies result = apiInstance.getTaxonomyByUri(curie, uris, language, selectedVersion, viewObsolete, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BulkOperationApi#getTaxonomyByUri");
            e.printStackTrace();
        }
    }
}
String *curie = curie_example; // The prefix of the provided URIs as parameters. CURIE (or Compact URI) defines a generic, abbreviated syntax for expressing Uniform Resource Identifiers (URIs). (optional)
array[String] *uris = ; // The array of unique identifiers of the requested resources or the array of the end of unique identifiers if CURIE is defined. (optional)
String *language = language_example; // The default language of the returned response. Overwrites the Accept-Language header. (optional)
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 concept schemes - by URIs
[apiInstance getTaxonomyByUriWith:curie
    uris:uris
    language:language
    selectedVersion:selectedVersion
    viewObsolete:viewObsolete
    acceptLanguage:acceptLanguage
              completionHandler: ^(Taxonomies 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 opts = {
  'curie': curie_example, // {{String}} The prefix of the provided URIs as parameters. CURIE (or Compact URI) defines a generic, abbreviated syntax for expressing Uniform Resource Identifiers (URIs).
  'uris': , // {{array[String]}} The array of unique identifiers of the requested resources or the array of the end of unique identifiers if CURIE is defined.
  'language': language_example, // {{String}} The default language of the returned response. Overwrites the Accept-Language header.
  '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.getTaxonomyByUri(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BulkOperationApi();
            var curie = curie_example;  // String | The prefix of the provided URIs as parameters. CURIE (or Compact URI) defines a generic, abbreviated syntax for expressing Uniform Resource Identifiers (URIs). (optional)
            var uris = new array[String](); // array[String] | The array of unique identifiers of the requested resources or the array of the end of unique identifiers if CURIE is defined. (optional)
            var language = language_example;  // String | The default language of the returned response. Overwrites the Accept-Language header. (optional)
            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 concept schemes - by URIs
                Taxonomies result = apiInstance.getTaxonomyByUri(curie, uris, language, selectedVersion, viewObsolete, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BulkOperationApi.getTaxonomyByUri: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBulkOperationApi();
$curie = curie_example; // String | The prefix of the provided URIs as parameters. CURIE (or Compact URI) defines a generic, abbreviated syntax for expressing Uniform Resource Identifiers (URIs).
$uris = ; // array[String] | The array of unique identifiers of the requested resources or the array of the end of unique identifiers if CURIE is defined.
$language = language_example; // String | The default language of the returned response. Overwrites the Accept-Language header.
$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->getTaxonomyByUri($curie, $uris, $language, $selectedVersion, $viewObsolete, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BulkOperationApi->getTaxonomyByUri: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BulkOperationApi;

my $api_instance = WWW::SwaggerClient::BulkOperationApi->new();
my $curie = curie_example; # String | The prefix of the provided URIs as parameters. CURIE (or Compact URI) defines a generic, abbreviated syntax for expressing Uniform Resource Identifiers (URIs).
my $uris = []; # array[String] | The array of unique identifiers of the requested resources or the array of the end of unique identifiers if CURIE is defined.
my $language = language_example; # String | The default language of the returned response. Overwrites the Accept-Language header.
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->getTaxonomyByUri(curie => $curie, uris => $uris, language => $language, selectedVersion => $selectedVersion, viewObsolete => $viewObsolete, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BulkOperationApi->getTaxonomyByUri: $@\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()
curie = curie_example # String | The prefix of the provided URIs as parameters. CURIE (or Compact URI) defines a generic, abbreviated syntax for expressing Uniform Resource Identifiers (URIs). (optional)
uris =  # array[String] | The array of unique identifiers of the requested resources or the array of the end of unique identifiers if CURIE is defined. (optional)
language = language_example # String | The default language of the returned response. Overwrites the Accept-Language header. (optional)
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 concept schemes - by URIs
    api_response = api_instance.get_taxonomy_by_uri(curie=curie, uris=uris, language=language, selectedVersion=selectedVersion, viewObsolete=viewObsolete, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BulkOperationApi->getTaxonomyByUri: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
The default language of the returned response. Optional and might be overwritten by the language request parameter.
Query parameters
Name Description
curie
String
The prefix of the provided URIs as parameters. CURIE (or Compact URI) defines a generic, abbreviated syntax for expressing Uniform Resource Identifiers (URIs).
uris
array[String]
The array of unique identifiers of the requested resources or the array of the end of unique identifiers if CURIE is defined.
language
String
The default language of the returned response. Overwrites the Accept-Language header.
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 Taxonomy 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

resourceRelatedGet

Get related resources

# Get the related resources of a given resource by a given relation. By default a partial JSON Object representation of each related resource (~ a fragment) is returned. Passing the parameter 'full=true', will return a full JSON Object representation of each resource but this implies a higher response time. **Remark**: For concept resources (classes Occupation, Skill, Concept) an additional relation hasBroaderTransitive is supported


/resource/related

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json,application/json;charset=UTF-8"\
"http://127.0.0.1:8082/resource/related?uri=&relation=&language=&offset=&limit=&full=&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 uri = uri_example; // String | The unique identifier of the requested resource
        String relation = relation_example; // String | The relation to get the related resources for. Must be a known relation of the class the resource belongs to.
        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.
        Boolean full = true; // Boolean | If set to 'true' the full 'HAL' Object representation of each related resource is returned.
        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 {
            Relation result = apiInstance.resourceRelatedGet(uri, relation, language, offset, limit, full, selectedVersion, viewObsolete, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BulkOperationApi#resourceRelatedGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BulkOperationApi;

public class BulkOperationApiExample {

    public static void main(String[] args) {
        BulkOperationApi apiInstance = new BulkOperationApi();
        String uri = uri_example; // String | The unique identifier of the requested resource
        String relation = relation_example; // String | The relation to get the related resources for. Must be a known relation of the class the resource belongs to.
        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.
        Boolean full = true; // Boolean | If set to 'true' the full 'HAL' Object representation of each related resource is returned.
        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 {
            Relation result = apiInstance.resourceRelatedGet(uri, relation, language, offset, limit, full, selectedVersion, viewObsolete, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BulkOperationApi#resourceRelatedGet");
            e.printStackTrace();
        }
    }
}
String *uri = uri_example; // The unique identifier of the requested resource
String *relation = relation_example; // The relation to get the related resources for. Must be a known relation of the class the resource belongs to.
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)
Boolean *full = true; // If set to 'true' the full 'HAL' Object representation of each related resource is returned. (optional) (default to false)
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 related resources
[apiInstance resourceRelatedGetWith:uri
    relation:relation
    language:language
    offset:offset
    limit:limit
    full:full
    selectedVersion:selectedVersion
    viewObsolete:viewObsolete
    acceptLanguage:acceptLanguage
              completionHandler: ^(Relation 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 uri = uri_example; // {{String}} The unique identifier of the requested resource
var relation = relation_example; // {{String}} The relation to get the related resources for. Must be a known relation of the class the resource belongs to.
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.
  'full': true, // {{Boolean}} If set to 'true' the full 'HAL' Object representation of each related resource is returned.
  '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.resourceRelatedGet(uri, relation, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BulkOperationApi();
            var uri = uri_example;  // String | The unique identifier of the requested resource
            var relation = relation_example;  // String | The relation to get the related resources for. Must be a known relation of the class the resource belongs to.
            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 full = true;  // Boolean | If set to 'true' the full 'HAL' Object representation of each related resource is returned. (optional)  (default to false)
            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 related resources
                Relation result = apiInstance.resourceRelatedGet(uri, relation, language, offset, limit, full, selectedVersion, viewObsolete, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BulkOperationApi.resourceRelatedGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBulkOperationApi();
$uri = uri_example; // String | The unique identifier of the requested resource
$relation = relation_example; // String | The relation to get the related resources for. Must be a known relation of the class the resource belongs to.
$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.
$full = true; // Boolean | If set to 'true' the full 'HAL' Object representation of each related resource is returned.
$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->resourceRelatedGet($uri, $relation, $language, $offset, $limit, $full, $selectedVersion, $viewObsolete, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BulkOperationApi->resourceRelatedGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BulkOperationApi;

my $api_instance = WWW::SwaggerClient::BulkOperationApi->new();
my $uri = uri_example; # String | The unique identifier of the requested resource
my $relation = relation_example; # String | The relation to get the related resources for. Must be a known relation of the class the resource belongs to.
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 $full = true; # Boolean | If set to 'true' the full 'HAL' Object representation of each related resource is returned.
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->resourceRelatedGet(uri => $uri, relation => $relation, language => $language, offset => $offset, limit => $limit, full => $full, selectedVersion => $selectedVersion, viewObsolete => $viewObsolete, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BulkOperationApi->resourceRelatedGet: $@\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()
uri = uri_example # String | The unique identifier of the requested resource
relation = relation_example # String | The relation to get the related resources for. Must be a known relation of the class the resource belongs to.
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)
full = true # Boolean | If set to 'true' the full 'HAL' Object representation of each related resource is returned. (optional) (default to false)
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 related resources
    api_response = api_instance.resource_related_get(uri, relation, language=language, offset=offset, limit=limit, full=full, selectedVersion=selectedVersion, viewObsolete=viewObsolete, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BulkOperationApi->resourceRelatedGet: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
The default language of the returned response. Optional and might be overwritten by the language request parameter.
Query parameters
Name Description
uri*
String
The unique identifier of the requested resource
Required
relation*
String
The relation to get the related resources for. Must be a known relation of the class the resource belongs to.
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.
full
Boolean
If set to 'true' the full 'HAL' Object representation of each related resource is returned.
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 representation of the queried result set.

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

History

conversionConceptGet

Get Converted Concept

# Get a collection of converted resources of class Concept by the universal identifier (~ URI) in the target esco version. This endpoints finds the state of a given concept on the specified ESCO version. It may return with a collection of concepts if the searched concept was split into more on the expected version. In order to reconstruct how a concept was split and merged the isReplacedByTransitive relation can be used.


/conversion/concept

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json,application/json;charset=UTF-8"\
"http://127.0.0.1:8082/conversion/concept?uri=&language=&targetEscoVersion=&offset=&limit="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HistoryApi;

import java.io.File;
import java.util.*;

public class HistoryApiExample {

    public static void main(String[] args) {

        HistoryApi apiInstance = new HistoryApi();
        String uri = uri_example; // String | The unique identifier of the requested resource
        String language = language_example; // String | The default language of the returned response. Overwrites the Accept-Language header.
        String targetEscoVersion = targetEscoVersion_example; // String | The target esco version for the converted resource
        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 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.conversionConceptGet(uri, language, targetEscoVersion, offset, limit, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HistoryApi#conversionConceptGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HistoryApi;

public class HistoryApiExample {

    public static void main(String[] args) {
        HistoryApi apiInstance = new HistoryApi();
        String uri = uri_example; // String | The unique identifier of the requested resource
        String language = language_example; // String | The default language of the returned response. Overwrites the Accept-Language header.
        String targetEscoVersion = targetEscoVersion_example; // String | The target esco version for the converted resource
        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 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.conversionConceptGet(uri, language, targetEscoVersion, offset, limit, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HistoryApi#conversionConceptGet");
            e.printStackTrace();
        }
    }
}
String *uri = uri_example; // The unique identifier of the requested resource
String *language = language_example; // The default language of the returned response. Overwrites the Accept-Language header. (optional)
String *targetEscoVersion = targetEscoVersion_example; // The target esco version for the converted resource (optional) (default to latest)
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 *acceptLanguage = acceptLanguage_example; // The default language of the returned response. Optional and might be overwritten by the language request parameter. (optional)

HistoryApi *apiInstance = [[HistoryApi alloc] init];

// Get Converted Concept
[apiInstance conversionConceptGetWith:uri
    language:language
    targetEscoVersion:targetEscoVersion
    offset:offset
    limit:limit
    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.HistoryApi()
var uri = uri_example; // {{String}} The unique identifier of the requested resource
var opts = {
  'language': language_example, // {{String}} The default language of the returned response. Overwrites the Accept-Language header.
  'targetEscoVersion': targetEscoVersion_example, // {{String}} The target esco version for the converted resource
  '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.
  '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.conversionConceptGet(uri, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new HistoryApi();
            var uri = uri_example;  // String | The unique identifier of the requested resource
            var language = language_example;  // String | The default language of the returned response. Overwrites the Accept-Language header. (optional)
            var targetEscoVersion = targetEscoVersion_example;  // String | The target esco version for the converted resource (optional)  (default to latest)
            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 acceptLanguage = acceptLanguage_example;  // String | The default language of the returned response. Optional and might be overwritten by the language request parameter. (optional)

            try
            {
                // Get Converted Concept
                Concepts result = apiInstance.conversionConceptGet(uri, language, targetEscoVersion, offset, limit, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HistoryApi.conversionConceptGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiHistoryApi();
$uri = uri_example; // String | The unique identifier of the requested resource
$language = language_example; // String | The default language of the returned response. Overwrites the Accept-Language header.
$targetEscoVersion = targetEscoVersion_example; // String | The target esco version for the converted resource
$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.
$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->conversionConceptGet($uri, $language, $targetEscoVersion, $offset, $limit, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HistoryApi->conversionConceptGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HistoryApi;

my $api_instance = WWW::SwaggerClient::HistoryApi->new();
my $uri = uri_example; # String | The unique identifier of the requested resource
my $language = language_example; # String | The default language of the returned response. Overwrites the Accept-Language header.
my $targetEscoVersion = targetEscoVersion_example; # String | The target esco version for the converted resource
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 $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->conversionConceptGet(uri => $uri, language => $language, targetEscoVersion => $targetEscoVersion, offset => $offset, limit => $limit, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HistoryApi->conversionConceptGet: $@\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.HistoryApi()
uri = uri_example # String | The unique identifier of the requested resource
language = language_example # String | The default language of the returned response. Overwrites the Accept-Language header. (optional)
targetEscoVersion = targetEscoVersion_example # String | The target esco version for the converted resource (optional) (default to latest)
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)
acceptLanguage = acceptLanguage_example # String | The default language of the returned response. Optional and might be overwritten by the language request parameter. (optional)

try:
    # Get Converted Concept
    api_response = api_instance.conversion_concept_get(uri, language=language, targetEscoVersion=targetEscoVersion, offset=offset, limit=limit, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HistoryApi->conversionConceptGet: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
The default language of the returned response. Optional and might be overwritten by the language request parameter.
Query parameters
Name Description
uri*
String
The unique identifier of the requested resource
Required
language
String
The default language of the returned response. Overwrites the Accept-Language header.
targetEscoVersion
String
The target esco version for the converted resource
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.

Responses

Status: 200 - The payload of the response is a paginated 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

conversionOccupationGet

Get Converted Occupation

# Get a collection of converted resources of class Occupation by the universal identifier (~ URI) in the target esco version. This endpoints finds the state of a given concept on the specified ESCO version. It may return with a collection of concepts if the searched concept was split into more on the expected version. In order to reconstruct how a concept was split and merged the isReplacedByTransitive relation can be used.


/conversion/occupation

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json,application/json;charset=UTF-8"\
"http://127.0.0.1:8082/conversion/occupation?uri=&language=&targetEscoVersion=&offset=&limit="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HistoryApi;

import java.io.File;
import java.util.*;

public class HistoryApiExample {

    public static void main(String[] args) {

        HistoryApi apiInstance = new HistoryApi();
        String uri = uri_example; // String | The unique identifier of the requested resource
        String language = language_example; // String | The default language of the returned response. Overwrites the Accept-Language header.
        String targetEscoVersion = targetEscoVersion_example; // String | The target esco version for the converted resource
        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 acceptLanguage = acceptLanguage_example; // String | The default language of the returned response. Optional and might be overwritten by the language request parameter.
        try {
            Occupations result = apiInstance.conversionOccupationGet(uri, language, targetEscoVersion, offset, limit, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HistoryApi#conversionOccupationGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HistoryApi;

public class HistoryApiExample {

    public static void main(String[] args) {
        HistoryApi apiInstance = new HistoryApi();
        String uri = uri_example; // String | The unique identifier of the requested resource
        String language = language_example; // String | The default language of the returned response. Overwrites the Accept-Language header.
        String targetEscoVersion = targetEscoVersion_example; // String | The target esco version for the converted resource
        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 acceptLanguage = acceptLanguage_example; // String | The default language of the returned response. Optional and might be overwritten by the language request parameter.
        try {
            Occupations result = apiInstance.conversionOccupationGet(uri, language, targetEscoVersion, offset, limit, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HistoryApi#conversionOccupationGet");
            e.printStackTrace();
        }
    }
}
String *uri = uri_example; // The unique identifier of the requested resource
String *language = language_example; // The default language of the returned response. Overwrites the Accept-Language header. (optional)
String *targetEscoVersion = targetEscoVersion_example; // The target esco version for the converted resource (optional) (default to latest)
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 *acceptLanguage = acceptLanguage_example; // The default language of the returned response. Optional and might be overwritten by the language request parameter. (optional)

HistoryApi *apiInstance = [[HistoryApi alloc] init];

// Get Converted Occupation
[apiInstance conversionOccupationGetWith:uri
    language:language
    targetEscoVersion:targetEscoVersion
    offset:offset
    limit:limit
    acceptLanguage:acceptLanguage
              completionHandler: ^(Occupations output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EscoRestApiDocs = require('esco_rest_api_docs');

var api = new EscoRestApiDocs.HistoryApi()
var uri = uri_example; // {{String}} The unique identifier of the requested resource
var opts = {
  'language': language_example, // {{String}} The default language of the returned response. Overwrites the Accept-Language header.
  'targetEscoVersion': targetEscoVersion_example, // {{String}} The target esco version for the converted resource
  '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.
  '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.conversionOccupationGet(uri, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new HistoryApi();
            var uri = uri_example;  // String | The unique identifier of the requested resource
            var language = language_example;  // String | The default language of the returned response. Overwrites the Accept-Language header. (optional)
            var targetEscoVersion = targetEscoVersion_example;  // String | The target esco version for the converted resource (optional)  (default to latest)
            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 acceptLanguage = acceptLanguage_example;  // String | The default language of the returned response. Optional and might be overwritten by the language request parameter. (optional)

            try
            {
                // Get Converted Occupation
                Occupations result = apiInstance.conversionOccupationGet(uri, language, targetEscoVersion, offset, limit, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HistoryApi.conversionOccupationGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiHistoryApi();
$uri = uri_example; // String | The unique identifier of the requested resource
$language = language_example; // String | The default language of the returned response. Overwrites the Accept-Language header.
$targetEscoVersion = targetEscoVersion_example; // String | The target esco version for the converted resource
$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.
$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->conversionOccupationGet($uri, $language, $targetEscoVersion, $offset, $limit, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HistoryApi->conversionOccupationGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HistoryApi;

my $api_instance = WWW::SwaggerClient::HistoryApi->new();
my $uri = uri_example; # String | The unique identifier of the requested resource
my $language = language_example; # String | The default language of the returned response. Overwrites the Accept-Language header.
my $targetEscoVersion = targetEscoVersion_example; # String | The target esco version for the converted resource
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 $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->conversionOccupationGet(uri => $uri, language => $language, targetEscoVersion => $targetEscoVersion, offset => $offset, limit => $limit, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HistoryApi->conversionOccupationGet: $@\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.HistoryApi()
uri = uri_example # String | The unique identifier of the requested resource
language = language_example # String | The default language of the returned response. Overwrites the Accept-Language header. (optional)
targetEscoVersion = targetEscoVersion_example # String | The target esco version for the converted resource (optional) (default to latest)
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)
acceptLanguage = acceptLanguage_example # String | The default language of the returned response. Optional and might be overwritten by the language request parameter. (optional)

try:
    # Get Converted Occupation
    api_response = api_instance.conversion_occupation_get(uri, language=language, targetEscoVersion=targetEscoVersion, offset=offset, limit=limit, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HistoryApi->conversionOccupationGet: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
The default language of the returned response. Optional and might be overwritten by the language request parameter.
Query parameters
Name Description
uri*
String
The unique identifier of the requested resource
Required
language
String
The default language of the returned response. Overwrites the Accept-Language header.
targetEscoVersion
String
The target esco version for the converted resource
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.

Responses

Status: 200 - The payload of the response is a paginated JSON HAL Collection representation of a set of Occupation 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

conversionSkillGet

Get Converted Skill

# Get a collection of converted resources of class Skill by the universal identifier (~ URI) in the target esco version. This endpoints finds the state of a given concept on the specified ESCO version. It may return with a collection of concepts if the searched concept was split into more on the expected version. In order to reconstruct how a concept was split and merged the isReplacedByTransitive relation can be used.


/conversion/skill

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json,application/json;charset=UTF-8"\
"http://127.0.0.1:8082/conversion/skill?uri=&language=&targetEscoVersion=&offset=&limit="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HistoryApi;

import java.io.File;
import java.util.*;

public class HistoryApiExample {

    public static void main(String[] args) {

        HistoryApi apiInstance = new HistoryApi();
        String uri = uri_example; // String | The unique identifier of the requested resource
        String language = language_example; // String | The default language of the returned response. Overwrites the Accept-Language header.
        String targetEscoVersion = targetEscoVersion_example; // String | The target esco version for the converted resource
        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 acceptLanguage = acceptLanguage_example; // String | The default language of the returned response. Optional and might be overwritten by the language request parameter.
        try {
            Skills result = apiInstance.conversionSkillGet(uri, language, targetEscoVersion, offset, limit, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HistoryApi#conversionSkillGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HistoryApi;

public class HistoryApiExample {

    public static void main(String[] args) {
        HistoryApi apiInstance = new HistoryApi();
        String uri = uri_example; // String | The unique identifier of the requested resource
        String language = language_example; // String | The default language of the returned response. Overwrites the Accept-Language header.
        String targetEscoVersion = targetEscoVersion_example; // String | The target esco version for the converted resource
        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 acceptLanguage = acceptLanguage_example; // String | The default language of the returned response. Optional and might be overwritten by the language request parameter.
        try {
            Skills result = apiInstance.conversionSkillGet(uri, language, targetEscoVersion, offset, limit, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HistoryApi#conversionSkillGet");
            e.printStackTrace();
        }
    }
}
String *uri = uri_example; // The unique identifier of the requested resource
String *language = language_example; // The default language of the returned response. Overwrites the Accept-Language header. (optional)
String *targetEscoVersion = targetEscoVersion_example; // The target esco version for the converted resource (optional) (default to latest)
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 *acceptLanguage = acceptLanguage_example; // The default language of the returned response. Optional and might be overwritten by the language request parameter. (optional)

HistoryApi *apiInstance = [[HistoryApi alloc] init];

// Get Converted Skill
[apiInstance conversionSkillGetWith:uri
    language:language
    targetEscoVersion:targetEscoVersion
    offset:offset
    limit:limit
    acceptLanguage:acceptLanguage
              completionHandler: ^(Skills output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EscoRestApiDocs = require('esco_rest_api_docs');

var api = new EscoRestApiDocs.HistoryApi()
var uri = uri_example; // {{String}} The unique identifier of the requested resource
var opts = {
  'language': language_example, // {{String}} The default language of the returned response. Overwrites the Accept-Language header.
  'targetEscoVersion': targetEscoVersion_example, // {{String}} The target esco version for the converted resource
  '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.
  '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.conversionSkillGet(uri, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new HistoryApi();
            var uri = uri_example;  // String | The unique identifier of the requested resource
            var language = language_example;  // String | The default language of the returned response. Overwrites the Accept-Language header. (optional)
            var targetEscoVersion = targetEscoVersion_example;  // String | The target esco version for the converted resource (optional)  (default to latest)
            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 acceptLanguage = acceptLanguage_example;  // String | The default language of the returned response. Optional and might be overwritten by the language request parameter. (optional)

            try
            {
                // Get Converted Skill
                Skills result = apiInstance.conversionSkillGet(uri, language, targetEscoVersion, offset, limit, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HistoryApi.conversionSkillGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiHistoryApi();
$uri = uri_example; // String | The unique identifier of the requested resource
$language = language_example; // String | The default language of the returned response. Overwrites the Accept-Language header.
$targetEscoVersion = targetEscoVersion_example; // String | The target esco version for the converted resource
$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.
$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->conversionSkillGet($uri, $language, $targetEscoVersion, $offset, $limit, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HistoryApi->conversionSkillGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HistoryApi;

my $api_instance = WWW::SwaggerClient::HistoryApi->new();
my $uri = uri_example; # String | The unique identifier of the requested resource
my $language = language_example; # String | The default language of the returned response. Overwrites the Accept-Language header.
my $targetEscoVersion = targetEscoVersion_example; # String | The target esco version for the converted resource
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 $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->conversionSkillGet(uri => $uri, language => $language, targetEscoVersion => $targetEscoVersion, offset => $offset, limit => $limit, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HistoryApi->conversionSkillGet: $@\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.HistoryApi()
uri = uri_example # String | The unique identifier of the requested resource
language = language_example # String | The default language of the returned response. Overwrites the Accept-Language header. (optional)
targetEscoVersion = targetEscoVersion_example # String | The target esco version for the converted resource (optional) (default to latest)
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)
acceptLanguage = acceptLanguage_example # String | The default language of the returned response. Optional and might be overwritten by the language request parameter. (optional)

try:
    # Get Converted Skill
    api_response = api_instance.conversion_skill_get(uri, language=language, targetEscoVersion=targetEscoVersion, offset=offset, limit=limit, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HistoryApi->conversionSkillGet: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
The default language of the returned response. Optional and might be overwritten by the language request parameter.
Query parameters
Name Description
uri*
String
The unique identifier of the requested resource
Required
language
String
The default language of the returned response. Overwrites the Accept-Language header.
targetEscoVersion
String
The target esco version for the converted resource
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.

Responses

Status: 200 - The payload of the response is a paginated JSON HAL Collection representation of a set of Skill 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

historyGet

Get history

# Get delta changes of the specified concepts between ESCO version


/history

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json,application/json;charset=UTF-8"\
"http://127.0.0.1:8082/history?uri=&language=&fullHistory="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HistoryApi;

import java.io.File;
import java.util.*;

public class HistoryApiExample {

    public static void main(String[] args) {

        HistoryApi apiInstance = new HistoryApi();
        String uri = uri_example; // String | The unique identifier of the requested resource
        String language = language_example; // String | The default language of the returned response. Overwrites the Accept-Language header.
        Boolean fullHistory = true; // Boolean | If set to 'true' the full history will be returned for all ESCO versions.
        String acceptLanguage = acceptLanguage_example; // String | The default language of the returned response. Optional and might be overwritten by the language request parameter.
        try {
            'String' result = apiInstance.historyGet(uri, language, fullHistory, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HistoryApi#historyGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HistoryApi;

public class HistoryApiExample {

    public static void main(String[] args) {
        HistoryApi apiInstance = new HistoryApi();
        String uri = uri_example; // String | The unique identifier of the requested resource
        String language = language_example; // String | The default language of the returned response. Overwrites the Accept-Language header.
        Boolean fullHistory = true; // Boolean | If set to 'true' the full history will be returned for all ESCO versions.
        String acceptLanguage = acceptLanguage_example; // String | The default language of the returned response. Optional and might be overwritten by the language request parameter.
        try {
            'String' result = apiInstance.historyGet(uri, language, fullHistory, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HistoryApi#historyGet");
            e.printStackTrace();
        }
    }
}
String *uri = uri_example; // The unique identifier of the requested resource
String *language = language_example; // The default language of the returned response. Overwrites the Accept-Language header. (optional)
Boolean *fullHistory = true; // If set to 'true' the full history will be returned for all ESCO versions. (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)

HistoryApi *apiInstance = [[HistoryApi alloc] init];

// Get history
[apiInstance historyGetWith:uri
    language:language
    fullHistory:fullHistory
    acceptLanguage:acceptLanguage
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EscoRestApiDocs = require('esco_rest_api_docs');

var api = new EscoRestApiDocs.HistoryApi()
var uri = uri_example; // {{String}} The unique identifier of the requested resource
var opts = {
  'language': language_example, // {{String}} The default language of the returned response. Overwrites the Accept-Language header.
  'fullHistory': true, // {{Boolean}} If set to 'true' the full history will be returned for all ESCO versions.
  '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.historyGet(uri, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new HistoryApi();
            var uri = uri_example;  // String | The unique identifier of the requested resource
            var language = language_example;  // String | The default language of the returned response. Overwrites the Accept-Language header. (optional)
            var fullHistory = true;  // Boolean | If set to 'true' the full history will be returned for all ESCO versions. (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 history
                'String' result = apiInstance.historyGet(uri, language, fullHistory, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HistoryApi.historyGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiHistoryApi();
$uri = uri_example; // String | The unique identifier of the requested resource
$language = language_example; // String | The default language of the returned response. Overwrites the Accept-Language header.
$fullHistory = true; // Boolean | If set to 'true' the full history will be returned for all ESCO versions.
$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->historyGet($uri, $language, $fullHistory, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HistoryApi->historyGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HistoryApi;

my $api_instance = WWW::SwaggerClient::HistoryApi->new();
my $uri = uri_example; # String | The unique identifier of the requested resource
my $language = language_example; # String | The default language of the returned response. Overwrites the Accept-Language header.
my $fullHistory = true; # Boolean | If set to 'true' the full history will be returned for all ESCO versions.
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->historyGet(uri => $uri, language => $language, fullHistory => $fullHistory, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HistoryApi->historyGet: $@\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.HistoryApi()
uri = uri_example # String | The unique identifier of the requested resource
language = language_example # String | The default language of the returned response. Overwrites the Accept-Language header. (optional)
fullHistory = true # Boolean | If set to 'true' the full history will be returned for all ESCO versions. (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 history
    api_response = api_instance.history_get(uri, language=language, fullHistory=fullHistory, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HistoryApi->historyGet: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
The default language of the returned response. Optional and might be overwritten by the language request parameter.
Query parameters
Name Description
uri*
String
The unique identifier of the requested resource
Required
language
String
The default language of the returned response. Overwrites the Accept-Language header.
fullHistory
Boolean
If set to 'true' the full history will be returned for all ESCO versions.

Responses

Status: 200 - The payload of the response is JSON HAL Collection representation of a set of Skill 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