eLabFTW REST API v2 Documentation

ApiKeys

deleteApikey

Delete an API key.

Delete an API key


/apikeys/{id}

Usage and SDK Samples

curl -X DELETE\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/apikeys/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiKeysApi;

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

public class ApiKeysApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ApiKeysApi apiInstance = new ApiKeysApi();
        Integer id = 56; // Integer | ID of the API key
        try {
            apiInstance.deleteApikey(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiKeysApi#deleteApikey");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiKeysApi;

public class ApiKeysApiExample {

    public static void main(String[] args) {
        ApiKeysApi apiInstance = new ApiKeysApi();
        Integer id = 56; // Integer | ID of the API key
        try {
            apiInstance.deleteApikey(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiKeysApi#deleteApikey");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the API key

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

// Delete an API key.
[apiInstance deleteApikeyWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ApiKeysApi()
var id = 56; // {{Integer}} ID of the API key

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteApikey(id, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ApiKeysApi();
            var id = 56;  // Integer | ID of the API key

            try
            {
                // Delete an API key.
                apiInstance.deleteApikey(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApiKeysApi.deleteApikey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiApiKeysApi();
$id = 56; // Integer | ID of the API key

try {
    $api_instance->deleteApikey($id);
} catch (Exception $e) {
    echo 'Exception when calling ApiKeysApi->deleteApikey: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApiKeysApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ApiKeysApi->new();
my $id = 56; # Integer | ID of the API key

eval { 
    $api_instance->deleteApikey(id => $id);
};
if ($@) {
    warn "Exception when calling ApiKeysApi->deleteApikey: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ApiKeysApi()
id = 56 # Integer | ID of the API key

try: 
    # Delete an API key.
    api_instance.delete_apikey(id)
except ApiException as e:
    print("Exception when calling ApiKeysApi->deleteApikey: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the API key
Required

Responses

Status: 204 - The key was deleted


getApikeys

Read API keys

Get list of API keys for currently logged in user.


/apikeys

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/apikeys"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiKeysApi;

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

public class ApiKeysApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ApiKeysApi apiInstance = new ApiKeysApi();
        try {
            array[apikey] result = apiInstance.getApikeys();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiKeysApi#getApikeys");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiKeysApi;

public class ApiKeysApiExample {

    public static void main(String[] args) {
        ApiKeysApi apiInstance = new ApiKeysApi();
        try {
            array[apikey] result = apiInstance.getApikeys();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiKeysApi#getApikeys");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

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

// Read API keys
[apiInstance getApikeysWithCompletionHandler: 
              ^(array[apikey] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ApiKeysApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getApikeys(callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ApiKeysApi();

            try
            {
                // Read API keys
                array[apikey] result = apiInstance.getApikeys();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApiKeysApi.getApikeys: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiApiKeysApi();

try {
    $result = $api_instance->getApikeys();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiKeysApi->getApikeys: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApiKeysApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ApiKeysApi->new();

eval { 
    my $result = $api_instance->getApikeys();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiKeysApi->getApikeys: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ApiKeysApi()

try: 
    # Read API keys
    api_response = api_instance.get_apikeys()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiKeysApi->getApikeys: %s\n" % e)

Parameters

Responses

Status: 200 - List API keys for user


postApikeys

Create an API key

Create an API key. The cleartext key is sent back in the location header.


/apikeys

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/apikeys"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiKeysApi;

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

public class ApiKeysApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ApiKeysApi apiInstance = new ApiKeysApi();
        Apikeys_body body = ; // Apikeys_body | 
        try {
            apiInstance.postApikeys(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiKeysApi#postApikeys");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiKeysApi;

public class ApiKeysApiExample {

    public static void main(String[] args) {
        ApiKeysApi apiInstance = new ApiKeysApi();
        Apikeys_body body = ; // Apikeys_body | 
        try {
            apiInstance.postApikeys(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiKeysApi#postApikeys");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Apikeys_body *body = ; //  (optional)

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

// Create an API key
[apiInstance postApikeysWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ApiKeysApi()
var opts = { 
  'body':  // {{Apikeys_body}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.postApikeys(opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ApiKeysApi();
            var body = new Apikeys_body(); // Apikeys_body |  (optional) 

            try
            {
                // Create an API key
                apiInstance.postApikeys(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApiKeysApi.postApikeys: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiApiKeysApi();
$body = ; // Apikeys_body | 

try {
    $api_instance->postApikeys($body);
} catch (Exception $e) {
    echo 'Exception when calling ApiKeysApi->postApikeys: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApiKeysApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ApiKeysApi->new();
my $body = WWW::SwaggerClient::Object::Apikeys_body->new(); # Apikeys_body | 

eval { 
    $api_instance->postApikeys(body => $body);
};
if ($@) {
    warn "Exception when calling ApiKeysApi->postApikeys: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ApiKeysApi()
body =  # Apikeys_body |  (optional)

try: 
    # Create an API key
    api_instance.post_apikeys(body=body)
except ApiException as e:
    print("Exception when calling ApiKeysApi->postApikeys: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 201 - The key has been created.

Name Type Format Description
location String

Comments

deleteEntityComment

Delete an entity comment.

The comment gets deleted.


/{entity_type}/{id}/comments/{subid}

Usage and SDK Samples

curl -X DELETE\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/{entity_type}/{id}/comments/{subid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommentsApi;

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

public class CommentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        CommentsApi apiInstance = new CommentsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        Integer subid = 56; // Integer | ID of the comment
        try {
            apiInstance.deleteEntityComment(entityType, id, subid);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentsApi#deleteEntityComment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommentsApi;

public class CommentsApiExample {

    public static void main(String[] args) {
        CommentsApi apiInstance = new CommentsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        Integer subid = 56; // Integer | ID of the comment
        try {
            apiInstance.deleteEntityComment(entityType, id, subid);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentsApi#deleteEntityComment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *entityType = entityType_example; // Entity type
Integer *id = 56; // ID of the entity
Integer *subid = 56; // ID of the comment

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

// Delete an entity comment.
[apiInstance deleteEntityCommentWith:entityType
    id:id
    subid:subid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.CommentsApi()
var entityType = entityType_example; // {{String}} Entity type
var id = 56; // {{Integer}} ID of the entity
var subid = 56; // {{Integer}} ID of the comment

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteEntityComment(entityType, id, subid, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CommentsApi();
            var entityType = entityType_example;  // String | Entity type
            var id = 56;  // Integer | ID of the entity
            var subid = 56;  // Integer | ID of the comment

            try
            {
                // Delete an entity comment.
                apiInstance.deleteEntityComment(entityType, id, subid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommentsApi.deleteEntityComment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiCommentsApi();
$entityType = entityType_example; // String | Entity type
$id = 56; // Integer | ID of the entity
$subid = 56; // Integer | ID of the comment

try {
    $api_instance->deleteEntityComment($entityType, $id, $subid);
} catch (Exception $e) {
    echo 'Exception when calling CommentsApi->deleteEntityComment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CommentsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CommentsApi->new();
my $entityType = entityType_example; # String | Entity type
my $id = 56; # Integer | ID of the entity
my $subid = 56; # Integer | ID of the comment

eval { 
    $api_instance->deleteEntityComment(entityType => $entityType, id => $id, subid => $subid);
};
if ($@) {
    warn "Exception when calling CommentsApi->deleteEntityComment: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.CommentsApi()
entityType = entityType_example # String | Entity type
id = 56 # Integer | ID of the entity
subid = 56 # Integer | ID of the comment

try: 
    # Delete an entity comment.
    api_instance.delete_entity_comment(entityType, id, subid)
except ApiException as e:
    print("Exception when calling CommentsApi->deleteEntityComment: %s\n" % e)

Parameters

Path parameters
Name Description
entity_type*
String
Entity type
Required
id*
Integer
ID of the entity
Required
subid*
Integer
ID of the comment
Required

Responses

Status: 204 - The comment was deleted


patchEntityComment

Modify an entity comment.


/{entity_type}/{id}/comments/{subid}

Usage and SDK Samples

curl -X PATCH\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/{entity_type}/{id}/comments/{subid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommentsApi;

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

public class CommentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        CommentsApi apiInstance = new CommentsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        Integer subid = 56; // Integer | ID of the comment
        Comment body = ; // Comment | Parameters for patching an entity comment.
        try {
            comment result = apiInstance.patchEntityComment(entityType, id, subid, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentsApi#patchEntityComment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommentsApi;

public class CommentsApiExample {

    public static void main(String[] args) {
        CommentsApi apiInstance = new CommentsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        Integer subid = 56; // Integer | ID of the comment
        Comment body = ; // Comment | Parameters for patching an entity comment.
        try {
            comment result = apiInstance.patchEntityComment(entityType, id, subid, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentsApi#patchEntityComment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *entityType = entityType_example; // Entity type
Integer *id = 56; // ID of the entity
Integer *subid = 56; // ID of the comment
Comment *body = ; // Parameters for patching an entity comment. (optional)

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

// Modify an entity comment.
[apiInstance patchEntityCommentWith:entityType
    id:id
    subid:subid
    body:body
              completionHandler: ^(comment output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.CommentsApi()
var entityType = entityType_example; // {{String}} Entity type
var id = 56; // {{Integer}} ID of the entity
var subid = 56; // {{Integer}} ID of the comment
var opts = { 
  'body':  // {{Comment}} Parameters for patching an entity comment.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchEntityComment(entityTypeidsubid, opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CommentsApi();
            var entityType = entityType_example;  // String | Entity type
            var id = 56;  // Integer | ID of the entity
            var subid = 56;  // Integer | ID of the comment
            var body = new Comment(); // Comment | Parameters for patching an entity comment. (optional) 

            try
            {
                // Modify an entity comment.
                comment result = apiInstance.patchEntityComment(entityType, id, subid, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommentsApi.patchEntityComment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiCommentsApi();
$entityType = entityType_example; // String | Entity type
$id = 56; // Integer | ID of the entity
$subid = 56; // Integer | ID of the comment
$body = ; // Comment | Parameters for patching an entity comment.

try {
    $result = $api_instance->patchEntityComment($entityType, $id, $subid, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentsApi->patchEntityComment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CommentsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CommentsApi->new();
my $entityType = entityType_example; # String | Entity type
my $id = 56; # Integer | ID of the entity
my $subid = 56; # Integer | ID of the comment
my $body = WWW::SwaggerClient::Object::Comment->new(); # Comment | Parameters for patching an entity comment.

eval { 
    my $result = $api_instance->patchEntityComment(entityType => $entityType, id => $id, subid => $subid, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommentsApi->patchEntityComment: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.CommentsApi()
entityType = entityType_example # String | Entity type
id = 56 # Integer | ID of the entity
subid = 56 # Integer | ID of the comment
body =  # Comment | Parameters for patching an entity comment. (optional)

try: 
    # Modify an entity comment.
    api_response = api_instance.patch_entity_comment(entityType, id, subid, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommentsApi->patchEntityComment: %s\n" % e)

Parameters

Path parameters
Name Description
entity_type*
String
Entity type
Required
id*
Integer
ID of the entity
Required
subid*
Integer
ID of the comment
Required
Body parameters
Name Description
body

Responses

Status: 200 - The patched comment


postEntityComments

Create a comment.


/{entity_type}/{id}/comments

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/{entity_type}/{id}/comments"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommentsApi;

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

public class CommentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        CommentsApi apiInstance = new CommentsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        Id_comments_body body = ; // Id_comments_body | Parameters for creating a comment
        try {
            apiInstance.postEntityComments(entityType, id, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentsApi#postEntityComments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommentsApi;

public class CommentsApiExample {

    public static void main(String[] args) {
        CommentsApi apiInstance = new CommentsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        Id_comments_body body = ; // Id_comments_body | Parameters for creating a comment
        try {
            apiInstance.postEntityComments(entityType, id, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentsApi#postEntityComments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *entityType = entityType_example; // Entity type
Integer *id = 56; // ID of the entity
Id_comments_body *body = ; // Parameters for creating a comment (optional)

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

// Create a comment.
[apiInstance postEntityCommentsWith:entityType
    id:id
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.CommentsApi()
var entityType = entityType_example; // {{String}} Entity type
var id = 56; // {{Integer}} ID of the entity
var opts = { 
  'body':  // {{Id_comments_body}} Parameters for creating a comment
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.postEntityComments(entityTypeid, opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CommentsApi();
            var entityType = entityType_example;  // String | Entity type
            var id = 56;  // Integer | ID of the entity
            var body = new Id_comments_body(); // Id_comments_body | Parameters for creating a comment (optional) 

            try
            {
                // Create a comment.
                apiInstance.postEntityComments(entityType, id, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommentsApi.postEntityComments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiCommentsApi();
$entityType = entityType_example; // String | Entity type
$id = 56; // Integer | ID of the entity
$body = ; // Id_comments_body | Parameters for creating a comment

try {
    $api_instance->postEntityComments($entityType, $id, $body);
} catch (Exception $e) {
    echo 'Exception when calling CommentsApi->postEntityComments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CommentsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CommentsApi->new();
my $entityType = entityType_example; # String | Entity type
my $id = 56; # Integer | ID of the entity
my $body = WWW::SwaggerClient::Object::Id_comments_body->new(); # Id_comments_body | Parameters for creating a comment

eval { 
    $api_instance->postEntityComments(entityType => $entityType, id => $id, body => $body);
};
if ($@) {
    warn "Exception when calling CommentsApi->postEntityComments: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.CommentsApi()
entityType = entityType_example # String | Entity type
id = 56 # Integer | ID of the entity
body =  # Id_comments_body | Parameters for creating a comment (optional)

try: 
    # Create a comment.
    api_instance.post_entity_comments(entityType, id, body=body)
except ApiException as e:
    print("Exception when calling CommentsApi->postEntityComments: %s\n" % e)

Parameters

Path parameters
Name Description
entity_type*
String
Entity type
Required
id*
Integer
ID of the entity
Required
Body parameters
Name Description
body

Responses

Status: 201 - The comment has been created.

Name Type Format Description
location String

readEntityComment

Read a comment of that entity.


/{entity_type}/{id}/comments/{subid}

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/{entity_type}/{id}/comments/{subid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommentsApi;

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

public class CommentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        CommentsApi apiInstance = new CommentsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        Integer subid = 56; // Integer | ID of the comment
        try {
            comment result = apiInstance.readEntityComment(entityType, id, subid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentsApi#readEntityComment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommentsApi;

public class CommentsApiExample {

    public static void main(String[] args) {
        CommentsApi apiInstance = new CommentsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        Integer subid = 56; // Integer | ID of the comment
        try {
            comment result = apiInstance.readEntityComment(entityType, id, subid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentsApi#readEntityComment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *entityType = entityType_example; // Entity type
Integer *id = 56; // ID of the entity
Integer *subid = 56; // ID of the comment

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

// Read a comment of that entity.
[apiInstance readEntityCommentWith:entityType
    id:id
    subid:subid
              completionHandler: ^(comment output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.CommentsApi()
var entityType = entityType_example; // {{String}} Entity type
var id = 56; // {{Integer}} ID of the entity
var subid = 56; // {{Integer}} ID of the comment

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readEntityComment(entityType, id, subid, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CommentsApi();
            var entityType = entityType_example;  // String | Entity type
            var id = 56;  // Integer | ID of the entity
            var subid = 56;  // Integer | ID of the comment

            try
            {
                // Read a comment of that entity.
                comment result = apiInstance.readEntityComment(entityType, id, subid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommentsApi.readEntityComment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiCommentsApi();
$entityType = entityType_example; // String | Entity type
$id = 56; // Integer | ID of the entity
$subid = 56; // Integer | ID of the comment

try {
    $result = $api_instance->readEntityComment($entityType, $id, $subid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentsApi->readEntityComment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CommentsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CommentsApi->new();
my $entityType = entityType_example; # String | Entity type
my $id = 56; # Integer | ID of the entity
my $subid = 56; # Integer | ID of the comment

eval { 
    my $result = $api_instance->readEntityComment(entityType => $entityType, id => $id, subid => $subid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommentsApi->readEntityComment: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.CommentsApi()
entityType = entityType_example # String | Entity type
id = 56 # Integer | ID of the entity
subid = 56 # Integer | ID of the comment

try: 
    # Read a comment of that entity.
    api_response = api_instance.read_entity_comment(entityType, id, subid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommentsApi->readEntityComment: %s\n" % e)

Parameters

Path parameters
Name Description
entity_type*
String
Entity type
Required
id*
Integer
ID of the entity
Required
subid*
Integer
ID of the comment
Required

Responses

Status: 200 - A comment.


readEntityComments

Read all comments of that entity.


/{entity_type}/{id}/comments

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/{entity_type}/{id}/comments"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommentsApi;

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

public class CommentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        CommentsApi apiInstance = new CommentsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        try {
            array[comment] result = apiInstance.readEntityComments(entityType, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentsApi#readEntityComments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommentsApi;

public class CommentsApiExample {

    public static void main(String[] args) {
        CommentsApi apiInstance = new CommentsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        try {
            array[comment] result = apiInstance.readEntityComments(entityType, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentsApi#readEntityComments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *entityType = entityType_example; // Entity type
Integer *id = 56; // ID of the entity

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

// Read all comments of that entity.
[apiInstance readEntityCommentsWith:entityType
    id:id
              completionHandler: ^(array[comment] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.CommentsApi()
var entityType = entityType_example; // {{String}} Entity type
var id = 56; // {{Integer}} ID of the entity

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readEntityComments(entityType, id, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CommentsApi();
            var entityType = entityType_example;  // String | Entity type
            var id = 56;  // Integer | ID of the entity

            try
            {
                // Read all comments of that entity.
                array[comment] result = apiInstance.readEntityComments(entityType, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommentsApi.readEntityComments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiCommentsApi();
$entityType = entityType_example; // String | Entity type
$id = 56; // Integer | ID of the entity

try {
    $result = $api_instance->readEntityComments($entityType, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentsApi->readEntityComments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CommentsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CommentsApi->new();
my $entityType = entityType_example; # String | Entity type
my $id = 56; # Integer | ID of the entity

eval { 
    my $result = $api_instance->readEntityComments(entityType => $entityType, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommentsApi->readEntityComments: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.CommentsApi()
entityType = entityType_example # String | Entity type
id = 56 # Integer | ID of the entity

try: 
    # Read all comments of that entity.
    api_response = api_instance.read_entity_comments(entityType, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommentsApi->readEntityComments: %s\n" % e)

Parameters

Path parameters
Name Description
entity_type*
String
Entity type
Required
id*
Integer
ID of the entity
Required

Responses

Status: 200 - A list of comments


Config

deleteConfig

Reset the config to default values


/config

Usage and SDK Samples

curl -X DELETE\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/config"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConfigApi;

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

public class ConfigApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ConfigApi apiInstance = new ConfigApi();
        try {
            apiInstance.deleteConfig();
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigApi#deleteConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConfigApi;

public class ConfigApiExample {

    public static void main(String[] args) {
        ConfigApi apiInstance = new ConfigApi();
        try {
            apiInstance.deleteConfig();
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigApi#deleteConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

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

// Reset the config to default values
[apiInstance deleteConfigWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ConfigApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteConfig(callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ConfigApi();

            try
            {
                // Reset the config to default values
                apiInstance.deleteConfig();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConfigApi.deleteConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiConfigApi();

try {
    $api_instance->deleteConfig();
} catch (Exception $e) {
    echo 'Exception when calling ConfigApi->deleteConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConfigApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ConfigApi->new();

eval { 
    $api_instance->deleteConfig();
};
if ($@) {
    warn "Exception when calling ConfigApi->deleteConfig: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ConfigApi()

try: 
    # Reset the config to default values
    api_instance.delete_config()
except ApiException as e:
    print("Exception when calling ConfigApi->deleteConfig: %s\n" % e)

Parameters

Responses

Status: 204 - The config was reset.


getConfig

Read the config


/config

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/config"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConfigApi;

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

public class ConfigApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ConfigApi apiInstance = new ConfigApi();
        try {
            config result = apiInstance.getConfig();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigApi#getConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConfigApi;

public class ConfigApiExample {

    public static void main(String[] args) {
        ConfigApi apiInstance = new ConfigApi();
        try {
            config result = apiInstance.getConfig();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigApi#getConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

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

// Read the config
[apiInstance getConfigWithCompletionHandler: 
              ^(config output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ConfigApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConfig(callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ConfigApi();

            try
            {
                // Read the config
                config result = apiInstance.getConfig();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConfigApi.getConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiConfigApi();

try {
    $result = $api_instance->getConfig();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConfigApi->getConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConfigApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ConfigApi->new();

eval { 
    my $result = $api_instance->getConfig();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigApi->getConfig: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ConfigApi()

try: 
    # Read the config
    api_response = api_instance.get_config()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigApi->getConfig: %s\n" % e)

Parameters

Responses

Status: 200 - The config settings


patchConfig

Modify the config


/config

Usage and SDK Samples

curl -X PATCH\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/config"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConfigApi;

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

public class ConfigApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ConfigApi apiInstance = new ConfigApi();
        Config body = ; // Config | The config values to change.
        try {
            config result = apiInstance.patchConfig(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigApi#patchConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConfigApi;

public class ConfigApiExample {

    public static void main(String[] args) {
        ConfigApi apiInstance = new ConfigApi();
        Config body = ; // Config | The config values to change.
        try {
            config result = apiInstance.patchConfig(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigApi#patchConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Config *body = ; // The config values to change. (optional)

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

// Modify the config
[apiInstance patchConfigWith:body
              completionHandler: ^(config output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ConfigApi()
var opts = { 
  'body':  // {{Config}} The config values to change.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchConfig(opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ConfigApi();
            var body = new Config(); // Config | The config values to change. (optional) 

            try
            {
                // Modify the config
                config result = apiInstance.patchConfig(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConfigApi.patchConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiConfigApi();
$body = ; // Config | The config values to change.

try {
    $result = $api_instance->patchConfig($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConfigApi->patchConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConfigApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ConfigApi->new();
my $body = WWW::SwaggerClient::Object::Config->new(); # Config | The config values to change.

eval { 
    my $result = $api_instance->patchConfig(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigApi->patchConfig: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ConfigApi()
body =  # Config | The config values to change. (optional)

try: 
    # Modify the config
    api_response = api_instance.patch_config(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigApi->patchConfig: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - The config was modified.


Events

deleteEvent

Delete a booking slot.


/event/{id}

Usage and SDK Samples

curl -X DELETE\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/event/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EventsApi;

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

public class EventsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        EventsApi apiInstance = new EventsApi();
        Integer id = 56; // Integer | ID of the event to modify.
        try {
            apiInstance.deleteEvent(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventsApi#deleteEvent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EventsApi;

public class EventsApiExample {

    public static void main(String[] args) {
        EventsApi apiInstance = new EventsApi();
        Integer id = 56; // Integer | ID of the event to modify.
        try {
            apiInstance.deleteEvent(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventsApi#deleteEvent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the event to modify.

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

// Delete a booking slot.
[apiInstance deleteEventWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.EventsApi()
var id = 56; // {{Integer}} ID of the event to modify.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteEvent(id, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new EventsApi();
            var id = 56;  // Integer | ID of the event to modify.

            try
            {
                // Delete a booking slot.
                apiInstance.deleteEvent(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EventsApi.deleteEvent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiEventsApi();
$id = 56; // Integer | ID of the event to modify.

try {
    $api_instance->deleteEvent($id);
} catch (Exception $e) {
    echo 'Exception when calling EventsApi->deleteEvent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EventsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::EventsApi->new();
my $id = 56; # Integer | ID of the event to modify.

eval { 
    $api_instance->deleteEvent(id => $id);
};
if ($@) {
    warn "Exception when calling EventsApi->deleteEvent: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.EventsApi()
id = 56 # Integer | ID of the event to modify.

try: 
    # Delete a booking slot.
    api_instance.delete_event(id)
except ApiException as e:
    print("Exception when calling EventsApi->deleteEvent: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the event to modify.
Required

Responses

Status: 204 - The event was deleted.


patchEvent

Modify a booking slot. Warning: only one value (target) can be edited at a time.


/event/{id}

Usage and SDK Samples

curl -X PATCH\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/event/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EventsApi;

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

public class EventsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        EventsApi apiInstance = new EventsApi();
        Integer id = 56; // Integer | ID of the event to modify.
        Event_id_body body = ; // Event_id_body | Parameters for modifying an event.
        try {
            event result = apiInstance.patchEvent(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventsApi#patchEvent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EventsApi;

public class EventsApiExample {

    public static void main(String[] args) {
        EventsApi apiInstance = new EventsApi();
        Integer id = 56; // Integer | ID of the event to modify.
        Event_id_body body = ; // Event_id_body | Parameters for modifying an event.
        try {
            event result = apiInstance.patchEvent(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventsApi#patchEvent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the event to modify.
Event_id_body *body = ; // Parameters for modifying an event. (optional)

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

// Modify a booking slot. Warning: only one value (target) can be edited at a time.

[apiInstance patchEventWith:id
    body:body
              completionHandler: ^(event output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.EventsApi()
var id = 56; // {{Integer}} ID of the event to modify.
var opts = { 
  'body':  // {{Event_id_body}} Parameters for modifying an event.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchEvent(id, opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new EventsApi();
            var id = 56;  // Integer | ID of the event to modify.
            var body = new Event_id_body(); // Event_id_body | Parameters for modifying an event. (optional) 

            try
            {
                // Modify a booking slot. Warning: only one value (target) can be edited at a time.

                event result = apiInstance.patchEvent(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EventsApi.patchEvent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiEventsApi();
$id = 56; // Integer | ID of the event to modify.
$body = ; // Event_id_body | Parameters for modifying an event.

try {
    $result = $api_instance->patchEvent($id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EventsApi->patchEvent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EventsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::EventsApi->new();
my $id = 56; # Integer | ID of the event to modify.
my $body = WWW::SwaggerClient::Object::Event_id_body->new(); # Event_id_body | Parameters for modifying an event.

eval { 
    my $result = $api_instance->patchEvent(id => $id, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EventsApi->patchEvent: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.EventsApi()
id = 56 # Integer | ID of the event to modify.
body =  # Event_id_body | Parameters for modifying an event. (optional)

try: 
    # Modify a booking slot. Warning: only one value (target) can be edited at a time.

    api_response = api_instance.patch_event(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventsApi->patchEvent: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the event to modify.
Required
Body parameters
Name Description
body

Responses

Status: 200 - The patched event.


postEvents

Create an event for the item specified as id.


/events/{id}

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/events/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EventsApi;

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

public class EventsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        EventsApi apiInstance = new EventsApi();
        Integer id = 56; // Integer | ID of the item to book.
        Events_id_body body = ; // Events_id_body | Parameters for creating an event.
        try {
            apiInstance.postEvents(id, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventsApi#postEvents");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EventsApi;

public class EventsApiExample {

    public static void main(String[] args) {
        EventsApi apiInstance = new EventsApi();
        Integer id = 56; // Integer | ID of the item to book.
        Events_id_body body = ; // Events_id_body | Parameters for creating an event.
        try {
            apiInstance.postEvents(id, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventsApi#postEvents");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the item to book.
Events_id_body *body = ; // Parameters for creating an event. (optional)

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

// Create an event for the item specified as id.
[apiInstance postEventsWith:id
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.EventsApi()
var id = 56; // {{Integer}} ID of the item to book.
var opts = { 
  'body':  // {{Events_id_body}} Parameters for creating an event.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.postEvents(id, opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new EventsApi();
            var id = 56;  // Integer | ID of the item to book.
            var body = new Events_id_body(); // Events_id_body | Parameters for creating an event. (optional) 

            try
            {
                // Create an event for the item specified as id.
                apiInstance.postEvents(id, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EventsApi.postEvents: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiEventsApi();
$id = 56; // Integer | ID of the item to book.
$body = ; // Events_id_body | Parameters for creating an event.

try {
    $api_instance->postEvents($id, $body);
} catch (Exception $e) {
    echo 'Exception when calling EventsApi->postEvents: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EventsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::EventsApi->new();
my $id = 56; # Integer | ID of the item to book.
my $body = WWW::SwaggerClient::Object::Events_id_body->new(); # Events_id_body | Parameters for creating an event.

eval { 
    $api_instance->postEvents(id => $id, body => $body);
};
if ($@) {
    warn "Exception when calling EventsApi->postEvents: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.EventsApi()
id = 56 # Integer | ID of the item to book.
body =  # Events_id_body | Parameters for creating an event. (optional)

try: 
    # Create an event for the item specified as id.
    api_instance.post_events(id, body=body)
except ApiException as e:
    print("Exception when calling EventsApi->postEvents: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the item to book.
Required
Body parameters
Name Description
body

Responses

Status: 201 - The booking slot has been created.

Name Type Format Description
location String

readEvent

Read a booking slot.


/event/{id}

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/event/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EventsApi;

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

public class EventsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        EventsApi apiInstance = new EventsApi();
        Integer id = 56; // Integer | ID of the event to modify.
        try {
            event result = apiInstance.readEvent(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventsApi#readEvent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EventsApi;

public class EventsApiExample {

    public static void main(String[] args) {
        EventsApi apiInstance = new EventsApi();
        Integer id = 56; // Integer | ID of the event to modify.
        try {
            event result = apiInstance.readEvent(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventsApi#readEvent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the event to modify.

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

// Read a booking slot.
[apiInstance readEventWith:id
              completionHandler: ^(event output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.EventsApi()
var id = 56; // {{Integer}} ID of the event to modify.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readEvent(id, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new EventsApi();
            var id = 56;  // Integer | ID of the event to modify.

            try
            {
                // Read a booking slot.
                event result = apiInstance.readEvent(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EventsApi.readEvent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiEventsApi();
$id = 56; // Integer | ID of the event to modify.

try {
    $result = $api_instance->readEvent($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EventsApi->readEvent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EventsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::EventsApi->new();
my $id = 56; # Integer | ID of the event to modify.

eval { 
    my $result = $api_instance->readEvent(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EventsApi->readEvent: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.EventsApi()
id = 56 # Integer | ID of the event to modify.

try: 
    # Read a booking slot.
    api_response = api_instance.read_event(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventsApi->readEvent: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the event to modify.
Required

Responses

Status: 200 - A particular event


readEvents

Read all events in the team.


/events

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/events"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EventsApi;

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

public class EventsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        EventsApi apiInstance = new EventsApi();
        try {
            array[event] result = apiInstance.readEvents();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventsApi#readEvents");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EventsApi;

public class EventsApiExample {

    public static void main(String[] args) {
        EventsApi apiInstance = new EventsApi();
        try {
            array[event] result = apiInstance.readEvents();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventsApi#readEvents");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

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

// Read all events in the team.
[apiInstance readEventsWithCompletionHandler: 
              ^(array[event] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.EventsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readEvents(callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new EventsApi();

            try
            {
                // Read all events in the team.
                array[event] result = apiInstance.readEvents();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EventsApi.readEvents: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiEventsApi();

try {
    $result = $api_instance->readEvents();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EventsApi->readEvents: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EventsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::EventsApi->new();

eval { 
    my $result = $api_instance->readEvents();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EventsApi->readEvents: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.EventsApi()

try: 
    # Read all events in the team.
    api_response = api_instance.read_events()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventsApi->readEvents: %s\n" % e)

Parameters

Responses

Status: 200 - A list of booked slots.


Experiments

deleteExperiment

Delete an experiment.

The experiment gets soft-deleted.


/experiments/{id}

Usage and SDK Samples

curl -X DELETE\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/experiments/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExperimentsApi;

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

public class ExperimentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ExperimentsApi apiInstance = new ExperimentsApi();
        Integer id = 56; // Integer | ID of the experiment
        try {
            apiInstance.deleteExperiment(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExperimentsApi#deleteExperiment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExperimentsApi;

public class ExperimentsApiExample {

    public static void main(String[] args) {
        ExperimentsApi apiInstance = new ExperimentsApi();
        Integer id = 56; // Integer | ID of the experiment
        try {
            apiInstance.deleteExperiment(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExperimentsApi#deleteExperiment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the experiment

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

// Delete an experiment.
[apiInstance deleteExperimentWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ExperimentsApi()
var id = 56; // {{Integer}} ID of the experiment

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteExperiment(id, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ExperimentsApi();
            var id = 56;  // Integer | ID of the experiment

            try
            {
                // Delete an experiment.
                apiInstance.deleteExperiment(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExperimentsApi.deleteExperiment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiExperimentsApi();
$id = 56; // Integer | ID of the experiment

try {
    $api_instance->deleteExperiment($id);
} catch (Exception $e) {
    echo 'Exception when calling ExperimentsApi->deleteExperiment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExperimentsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ExperimentsApi->new();
my $id = 56; # Integer | ID of the experiment

eval { 
    $api_instance->deleteExperiment(id => $id);
};
if ($@) {
    warn "Exception when calling ExperimentsApi->deleteExperiment: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ExperimentsApi()
id = 56 # Integer | ID of the experiment

try: 
    # Delete an experiment.
    api_instance.delete_experiment(id)
except ApiException as e:
    print("Exception when calling ExperimentsApi->deleteExperiment: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the experiment
Required

Responses

Status: 204 - The experiment was deleted


getExperiment

Read an experiment


/experiments/{id}

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/experiments/{id}?format="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExperimentsApi;

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

public class ExperimentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ExperimentsApi apiInstance = new ExperimentsApi();
        Integer id = 56; // Integer | ID of the experiment
        String format = format_example; // String | Get the entity in a different format like csv, pdf, eln or zip. "pdfa" means archive pdf (PDF/A), same with "zipa".

        try {
            experiment result = apiInstance.getExperiment(id, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExperimentsApi#getExperiment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExperimentsApi;

public class ExperimentsApiExample {

    public static void main(String[] args) {
        ExperimentsApi apiInstance = new ExperimentsApi();
        Integer id = 56; // Integer | ID of the experiment
        String format = format_example; // String | Get the entity in a different format like csv, pdf, eln or zip. "pdfa" means archive pdf (PDF/A), same with "zipa".

        try {
            experiment result = apiInstance.getExperiment(id, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExperimentsApi#getExperiment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the experiment
String *format = format_example; // Get the entity in a different format like csv, pdf, eln or zip. "pdfa" means archive pdf (PDF/A), same with "zipa".
 (optional) (default to json)

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

// Read an experiment
[apiInstance getExperimentWith:id
    format:format
              completionHandler: ^(experiment output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ExperimentsApi()
var id = 56; // {{Integer}} ID of the experiment
var opts = { 
  'format': format_example // {{String}} Get the entity in a different format like csv, pdf, eln or zip. "pdfa" means archive pdf (PDF/A), same with "zipa".

};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getExperiment(id, opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ExperimentsApi();
            var id = 56;  // Integer | ID of the experiment
            var format = format_example;  // String | Get the entity in a different format like csv, pdf, eln or zip. "pdfa" means archive pdf (PDF/A), same with "zipa".
 (optional)  (default to json)

            try
            {
                // Read an experiment
                experiment result = apiInstance.getExperiment(id, format);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExperimentsApi.getExperiment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiExperimentsApi();
$id = 56; // Integer | ID of the experiment
$format = format_example; // String | Get the entity in a different format like csv, pdf, eln or zip. "pdfa" means archive pdf (PDF/A), same with "zipa".


try {
    $result = $api_instance->getExperiment($id, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExperimentsApi->getExperiment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExperimentsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ExperimentsApi->new();
my $id = 56; # Integer | ID of the experiment
my $format = format_example; # String | Get the entity in a different format like csv, pdf, eln or zip. "pdfa" means archive pdf (PDF/A), same with "zipa".


eval { 
    my $result = $api_instance->getExperiment(id => $id, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExperimentsApi->getExperiment: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ExperimentsApi()
id = 56 # Integer | ID of the experiment
format = format_example # String | Get the entity in a different format like csv, pdf, eln or zip. "pdfa" means archive pdf (PDF/A), same with "zipa".
 (optional) (default to json)

try: 
    # Read an experiment
    api_response = api_instance.get_experiment(id, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExperimentsApi->getExperiment: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the experiment
Required
Query parameters
Name Description
format
String
Get the entity in a different format like csv, pdf, eln or zip. "pdfa" means archive pdf (PDF/A), same with "zipa".

Responses

Status: 200 - An experiment


patchExperiment

Modify an experiment


/experiments/{id}

Usage and SDK Samples

curl -X PATCH\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/experiments/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExperimentsApi;

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

public class ExperimentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ExperimentsApi apiInstance = new ExperimentsApi();
        Integer id = 56; // Integer | ID of the experiment
        Experiments_id_body body = ; // Experiments_id_body | Parameters for patching an item
        try {
            experiment result = apiInstance.patchExperiment(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExperimentsApi#patchExperiment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExperimentsApi;

public class ExperimentsApiExample {

    public static void main(String[] args) {
        ExperimentsApi apiInstance = new ExperimentsApi();
        Integer id = 56; // Integer | ID of the experiment
        Experiments_id_body body = ; // Experiments_id_body | Parameters for patching an item
        try {
            experiment result = apiInstance.patchExperiment(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExperimentsApi#patchExperiment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the experiment
Experiments_id_body *body = ; // Parameters for patching an item (optional)

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

// Modify an experiment
[apiInstance patchExperimentWith:id
    body:body
              completionHandler: ^(experiment output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ExperimentsApi()
var id = 56; // {{Integer}} ID of the experiment
var opts = { 
  'body':  // {{Experiments_id_body}} Parameters for patching an item
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchExperiment(id, opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ExperimentsApi();
            var id = 56;  // Integer | ID of the experiment
            var body = new Experiments_id_body(); // Experiments_id_body | Parameters for patching an item (optional) 

            try
            {
                // Modify an experiment
                experiment result = apiInstance.patchExperiment(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExperimentsApi.patchExperiment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiExperimentsApi();
$id = 56; // Integer | ID of the experiment
$body = ; // Experiments_id_body | Parameters for patching an item

try {
    $result = $api_instance->patchExperiment($id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExperimentsApi->patchExperiment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExperimentsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ExperimentsApi->new();
my $id = 56; # Integer | ID of the experiment
my $body = WWW::SwaggerClient::Object::Experiments_id_body->new(); # Experiments_id_body | Parameters for patching an item

eval { 
    my $result = $api_instance->patchExperiment(id => $id, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExperimentsApi->patchExperiment: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ExperimentsApi()
id = 56 # Integer | ID of the experiment
body =  # Experiments_id_body | Parameters for patching an item (optional)

try: 
    # Modify an experiment
    api_response = api_instance.patch_experiment(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExperimentsApi->patchExperiment: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the experiment
Required
Body parameters
Name Description
body

Responses

Status: 200 - The patched experiment


postExperiment

Create an experiment


/experiments

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/experiments"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExperimentsApi;

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

public class ExperimentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ExperimentsApi apiInstance = new ExperimentsApi();
        Experiments_body body = ; // Experiments_body | Parameters for creating an experiment
        try {
            apiInstance.postExperiment(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExperimentsApi#postExperiment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExperimentsApi;

public class ExperimentsApiExample {

    public static void main(String[] args) {
        ExperimentsApi apiInstance = new ExperimentsApi();
        Experiments_body body = ; // Experiments_body | Parameters for creating an experiment
        try {
            apiInstance.postExperiment(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExperimentsApi#postExperiment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Experiments_body *body = ; // Parameters for creating an experiment (optional)

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

// Create an experiment
[apiInstance postExperimentWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ExperimentsApi()
var opts = { 
  'body':  // {{Experiments_body}} Parameters for creating an experiment
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.postExperiment(opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ExperimentsApi();
            var body = new Experiments_body(); // Experiments_body | Parameters for creating an experiment (optional) 

            try
            {
                // Create an experiment
                apiInstance.postExperiment(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExperimentsApi.postExperiment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiExperimentsApi();
$body = ; // Experiments_body | Parameters for creating an experiment

try {
    $api_instance->postExperiment($body);
} catch (Exception $e) {
    echo 'Exception when calling ExperimentsApi->postExperiment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExperimentsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ExperimentsApi->new();
my $body = WWW::SwaggerClient::Object::Experiments_body->new(); # Experiments_body | Parameters for creating an experiment

eval { 
    $api_instance->postExperiment(body => $body);
};
if ($@) {
    warn "Exception when calling ExperimentsApi->postExperiment: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ExperimentsApi()
body =  # Experiments_body | Parameters for creating an experiment (optional)

try: 
    # Create an experiment
    api_instance.post_experiment(body=body)
except ApiException as e:
    print("Exception when calling ExperimentsApi->postExperiment: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 201 - The experiment has been created.

Name Type Format Description
location String

readExperiments

Read all experiments that are accessible


/experiments

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/experiments?q=&extended=&related=&cat=&tags[]=&limit=&offset=&owner="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExperimentsApi;

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

public class ExperimentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ExperimentsApi apiInstance = new ExperimentsApi();
        String q = q_example; // String | Search for a term in title, body or elabid.

        String extended = extended_example; // String | Extended search (advanced query).

        Integer related = 56; // Integer | Look only for entries linked to this item id.

        Integer cat = 56; // Integer | The status id of the experiments.

        array[String] tags[] = ; // array[String] | An array of tags for filtering results containing all of these tags.

        Integer limit = 56; // Integer | Limit the number of results.

        Integer offset = 56; // Integer | Skip a number of results. Use with limit to work the pagination.

        Integer owner = 56; // Integer | Filter results by author (user id)

        try {
            array[experiment] result = apiInstance.readExperiments(q, extended, related, cat, tags[], limit, offset, owner);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExperimentsApi#readExperiments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExperimentsApi;

public class ExperimentsApiExample {

    public static void main(String[] args) {
        ExperimentsApi apiInstance = new ExperimentsApi();
        String q = q_example; // String | Search for a term in title, body or elabid.

        String extended = extended_example; // String | Extended search (advanced query).

        Integer related = 56; // Integer | Look only for entries linked to this item id.

        Integer cat = 56; // Integer | The status id of the experiments.

        array[String] tags[] = ; // array[String] | An array of tags for filtering results containing all of these tags.

        Integer limit = 56; // Integer | Limit the number of results.

        Integer offset = 56; // Integer | Skip a number of results. Use with limit to work the pagination.

        Integer owner = 56; // Integer | Filter results by author (user id)

        try {
            array[experiment] result = apiInstance.readExperiments(q, extended, related, cat, tags[], limit, offset, owner);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExperimentsApi#readExperiments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *q = q_example; // Search for a term in title, body or elabid.
 (optional)
String *extended = extended_example; // Extended search (advanced query).
 (optional)
Integer *related = 56; // Look only for entries linked to this item id.
 (optional)
Integer *cat = 56; // The status id of the experiments.
 (optional)
array[String] *tags[] = ; // An array of tags for filtering results containing all of these tags.
 (optional)
Integer *limit = 56; // Limit the number of results.
 (optional) (default to 15)
Integer *offset = 56; // Skip a number of results. Use with limit to work the pagination.
 (optional) (default to 0)
Integer *owner = 56; // Filter results by author (user id)
 (optional)

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

// Read all experiments that are accessible
[apiInstance readExperimentsWith:q
    extended:extended
    related:related
    cat:cat
    tags[]:tags[]
    limit:limit
    offset:offset
    owner:owner
              completionHandler: ^(array[experiment] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ExperimentsApi()
var opts = { 
  'q': q_example, // {{String}} Search for a term in title, body or elabid.

  'extended': extended_example, // {{String}} Extended search (advanced query).

  'related': 56, // {{Integer}} Look only for entries linked to this item id.

  'cat': 56, // {{Integer}} The status id of the experiments.

  'tags[]': , // {{array[String]}} An array of tags for filtering results containing all of these tags.

  'limit': 56, // {{Integer}} Limit the number of results.

  'offset': 56, // {{Integer}} Skip a number of results. Use with limit to work the pagination.

  'owner': 56 // {{Integer}} Filter results by author (user id)

};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readExperiments(opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ExperimentsApi();
            var q = q_example;  // String | Search for a term in title, body or elabid.
 (optional) 
            var extended = extended_example;  // String | Extended search (advanced query).
 (optional) 
            var related = 56;  // Integer | Look only for entries linked to this item id.
 (optional) 
            var cat = 56;  // Integer | The status id of the experiments.
 (optional) 
            var tags[] = new array[String](); // array[String] | An array of tags for filtering results containing all of these tags.
 (optional) 
            var limit = 56;  // Integer | Limit the number of results.
 (optional)  (default to 15)
            var offset = 56;  // Integer | Skip a number of results. Use with limit to work the pagination.
 (optional)  (default to 0)
            var owner = 56;  // Integer | Filter results by author (user id)
 (optional) 

            try
            {
                // Read all experiments that are accessible
                array[experiment] result = apiInstance.readExperiments(q, extended, related, cat, tags[], limit, offset, owner);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExperimentsApi.readExperiments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiExperimentsApi();
$q = q_example; // String | Search for a term in title, body or elabid.

$extended = extended_example; // String | Extended search (advanced query).

$related = 56; // Integer | Look only for entries linked to this item id.

$cat = 56; // Integer | The status id of the experiments.

$tags[] = ; // array[String] | An array of tags for filtering results containing all of these tags.

$limit = 56; // Integer | Limit the number of results.

$offset = 56; // Integer | Skip a number of results. Use with limit to work the pagination.

$owner = 56; // Integer | Filter results by author (user id)


try {
    $result = $api_instance->readExperiments($q, $extended, $related, $cat, $tags[], $limit, $offset, $owner);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExperimentsApi->readExperiments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExperimentsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ExperimentsApi->new();
my $q = q_example; # String | Search for a term in title, body or elabid.

my $extended = extended_example; # String | Extended search (advanced query).

my $related = 56; # Integer | Look only for entries linked to this item id.

my $cat = 56; # Integer | The status id of the experiments.

my $tags[] = []; # array[String] | An array of tags for filtering results containing all of these tags.

my $limit = 56; # Integer | Limit the number of results.

my $offset = 56; # Integer | Skip a number of results. Use with limit to work the pagination.

my $owner = 56; # Integer | Filter results by author (user id)


eval { 
    my $result = $api_instance->readExperiments(q => $q, extended => $extended, related => $related, cat => $cat, tags[] => $tags[], limit => $limit, offset => $offset, owner => $owner);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExperimentsApi->readExperiments: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ExperimentsApi()
q = q_example # String | Search for a term in title, body or elabid.
 (optional)
extended = extended_example # String | Extended search (advanced query).
 (optional)
related = 56 # Integer | Look only for entries linked to this item id.
 (optional)
cat = 56 # Integer | The status id of the experiments.
 (optional)
tags[] =  # array[String] | An array of tags for filtering results containing all of these tags.
 (optional)
limit = 56 # Integer | Limit the number of results.
 (optional) (default to 15)
offset = 56 # Integer | Skip a number of results. Use with limit to work the pagination.
 (optional) (default to 0)
owner = 56 # Integer | Filter results by author (user id)
 (optional)

try: 
    # Read all experiments that are accessible
    api_response = api_instance.read_experiments(q=q, extended=extended, related=related, cat=cat, tags[]=tags[], limit=limit, offset=offset, owner=owner)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExperimentsApi->readExperiments: %s\n" % e)

Parameters

Query parameters
Name Description
q
String
Search for a term in title, body or elabid.
extended
String
Extended search (advanced query).
related
cat
Integer
The status id of the experiments.
tags[]
array[String]
An array of tags for filtering results containing all of these tags.
limit
Integer
Limit the number of results.
offset
Integer
Skip a number of results. Use with limit to work the pagination.
owner
Integer
Filter results by author (user id)

Responses

Status: 200 - A list of experiments


ExperimentsCategories

deleteExpcat

Delete a category.


/teams/{id}/experiments_categories/{subid}

Usage and SDK Samples

curl -X DELETE\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/teams/{id}/experiments_categories/{subid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExperimentsCategoriesApi;

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

public class ExperimentsCategoriesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ExperimentsCategoriesApi apiInstance = new ExperimentsCategoriesApi();
        Integer id = 56; // Integer | ID of the team.
        Integer subid = 56; // Integer | ID of the category
        try {
            apiInstance.deleteExpcat(id, subid);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExperimentsCategoriesApi#deleteExpcat");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExperimentsCategoriesApi;

public class ExperimentsCategoriesApiExample {

    public static void main(String[] args) {
        ExperimentsCategoriesApi apiInstance = new ExperimentsCategoriesApi();
        Integer id = 56; // Integer | ID of the team.
        Integer subid = 56; // Integer | ID of the category
        try {
            apiInstance.deleteExpcat(id, subid);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExperimentsCategoriesApi#deleteExpcat");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the team.
Integer *subid = 56; // ID of the category

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

// Delete a category.
[apiInstance deleteExpcatWith:id
    subid:subid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ExperimentsCategoriesApi()
var id = 56; // {{Integer}} ID of the team.
var subid = 56; // {{Integer}} ID of the category

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteExpcat(id, subid, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ExperimentsCategoriesApi();
            var id = 56;  // Integer | ID of the team.
            var subid = 56;  // Integer | ID of the category

            try
            {
                // Delete a category.
                apiInstance.deleteExpcat(id, subid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExperimentsCategoriesApi.deleteExpcat: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiExperimentsCategoriesApi();
$id = 56; // Integer | ID of the team.
$subid = 56; // Integer | ID of the category

try {
    $api_instance->deleteExpcat($id, $subid);
} catch (Exception $e) {
    echo 'Exception when calling ExperimentsCategoriesApi->deleteExpcat: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExperimentsCategoriesApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ExperimentsCategoriesApi->new();
my $id = 56; # Integer | ID of the team.
my $subid = 56; # Integer | ID of the category

eval { 
    $api_instance->deleteExpcat(id => $id, subid => $subid);
};
if ($@) {
    warn "Exception when calling ExperimentsCategoriesApi->deleteExpcat: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ExperimentsCategoriesApi()
id = 56 # Integer | ID of the team.
subid = 56 # Integer | ID of the category

try: 
    # Delete a category.
    api_instance.delete_expcat(id, subid)
except ApiException as e:
    print("Exception when calling ExperimentsCategoriesApi->deleteExpcat: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the team.
Required
subid*
Integer
ID of the category
Required

Responses

Status: 204 - The category was removed.


patchExpcat

Modify a category.


/teams/{id}/experiments_categories/{subid}

Usage and SDK Samples

curl -X PATCH\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/teams/{id}/experiments_categories/{subid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExperimentsCategoriesApi;

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

public class ExperimentsCategoriesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ExperimentsCategoriesApi apiInstance = new ExperimentsCategoriesApi();
        Integer id = 56; // Integer | ID of the team.
        Integer subid = 56; // Integer | ID of the category
        Statuslike body = ; // Statuslike | Parameters for modifying a category.
        try {
            statuslike result = apiInstance.patchExpcat(id, subid, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExperimentsCategoriesApi#patchExpcat");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExperimentsCategoriesApi;

public class ExperimentsCategoriesApiExample {

    public static void main(String[] args) {
        ExperimentsCategoriesApi apiInstance = new ExperimentsCategoriesApi();
        Integer id = 56; // Integer | ID of the team.
        Integer subid = 56; // Integer | ID of the category
        Statuslike body = ; // Statuslike | Parameters for modifying a category.
        try {
            statuslike result = apiInstance.patchExpcat(id, subid, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExperimentsCategoriesApi#patchExpcat");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the team.
Integer *subid = 56; // ID of the category
Statuslike *body = ; // Parameters for modifying a category. (optional)

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

// Modify a category.
[apiInstance patchExpcatWith:id
    subid:subid
    body:body
              completionHandler: ^(statuslike output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ExperimentsCategoriesApi()
var id = 56; // {{Integer}} ID of the team.
var subid = 56; // {{Integer}} ID of the category
var opts = { 
  'body':  // {{Statuslike}} Parameters for modifying a category.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchExpcat(idsubid, opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ExperimentsCategoriesApi();
            var id = 56;  // Integer | ID of the team.
            var subid = 56;  // Integer | ID of the category
            var body = new Statuslike(); // Statuslike | Parameters for modifying a category. (optional) 

            try
            {
                // Modify a category.
                statuslike result = apiInstance.patchExpcat(id, subid, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExperimentsCategoriesApi.patchExpcat: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiExperimentsCategoriesApi();
$id = 56; // Integer | ID of the team.
$subid = 56; // Integer | ID of the category
$body = ; // Statuslike | Parameters for modifying a category.

try {
    $result = $api_instance->patchExpcat($id, $subid, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExperimentsCategoriesApi->patchExpcat: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExperimentsCategoriesApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ExperimentsCategoriesApi->new();
my $id = 56; # Integer | ID of the team.
my $subid = 56; # Integer | ID of the category
my $body = WWW::SwaggerClient::Object::Statuslike->new(); # Statuslike | Parameters for modifying a category.

eval { 
    my $result = $api_instance->patchExpcat(id => $id, subid => $subid, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExperimentsCategoriesApi->patchExpcat: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ExperimentsCategoriesApi()
id = 56 # Integer | ID of the team.
subid = 56 # Integer | ID of the category
body =  # Statuslike | Parameters for modifying a category. (optional)

try: 
    # Modify a category.
    api_response = api_instance.patch_expcat(id, subid, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExperimentsCategoriesApi->patchExpcat: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the team.
Required
subid*
Integer
ID of the category
Required
Body parameters
Name Description
body

Responses

Status: 200 - The updated category.


postTeamOneExpcat

Create a new experiments status.


/teams/{id}/experiments_categories

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/teams/{id}/experiments_categories"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExperimentsCategoriesApi;

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

public class ExperimentsCategoriesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ExperimentsCategoriesApi apiInstance = new ExperimentsCategoriesApi();
        Integer id = 56; // Integer | ID of the team.
        Id_experiments_categories_body body = ; // Id_experiments_categories_body | Parameters for creating a status.
        try {
            apiInstance.postTeamOneExpcat(id, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExperimentsCategoriesApi#postTeamOneExpcat");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExperimentsCategoriesApi;

public class ExperimentsCategoriesApiExample {

    public static void main(String[] args) {
        ExperimentsCategoriesApi apiInstance = new ExperimentsCategoriesApi();
        Integer id = 56; // Integer | ID of the team.
        Id_experiments_categories_body body = ; // Id_experiments_categories_body | Parameters for creating a status.
        try {
            apiInstance.postTeamOneExpcat(id, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExperimentsCategoriesApi#postTeamOneExpcat");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the team.
Id_experiments_categories_body *body = ; // Parameters for creating a status. (optional)

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

// Create a new experiments status.
[apiInstance postTeamOneExpcatWith:id
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ExperimentsCategoriesApi()
var id = 56; // {{Integer}} ID of the team.
var opts = { 
  'body':  // {{Id_experiments_categories_body}} Parameters for creating a status.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.postTeamOneExpcat(id, opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ExperimentsCategoriesApi();
            var id = 56;  // Integer | ID of the team.
            var body = new Id_experiments_categories_body(); // Id_experiments_categories_body | Parameters for creating a status. (optional) 

            try
            {
                // Create a new experiments status.
                apiInstance.postTeamOneExpcat(id, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExperimentsCategoriesApi.postTeamOneExpcat: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiExperimentsCategoriesApi();
$id = 56; // Integer | ID of the team.
$body = ; // Id_experiments_categories_body | Parameters for creating a status.

try {
    $api_instance->postTeamOneExpcat($id, $body);
} catch (Exception $e) {
    echo 'Exception when calling ExperimentsCategoriesApi->postTeamOneExpcat: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExperimentsCategoriesApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ExperimentsCategoriesApi->new();
my $id = 56; # Integer | ID of the team.
my $body = WWW::SwaggerClient::Object::Id_experiments_categories_body->new(); # Id_experiments_categories_body | Parameters for creating a status.

eval { 
    $api_instance->postTeamOneExpcat(id => $id, body => $body);
};
if ($@) {
    warn "Exception when calling ExperimentsCategoriesApi->postTeamOneExpcat: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ExperimentsCategoriesApi()
id = 56 # Integer | ID of the team.
body =  # Id_experiments_categories_body | Parameters for creating a status. (optional)

try: 
    # Create a new experiments status.
    api_instance.post_team_one_expcat(id, body=body)
except ApiException as e:
    print("Exception when calling ExperimentsCategoriesApi->postTeamOneExpcat: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the team.
Required
Body parameters
Name Description
body

Responses

Status: 201 - Create a status.

Name Type Format Description
location String

readTeamExperimentsCategories

Read experiments categories of a team.


/teams/{id}/experiments_categories

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/teams/{id}/experiments_categories"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExperimentsCategoriesApi;

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

public class ExperimentsCategoriesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ExperimentsCategoriesApi apiInstance = new ExperimentsCategoriesApi();
        Integer id = 56; // Integer | ID of the team.
        try {
            array[statuslike] result = apiInstance.readTeamExperimentsCategories(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExperimentsCategoriesApi#readTeamExperimentsCategories");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExperimentsCategoriesApi;

public class ExperimentsCategoriesApiExample {

    public static void main(String[] args) {
        ExperimentsCategoriesApi apiInstance = new ExperimentsCategoriesApi();
        Integer id = 56; // Integer | ID of the team.
        try {
            array[statuslike] result = apiInstance.readTeamExperimentsCategories(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExperimentsCategoriesApi#readTeamExperimentsCategories");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the team.

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

// Read experiments categories of a team.
[apiInstance readTeamExperimentsCategoriesWith:id
              completionHandler: ^(array[statuslike] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ExperimentsCategoriesApi()
var id = 56; // {{Integer}} ID of the team.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readTeamExperimentsCategories(id, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ExperimentsCategoriesApi();
            var id = 56;  // Integer | ID of the team.

            try
            {
                // Read experiments categories of a team.
                array[statuslike] result = apiInstance.readTeamExperimentsCategories(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExperimentsCategoriesApi.readTeamExperimentsCategories: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiExperimentsCategoriesApi();
$id = 56; // Integer | ID of the team.

try {
    $result = $api_instance->readTeamExperimentsCategories($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExperimentsCategoriesApi->readTeamExperimentsCategories: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExperimentsCategoriesApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ExperimentsCategoriesApi->new();
my $id = 56; # Integer | ID of the team.

eval { 
    my $result = $api_instance->readTeamExperimentsCategories(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExperimentsCategoriesApi->readTeamExperimentsCategories: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ExperimentsCategoriesApi()
id = 56 # Integer | ID of the team.

try: 
    # Read experiments categories of a team.
    api_response = api_instance.read_team_experiments_categories(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExperimentsCategoriesApi->readTeamExperimentsCategories: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the team.
Required

Responses

Status: 200 - A list of experiments categories for the team.


readTeamOneExpcat

Read a category.


/teams/{id}/experiments_categories/{subid}

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/teams/{id}/experiments_categories/{subid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExperimentsCategoriesApi;

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

public class ExperimentsCategoriesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ExperimentsCategoriesApi apiInstance = new ExperimentsCategoriesApi();
        Integer id = 56; // Integer | ID of the team.
        Integer subid = 56; // Integer | ID of the category
        try {
            statuslike result = apiInstance.readTeamOneExpcat(id, subid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExperimentsCategoriesApi#readTeamOneExpcat");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExperimentsCategoriesApi;

public class ExperimentsCategoriesApiExample {

    public static void main(String[] args) {
        ExperimentsCategoriesApi apiInstance = new ExperimentsCategoriesApi();
        Integer id = 56; // Integer | ID of the team.
        Integer subid = 56; // Integer | ID of the category
        try {
            statuslike result = apiInstance.readTeamOneExpcat(id, subid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExperimentsCategoriesApi#readTeamOneExpcat");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the team.
Integer *subid = 56; // ID of the category

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

// Read a category.
[apiInstance readTeamOneExpcatWith:id
    subid:subid
              completionHandler: ^(statuslike output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ExperimentsCategoriesApi()
var id = 56; // {{Integer}} ID of the team.
var subid = 56; // {{Integer}} ID of the category

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readTeamOneExpcat(id, subid, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ExperimentsCategoriesApi();
            var id = 56;  // Integer | ID of the team.
            var subid = 56;  // Integer | ID of the category

            try
            {
                // Read a category.
                statuslike result = apiInstance.readTeamOneExpcat(id, subid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExperimentsCategoriesApi.readTeamOneExpcat: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiExperimentsCategoriesApi();
$id = 56; // Integer | ID of the team.
$subid = 56; // Integer | ID of the category

try {
    $result = $api_instance->readTeamOneExpcat($id, $subid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExperimentsCategoriesApi->readTeamOneExpcat: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExperimentsCategoriesApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ExperimentsCategoriesApi->new();
my $id = 56; # Integer | ID of the team.
my $subid = 56; # Integer | ID of the category

eval { 
    my $result = $api_instance->readTeamOneExpcat(id => $id, subid => $subid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExperimentsCategoriesApi->readTeamOneExpcat: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ExperimentsCategoriesApi()
id = 56 # Integer | ID of the team.
subid = 56 # Integer | ID of the category

try: 
    # Read a category.
    api_response = api_instance.read_team_one_expcat(id, subid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExperimentsCategoriesApi->readTeamOneExpcat: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the team.
Required
subid*
Integer
ID of the category
Required

Responses

Status: 200 - Read a category.


ExperimentsStatus

deleteExpstatus

Delete a status.


/teams/{id}/experiments_status/{subid}

Usage and SDK Samples

curl -X DELETE\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/teams/{id}/experiments_status/{subid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExperimentsStatusApi;

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

public class ExperimentsStatusApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ExperimentsStatusApi apiInstance = new ExperimentsStatusApi();
        Integer id = 56; // Integer | ID of the team.
        Integer subid = 56; // Integer | ID of the status
        try {
            apiInstance.deleteExpstatus(id, subid);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExperimentsStatusApi#deleteExpstatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExperimentsStatusApi;

public class ExperimentsStatusApiExample {

    public static void main(String[] args) {
        ExperimentsStatusApi apiInstance = new ExperimentsStatusApi();
        Integer id = 56; // Integer | ID of the team.
        Integer subid = 56; // Integer | ID of the status
        try {
            apiInstance.deleteExpstatus(id, subid);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExperimentsStatusApi#deleteExpstatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the team.
Integer *subid = 56; // ID of the status

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

// Delete a status.
[apiInstance deleteExpstatusWith:id
    subid:subid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ExperimentsStatusApi()
var id = 56; // {{Integer}} ID of the team.
var subid = 56; // {{Integer}} ID of the status

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteExpstatus(id, subid, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ExperimentsStatusApi();
            var id = 56;  // Integer | ID of the team.
            var subid = 56;  // Integer | ID of the status

            try
            {
                // Delete a status.
                apiInstance.deleteExpstatus(id, subid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExperimentsStatusApi.deleteExpstatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiExperimentsStatusApi();
$id = 56; // Integer | ID of the team.
$subid = 56; // Integer | ID of the status

try {
    $api_instance->deleteExpstatus($id, $subid);
} catch (Exception $e) {
    echo 'Exception when calling ExperimentsStatusApi->deleteExpstatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExperimentsStatusApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ExperimentsStatusApi->new();
my $id = 56; # Integer | ID of the team.
my $subid = 56; # Integer | ID of the status

eval { 
    $api_instance->deleteExpstatus(id => $id, subid => $subid);
};
if ($@) {
    warn "Exception when calling ExperimentsStatusApi->deleteExpstatus: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ExperimentsStatusApi()
id = 56 # Integer | ID of the team.
subid = 56 # Integer | ID of the status

try: 
    # Delete a status.
    api_instance.delete_expstatus(id, subid)
except ApiException as e:
    print("Exception when calling ExperimentsStatusApi->deleteExpstatus: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the team.
Required
subid*
Integer
ID of the status
Required

Responses

Status: 204 - The status was removed.


patchExpstatus

Modify a status.


/teams/{id}/experiments_status/{subid}

Usage and SDK Samples

curl -X PATCH\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/teams/{id}/experiments_status/{subid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExperimentsStatusApi;

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

public class ExperimentsStatusApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ExperimentsStatusApi apiInstance = new ExperimentsStatusApi();
        Integer id = 56; // Integer | ID of the team.
        Integer subid = 56; // Integer | ID of the status
        Statuslike body = ; // Statuslike | Parameters for modifying a status.
        try {
            statuslike result = apiInstance.patchExpstatus(id, subid, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExperimentsStatusApi#patchExpstatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExperimentsStatusApi;

public class ExperimentsStatusApiExample {

    public static void main(String[] args) {
        ExperimentsStatusApi apiInstance = new ExperimentsStatusApi();
        Integer id = 56; // Integer | ID of the team.
        Integer subid = 56; // Integer | ID of the status
        Statuslike body = ; // Statuslike | Parameters for modifying a status.
        try {
            statuslike result = apiInstance.patchExpstatus(id, subid, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExperimentsStatusApi#patchExpstatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the team.
Integer *subid = 56; // ID of the status
Statuslike *body = ; // Parameters for modifying a status. (optional)

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

// Modify a status.
[apiInstance patchExpstatusWith:id
    subid:subid
    body:body
              completionHandler: ^(statuslike output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ExperimentsStatusApi()
var id = 56; // {{Integer}} ID of the team.
var subid = 56; // {{Integer}} ID of the status
var opts = { 
  'body':  // {{Statuslike}} Parameters for modifying a status.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchExpstatus(idsubid, opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ExperimentsStatusApi();
            var id = 56;  // Integer | ID of the team.
            var subid = 56;  // Integer | ID of the status
            var body = new Statuslike(); // Statuslike | Parameters for modifying a status. (optional) 

            try
            {
                // Modify a status.
                statuslike result = apiInstance.patchExpstatus(id, subid, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExperimentsStatusApi.patchExpstatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiExperimentsStatusApi();
$id = 56; // Integer | ID of the team.
$subid = 56; // Integer | ID of the status
$body = ; // Statuslike | Parameters for modifying a status.

try {
    $result = $api_instance->patchExpstatus($id, $subid, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExperimentsStatusApi->patchExpstatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExperimentsStatusApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ExperimentsStatusApi->new();
my $id = 56; # Integer | ID of the team.
my $subid = 56; # Integer | ID of the status
my $body = WWW::SwaggerClient::Object::Statuslike->new(); # Statuslike | Parameters for modifying a status.

eval { 
    my $result = $api_instance->patchExpstatus(id => $id, subid => $subid, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExperimentsStatusApi->patchExpstatus: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ExperimentsStatusApi()
id = 56 # Integer | ID of the team.
subid = 56 # Integer | ID of the status
body =  # Statuslike | Parameters for modifying a status. (optional)

try: 
    # Modify a status.
    api_response = api_instance.patch_expstatus(id, subid, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExperimentsStatusApi->patchExpstatus: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the team.
Required
subid*
Integer
ID of the status
Required
Body parameters
Name Description
body

Responses

Status: 200 - The updated status.


postTeamOneExpstatus

Create a new experiments status.


/teams/{id}/experiments_status

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/teams/{id}/experiments_status"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExperimentsStatusApi;

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

public class ExperimentsStatusApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ExperimentsStatusApi apiInstance = new ExperimentsStatusApi();
        Integer id = 56; // Integer | ID of the team.
        Id_experiments_status_body body = ; // Id_experiments_status_body | Parameters for creating a status.
        try {
            apiInstance.postTeamOneExpstatus(id, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExperimentsStatusApi#postTeamOneExpstatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExperimentsStatusApi;

public class ExperimentsStatusApiExample {

    public static void main(String[] args) {
        ExperimentsStatusApi apiInstance = new ExperimentsStatusApi();
        Integer id = 56; // Integer | ID of the team.
        Id_experiments_status_body body = ; // Id_experiments_status_body | Parameters for creating a status.
        try {
            apiInstance.postTeamOneExpstatus(id, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExperimentsStatusApi#postTeamOneExpstatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the team.
Id_experiments_status_body *body = ; // Parameters for creating a status. (optional)

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

// Create a new experiments status.
[apiInstance postTeamOneExpstatusWith:id
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ExperimentsStatusApi()
var id = 56; // {{Integer}} ID of the team.
var opts = { 
  'body':  // {{Id_experiments_status_body}} Parameters for creating a status.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.postTeamOneExpstatus(id, opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ExperimentsStatusApi();
            var id = 56;  // Integer | ID of the team.
            var body = new Id_experiments_status_body(); // Id_experiments_status_body | Parameters for creating a status. (optional) 

            try
            {
                // Create a new experiments status.
                apiInstance.postTeamOneExpstatus(id, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExperimentsStatusApi.postTeamOneExpstatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiExperimentsStatusApi();
$id = 56; // Integer | ID of the team.
$body = ; // Id_experiments_status_body | Parameters for creating a status.

try {
    $api_instance->postTeamOneExpstatus($id, $body);
} catch (Exception $e) {
    echo 'Exception when calling ExperimentsStatusApi->postTeamOneExpstatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExperimentsStatusApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ExperimentsStatusApi->new();
my $id = 56; # Integer | ID of the team.
my $body = WWW::SwaggerClient::Object::Id_experiments_status_body->new(); # Id_experiments_status_body | Parameters for creating a status.

eval { 
    $api_instance->postTeamOneExpstatus(id => $id, body => $body);
};
if ($@) {
    warn "Exception when calling ExperimentsStatusApi->postTeamOneExpstatus: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ExperimentsStatusApi()
id = 56 # Integer | ID of the team.
body =  # Id_experiments_status_body | Parameters for creating a status. (optional)

try: 
    # Create a new experiments status.
    api_instance.post_team_one_expstatus(id, body=body)
except ApiException as e:
    print("Exception when calling ExperimentsStatusApi->postTeamOneExpstatus: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the team.
Required
Body parameters
Name Description
body

Responses

Status: 201 - New experiments status created.

Name Type Format Description
location String

readTeamExperimentsStatus

Read experiments status of a team.


/teams/{id}/experiments_status

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/teams/{id}/experiments_status"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExperimentsStatusApi;

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

public class ExperimentsStatusApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ExperimentsStatusApi apiInstance = new ExperimentsStatusApi();
        Integer id = 56; // Integer | ID of the team.
        try {
            array[statuslike] result = apiInstance.readTeamExperimentsStatus(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExperimentsStatusApi#readTeamExperimentsStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExperimentsStatusApi;

public class ExperimentsStatusApiExample {

    public static void main(String[] args) {
        ExperimentsStatusApi apiInstance = new ExperimentsStatusApi();
        Integer id = 56; // Integer | ID of the team.
        try {
            array[statuslike] result = apiInstance.readTeamExperimentsStatus(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExperimentsStatusApi#readTeamExperimentsStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the team.

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

// Read experiments status of a team.
[apiInstance readTeamExperimentsStatusWith:id
              completionHandler: ^(array[statuslike] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ExperimentsStatusApi()
var id = 56; // {{Integer}} ID of the team.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readTeamExperimentsStatus(id, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ExperimentsStatusApi();
            var id = 56;  // Integer | ID of the team.

            try
            {
                // Read experiments status of a team.
                array[statuslike] result = apiInstance.readTeamExperimentsStatus(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExperimentsStatusApi.readTeamExperimentsStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiExperimentsStatusApi();
$id = 56; // Integer | ID of the team.

try {
    $result = $api_instance->readTeamExperimentsStatus($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExperimentsStatusApi->readTeamExperimentsStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExperimentsStatusApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ExperimentsStatusApi->new();
my $id = 56; # Integer | ID of the team.

eval { 
    my $result = $api_instance->readTeamExperimentsStatus(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExperimentsStatusApi->readTeamExperimentsStatus: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ExperimentsStatusApi()
id = 56 # Integer | ID of the team.

try: 
    # Read experiments status of a team.
    api_response = api_instance.read_team_experiments_status(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExperimentsStatusApi->readTeamExperimentsStatus: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the team.
Required

Responses

Status: 200 - A list of status for the team.


readTeamOneExpstatus

Read a status.


/teams/{id}/experiments_status/{subid}

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/teams/{id}/experiments_status/{subid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExperimentsStatusApi;

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

public class ExperimentsStatusApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ExperimentsStatusApi apiInstance = new ExperimentsStatusApi();
        Integer id = 56; // Integer | ID of the team.
        Integer subid = 56; // Integer | ID of the status
        try {
            statuslike result = apiInstance.readTeamOneExpstatus(id, subid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExperimentsStatusApi#readTeamOneExpstatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExperimentsStatusApi;

public class ExperimentsStatusApiExample {

    public static void main(String[] args) {
        ExperimentsStatusApi apiInstance = new ExperimentsStatusApi();
        Integer id = 56; // Integer | ID of the team.
        Integer subid = 56; // Integer | ID of the status
        try {
            statuslike result = apiInstance.readTeamOneExpstatus(id, subid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExperimentsStatusApi#readTeamOneExpstatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the team.
Integer *subid = 56; // ID of the status

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

// Read a status.
[apiInstance readTeamOneExpstatusWith:id
    subid:subid
              completionHandler: ^(statuslike output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ExperimentsStatusApi()
var id = 56; // {{Integer}} ID of the team.
var subid = 56; // {{Integer}} ID of the status

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readTeamOneExpstatus(id, subid, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ExperimentsStatusApi();
            var id = 56;  // Integer | ID of the team.
            var subid = 56;  // Integer | ID of the status

            try
            {
                // Read a status.
                statuslike result = apiInstance.readTeamOneExpstatus(id, subid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExperimentsStatusApi.readTeamOneExpstatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiExperimentsStatusApi();
$id = 56; // Integer | ID of the team.
$subid = 56; // Integer | ID of the status

try {
    $result = $api_instance->readTeamOneExpstatus($id, $subid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExperimentsStatusApi->readTeamOneExpstatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExperimentsStatusApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ExperimentsStatusApi->new();
my $id = 56; # Integer | ID of the team.
my $subid = 56; # Integer | ID of the status

eval { 
    my $result = $api_instance->readTeamOneExpstatus(id => $id, subid => $subid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExperimentsStatusApi->readTeamOneExpstatus: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ExperimentsStatusApi()
id = 56 # Integer | ID of the team.
subid = 56 # Integer | ID of the status

try: 
    # Read a status.
    api_response = api_instance.read_team_one_expstatus(id, subid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExperimentsStatusApi->readTeamOneExpstatus: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the team.
Required
subid*
Integer
ID of the status
Required

Responses

Status: 200 - Read a status.


ExperimentsTemplates

deleteExperimentTemplate

Delete an experiment template.

The experiment template gets soft-deleted.


/experiments_templates/{id}

Usage and SDK Samples

curl -X DELETE\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/experiments_templates/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExperimentsTemplatesApi;

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

public class ExperimentsTemplatesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ExperimentsTemplatesApi apiInstance = new ExperimentsTemplatesApi();
        Integer id = 56; // Integer | ID of the experiment template
        try {
            apiInstance.deleteExperimentTemplate(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExperimentsTemplatesApi#deleteExperimentTemplate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExperimentsTemplatesApi;

public class ExperimentsTemplatesApiExample {

    public static void main(String[] args) {
        ExperimentsTemplatesApi apiInstance = new ExperimentsTemplatesApi();
        Integer id = 56; // Integer | ID of the experiment template
        try {
            apiInstance.deleteExperimentTemplate(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExperimentsTemplatesApi#deleteExperimentTemplate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the experiment template

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

// Delete an experiment template.
[apiInstance deleteExperimentTemplateWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ExperimentsTemplatesApi()
var id = 56; // {{Integer}} ID of the experiment template

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteExperimentTemplate(id, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ExperimentsTemplatesApi();
            var id = 56;  // Integer | ID of the experiment template

            try
            {
                // Delete an experiment template.
                apiInstance.deleteExperimentTemplate(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExperimentsTemplatesApi.deleteExperimentTemplate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiExperimentsTemplatesApi();
$id = 56; // Integer | ID of the experiment template

try {
    $api_instance->deleteExperimentTemplate($id);
} catch (Exception $e) {
    echo 'Exception when calling ExperimentsTemplatesApi->deleteExperimentTemplate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExperimentsTemplatesApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ExperimentsTemplatesApi->new();
my $id = 56; # Integer | ID of the experiment template

eval { 
    $api_instance->deleteExperimentTemplate(id => $id);
};
if ($@) {
    warn "Exception when calling ExperimentsTemplatesApi->deleteExperimentTemplate: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ExperimentsTemplatesApi()
id = 56 # Integer | ID of the experiment template

try: 
    # Delete an experiment template.
    api_instance.delete_experiment_template(id)
except ApiException as e:
    print("Exception when calling ExperimentsTemplatesApi->deleteExperimentTemplate: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the experiment template
Required

Responses

Status: 204 - The key was deleted


getExperimentTemplate

Read an experiment template


/experiments_templates/{id}

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/experiments_templates/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExperimentsTemplatesApi;

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

public class ExperimentsTemplatesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ExperimentsTemplatesApi apiInstance = new ExperimentsTemplatesApi();
        Integer id = 56; // Integer | ID of the experiment template
        try {
            experiment_template result = apiInstance.getExperimentTemplate(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExperimentsTemplatesApi#getExperimentTemplate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExperimentsTemplatesApi;

public class ExperimentsTemplatesApiExample {

    public static void main(String[] args) {
        ExperimentsTemplatesApi apiInstance = new ExperimentsTemplatesApi();
        Integer id = 56; // Integer | ID of the experiment template
        try {
            experiment_template result = apiInstance.getExperimentTemplate(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExperimentsTemplatesApi#getExperimentTemplate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the experiment template

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

// Read an experiment template
[apiInstance getExperimentTemplateWith:id
              completionHandler: ^(experiment_template output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ExperimentsTemplatesApi()
var id = 56; // {{Integer}} ID of the experiment template

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getExperimentTemplate(id, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ExperimentsTemplatesApi();
            var id = 56;  // Integer | ID of the experiment template

            try
            {
                // Read an experiment template
                experiment_template result = apiInstance.getExperimentTemplate(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExperimentsTemplatesApi.getExperimentTemplate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiExperimentsTemplatesApi();
$id = 56; // Integer | ID of the experiment template

try {
    $result = $api_instance->getExperimentTemplate($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExperimentsTemplatesApi->getExperimentTemplate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExperimentsTemplatesApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ExperimentsTemplatesApi->new();
my $id = 56; # Integer | ID of the experiment template

eval { 
    my $result = $api_instance->getExperimentTemplate(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExperimentsTemplatesApi->getExperimentTemplate: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ExperimentsTemplatesApi()
id = 56 # Integer | ID of the experiment template

try: 
    # Read an experiment template
    api_response = api_instance.get_experiment_template(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExperimentsTemplatesApi->getExperimentTemplate: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the experiment template
Required

Responses

Status: 200 - An experiment template


patchExperimentTemplate

Modify an experiment template


/experiments_templates/{id}

Usage and SDK Samples

curl -X PATCH\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/experiments_templates/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExperimentsTemplatesApi;

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

public class ExperimentsTemplatesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ExperimentsTemplatesApi apiInstance = new ExperimentsTemplatesApi();
        Integer id = 56; // Integer | ID of the experiment template
        Experiments_templates_id_body body = ; // Experiments_templates_id_body | Parameters for modifying an experiment template
        try {
            experiment_template result = apiInstance.patchExperimentTemplate(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExperimentsTemplatesApi#patchExperimentTemplate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExperimentsTemplatesApi;

public class ExperimentsTemplatesApiExample {

    public static void main(String[] args) {
        ExperimentsTemplatesApi apiInstance = new ExperimentsTemplatesApi();
        Integer id = 56; // Integer | ID of the experiment template
        Experiments_templates_id_body body = ; // Experiments_templates_id_body | Parameters for modifying an experiment template
        try {
            experiment_template result = apiInstance.patchExperimentTemplate(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExperimentsTemplatesApi#patchExperimentTemplate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the experiment template
Experiments_templates_id_body *body = ; // Parameters for modifying an experiment template (optional)

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

// Modify an experiment template
[apiInstance patchExperimentTemplateWith:id
    body:body
              completionHandler: ^(experiment_template output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ExperimentsTemplatesApi()
var id = 56; // {{Integer}} ID of the experiment template
var opts = { 
  'body':  // {{Experiments_templates_id_body}} Parameters for modifying an experiment template
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchExperimentTemplate(id, opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ExperimentsTemplatesApi();
            var id = 56;  // Integer | ID of the experiment template
            var body = new Experiments_templates_id_body(); // Experiments_templates_id_body | Parameters for modifying an experiment template (optional) 

            try
            {
                // Modify an experiment template
                experiment_template result = apiInstance.patchExperimentTemplate(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExperimentsTemplatesApi.patchExperimentTemplate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiExperimentsTemplatesApi();
$id = 56; // Integer | ID of the experiment template
$body = ; // Experiments_templates_id_body | Parameters for modifying an experiment template

try {
    $result = $api_instance->patchExperimentTemplate($id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExperimentsTemplatesApi->patchExperimentTemplate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExperimentsTemplatesApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ExperimentsTemplatesApi->new();
my $id = 56; # Integer | ID of the experiment template
my $body = WWW::SwaggerClient::Object::Experiments_templates_id_body->new(); # Experiments_templates_id_body | Parameters for modifying an experiment template

eval { 
    my $result = $api_instance->patchExperimentTemplate(id => $id, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExperimentsTemplatesApi->patchExperimentTemplate: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ExperimentsTemplatesApi()
id = 56 # Integer | ID of the experiment template
body =  # Experiments_templates_id_body | Parameters for modifying an experiment template (optional)

try: 
    # Modify an experiment template
    api_response = api_instance.patch_experiment_template(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExperimentsTemplatesApi->patchExperimentTemplate: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the experiment template
Required
Body parameters
Name Description
body

Responses

Status: 200 - The patched experiment template


postExperimentTemplate

Create an experiment template


/experiments_templates

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/experiments_templates"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExperimentsTemplatesApi;

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

public class ExperimentsTemplatesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ExperimentsTemplatesApi apiInstance = new ExperimentsTemplatesApi();
        Experiments_templates_body body = ; // Experiments_templates_body | Parameters for creating an experiment template
        try {
            apiInstance.postExperimentTemplate(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExperimentsTemplatesApi#postExperimentTemplate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExperimentsTemplatesApi;

public class ExperimentsTemplatesApiExample {

    public static void main(String[] args) {
        ExperimentsTemplatesApi apiInstance = new ExperimentsTemplatesApi();
        Experiments_templates_body body = ; // Experiments_templates_body | Parameters for creating an experiment template
        try {
            apiInstance.postExperimentTemplate(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExperimentsTemplatesApi#postExperimentTemplate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Experiments_templates_body *body = ; // Parameters for creating an experiment template (optional)

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

// Create an experiment template
[apiInstance postExperimentTemplateWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ExperimentsTemplatesApi()
var opts = { 
  'body':  // {{Experiments_templates_body}} Parameters for creating an experiment template
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.postExperimentTemplate(opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ExperimentsTemplatesApi();
            var body = new Experiments_templates_body(); // Experiments_templates_body | Parameters for creating an experiment template (optional) 

            try
            {
                // Create an experiment template
                apiInstance.postExperimentTemplate(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExperimentsTemplatesApi.postExperimentTemplate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiExperimentsTemplatesApi();
$body = ; // Experiments_templates_body | Parameters for creating an experiment template

try {
    $api_instance->postExperimentTemplate($body);
} catch (Exception $e) {
    echo 'Exception when calling ExperimentsTemplatesApi->postExperimentTemplate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExperimentsTemplatesApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ExperimentsTemplatesApi->new();
my $body = WWW::SwaggerClient::Object::Experiments_templates_body->new(); # Experiments_templates_body | Parameters for creating an experiment template

eval { 
    $api_instance->postExperimentTemplate(body => $body);
};
if ($@) {
    warn "Exception when calling ExperimentsTemplatesApi->postExperimentTemplate: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ExperimentsTemplatesApi()
body =  # Experiments_templates_body | Parameters for creating an experiment template (optional)

try: 
    # Create an experiment template
    api_instance.post_experiment_template(body=body)
except ApiException as e:
    print("Exception when calling ExperimentsTemplatesApi->postExperimentTemplate: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 201 - The experiment template has been created.

Name Type Format Description
location String

readExperimentsTemplates

Read all experiments_templates that are accessible


/experiments_templates

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/experiments_templates"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExperimentsTemplatesApi;

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

public class ExperimentsTemplatesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ExperimentsTemplatesApi apiInstance = new ExperimentsTemplatesApi();
        try {
            array[experiment_template] result = apiInstance.readExperimentsTemplates();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExperimentsTemplatesApi#readExperimentsTemplates");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExperimentsTemplatesApi;

public class ExperimentsTemplatesApiExample {

    public static void main(String[] args) {
        ExperimentsTemplatesApi apiInstance = new ExperimentsTemplatesApi();
        try {
            array[experiment_template] result = apiInstance.readExperimentsTemplates();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExperimentsTemplatesApi#readExperimentsTemplates");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

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

// Read all experiments_templates that are accessible
[apiInstance readExperimentsTemplatesWithCompletionHandler: 
              ^(array[experiment_template] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ExperimentsTemplatesApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readExperimentsTemplates(callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ExperimentsTemplatesApi();

            try
            {
                // Read all experiments_templates that are accessible
                array[experiment_template] result = apiInstance.readExperimentsTemplates();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExperimentsTemplatesApi.readExperimentsTemplates: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiExperimentsTemplatesApi();

try {
    $result = $api_instance->readExperimentsTemplates();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExperimentsTemplatesApi->readExperimentsTemplates: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExperimentsTemplatesApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ExperimentsTemplatesApi->new();

eval { 
    my $result = $api_instance->readExperimentsTemplates();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExperimentsTemplatesApi->readExperimentsTemplates: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ExperimentsTemplatesApi()

try: 
    # Read all experiments_templates that are accessible
    api_response = api_instance.read_experiments_templates()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExperimentsTemplatesApi->readExperimentsTemplates: %s\n" % e)

Parameters

Responses

Status: 200 - A list of experiments_templates


ExtraFieldsKeys

extraFieldsKeys

Read extra fields keys.


/extra_fields_keys

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/extra_fields_keys?q=&limit="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExtraFieldsKeysApi;

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

public class ExtraFieldsKeysApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ExtraFieldsKeysApi apiInstance = new ExtraFieldsKeysApi();
        String q = q_example; // String | Search for a term in the extra fields keys.

        Integer limit = ; // Integer | Number of extra fields keys that will be returned. Value >= -1; -1: no limit, 0: users default setting from UCP.

        try {
            array[extra_fields_keys] result = apiInstance.extraFieldsKeys(q, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExtraFieldsKeysApi#extraFieldsKeys");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExtraFieldsKeysApi;

public class ExtraFieldsKeysApiExample {

    public static void main(String[] args) {
        ExtraFieldsKeysApi apiInstance = new ExtraFieldsKeysApi();
        String q = q_example; // String | Search for a term in the extra fields keys.

        Integer limit = ; // Integer | Number of extra fields keys that will be returned. Value >= -1; -1: no limit, 0: users default setting from UCP.

        try {
            array[extra_fields_keys] result = apiInstance.extraFieldsKeys(q, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExtraFieldsKeysApi#extraFieldsKeys");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *q = q_example; // Search for a term in the extra fields keys.
 (optional)
Integer *limit = ; // Number of extra fields keys that will be returned. Value >= -1; -1: no limit, 0: users default setting from UCP.
 (optional)

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

// Read extra fields keys.
[apiInstance extraFieldsKeysWith:q
    limit:limit
              completionHandler: ^(array[extra_fields_keys] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ExtraFieldsKeysApi()
var opts = { 
  'q': q_example, // {{String}} Search for a term in the extra fields keys.

  'limit':  // {{Integer}} Number of extra fields keys that will be returned. Value >= -1; -1: no limit, 0: users default setting from UCP.

};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.extraFieldsKeys(opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ExtraFieldsKeysApi();
            var q = q_example;  // String | Search for a term in the extra fields keys.
 (optional) 
            var limit = new Integer(); // Integer | Number of extra fields keys that will be returned. Value >= -1; -1: no limit, 0: users default setting from UCP.
 (optional) 

            try
            {
                // Read extra fields keys.
                array[extra_fields_keys] result = apiInstance.extraFieldsKeys(q, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExtraFieldsKeysApi.extraFieldsKeys: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiExtraFieldsKeysApi();
$q = q_example; // String | Search for a term in the extra fields keys.

$limit = ; // Integer | Number of extra fields keys that will be returned. Value >= -1; -1: no limit, 0: users default setting from UCP.


try {
    $result = $api_instance->extraFieldsKeys($q, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExtraFieldsKeysApi->extraFieldsKeys: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExtraFieldsKeysApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ExtraFieldsKeysApi->new();
my $q = q_example; # String | Search for a term in the extra fields keys.

my $limit = ; # Integer | Number of extra fields keys that will be returned. Value >= -1; -1: no limit, 0: users default setting from UCP.


eval { 
    my $result = $api_instance->extraFieldsKeys(q => $q, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExtraFieldsKeysApi->extraFieldsKeys: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ExtraFieldsKeysApi()
q = q_example # String | Search for a term in the extra fields keys.
 (optional)
limit =  # Integer | Number of extra fields keys that will be returned. Value >= -1; -1: no limit, 0: users default setting from UCP.
 (optional)

try: 
    # Read extra fields keys.
    api_response = api_instance.extra_fields_keys(q=q, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExtraFieldsKeysApi->extraFieldsKeys: %s\n" % e)

Parameters

Query parameters
Name Description
q
String
Search for a term in the extra fields keys.
limit
Integer
Number of extra fields keys that will be returned. Value >= -1; -1: no limit, 0: users default setting from UCP.

Responses

Status: 200 - A list of extra fields keys and their frequency.


FavoriteTags

deleteFavtag

Unfavorite a tag.


/favtags/{id}

Usage and SDK Samples

curl -X DELETE\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/favtags/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FavoriteTagsApi;

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

public class FavoriteTagsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        FavoriteTagsApi apiInstance = new FavoriteTagsApi();
        Integer id = 56; // Integer | ID of the tag.
        try {
            apiInstance.deleteFavtag(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling FavoriteTagsApi#deleteFavtag");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FavoriteTagsApi;

public class FavoriteTagsApiExample {

    public static void main(String[] args) {
        FavoriteTagsApi apiInstance = new FavoriteTagsApi();
        Integer id = 56; // Integer | ID of the tag.
        try {
            apiInstance.deleteFavtag(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling FavoriteTagsApi#deleteFavtag");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the tag.

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

// Unfavorite a tag.
[apiInstance deleteFavtagWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.FavoriteTagsApi()
var id = 56; // {{Integer}} ID of the tag.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteFavtag(id, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new FavoriteTagsApi();
            var id = 56;  // Integer | ID of the tag.

            try
            {
                // Unfavorite a tag.
                apiInstance.deleteFavtag(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FavoriteTagsApi.deleteFavtag: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiFavoriteTagsApi();
$id = 56; // Integer | ID of the tag.

try {
    $api_instance->deleteFavtag($id);
} catch (Exception $e) {
    echo 'Exception when calling FavoriteTagsApi->deleteFavtag: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FavoriteTagsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::FavoriteTagsApi->new();
my $id = 56; # Integer | ID of the tag.

eval { 
    $api_instance->deleteFavtag(id => $id);
};
if ($@) {
    warn "Exception when calling FavoriteTagsApi->deleteFavtag: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.FavoriteTagsApi()
id = 56 # Integer | ID of the tag.

try: 
    # Unfavorite a tag.
    api_instance.delete_favtag(id)
except ApiException as e:
    print("Exception when calling FavoriteTagsApi->deleteFavtag: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the tag.
Required

Responses

Status: 204 - The favorite tag was removed.


postFavtags

Add a tag as favorite.


/favtags

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/favtags"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FavoriteTagsApi;

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

public class FavoriteTagsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        FavoriteTagsApi apiInstance = new FavoriteTagsApi();
        Favtags_body body = ; // Favtags_body | Parameters for adding a favorite tag.
        try {
            apiInstance.postFavtags(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling FavoriteTagsApi#postFavtags");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FavoriteTagsApi;

public class FavoriteTagsApiExample {

    public static void main(String[] args) {
        FavoriteTagsApi apiInstance = new FavoriteTagsApi();
        Favtags_body body = ; // Favtags_body | Parameters for adding a favorite tag.
        try {
            apiInstance.postFavtags(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling FavoriteTagsApi#postFavtags");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Favtags_body *body = ; // Parameters for adding a favorite tag. (optional)

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

// Add a tag as favorite.
[apiInstance postFavtagsWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.FavoriteTagsApi()
var opts = { 
  'body':  // {{Favtags_body}} Parameters for adding a favorite tag.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.postFavtags(opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new FavoriteTagsApi();
            var body = new Favtags_body(); // Favtags_body | Parameters for adding a favorite tag. (optional) 

            try
            {
                // Add a tag as favorite.
                apiInstance.postFavtags(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FavoriteTagsApi.postFavtags: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiFavoriteTagsApi();
$body = ; // Favtags_body | Parameters for adding a favorite tag.

try {
    $api_instance->postFavtags($body);
} catch (Exception $e) {
    echo 'Exception when calling FavoriteTagsApi->postFavtags: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FavoriteTagsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::FavoriteTagsApi->new();
my $body = WWW::SwaggerClient::Object::Favtags_body->new(); # Favtags_body | Parameters for adding a favorite tag.

eval { 
    $api_instance->postFavtags(body => $body);
};
if ($@) {
    warn "Exception when calling FavoriteTagsApi->postFavtags: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.FavoriteTagsApi()
body =  # Favtags_body | Parameters for adding a favorite tag. (optional)

try: 
    # Add a tag as favorite.
    api_instance.post_favtags(body=body)
except ApiException as e:
    print("Exception when calling FavoriteTagsApi->postFavtags: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 201 - The favtag has been created.

Name Type Format Description
location String

readFavtags

Read all favorite tags for the user.


/favtags

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/favtags"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FavoriteTagsApi;

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

public class FavoriteTagsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        FavoriteTagsApi apiInstance = new FavoriteTagsApi();
        try {
            inline_response_200_1 result = apiInstance.readFavtags();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FavoriteTagsApi#readFavtags");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FavoriteTagsApi;

public class FavoriteTagsApiExample {

    public static void main(String[] args) {
        FavoriteTagsApi apiInstance = new FavoriteTagsApi();
        try {
            inline_response_200_1 result = apiInstance.readFavtags();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FavoriteTagsApi#readFavtags");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

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

// Read all favorite tags for the user.
[apiInstance readFavtagsWithCompletionHandler: 
              ^(inline_response_200_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.FavoriteTagsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readFavtags(callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new FavoriteTagsApi();

            try
            {
                // Read all favorite tags for the user.
                inline_response_200_1 result = apiInstance.readFavtags();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FavoriteTagsApi.readFavtags: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiFavoriteTagsApi();

try {
    $result = $api_instance->readFavtags();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FavoriteTagsApi->readFavtags: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FavoriteTagsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::FavoriteTagsApi->new();

eval { 
    my $result = $api_instance->readFavtags();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FavoriteTagsApi->readFavtags: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.FavoriteTagsApi()

try: 
    # Read all favorite tags for the user.
    api_response = api_instance.read_favtags()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FavoriteTagsApi->readFavtags: %s\n" % e)

Parameters

Responses

Status: 200 - A list of favorite tags.


Idps

deleteIdp

Delete an idp.

The idp gets deleted.


/idps/{id}

Usage and SDK Samples

curl -X DELETE\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/idps/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.IdpsApi;

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

public class IdpsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        IdpsApi apiInstance = new IdpsApi();
        Integer id = 56; // Integer | ID of the idp
        try {
            apiInstance.deleteIdp(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling IdpsApi#deleteIdp");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.IdpsApi;

public class IdpsApiExample {

    public static void main(String[] args) {
        IdpsApi apiInstance = new IdpsApi();
        Integer id = 56; // Integer | ID of the idp
        try {
            apiInstance.deleteIdp(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling IdpsApi#deleteIdp");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the idp

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

// Delete an idp.
[apiInstance deleteIdpWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.IdpsApi()
var id = 56; // {{Integer}} ID of the idp

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteIdp(id, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new IdpsApi();
            var id = 56;  // Integer | ID of the idp

            try
            {
                // Delete an idp.
                apiInstance.deleteIdp(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling IdpsApi.deleteIdp: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiIdpsApi();
$id = 56; // Integer | ID of the idp

try {
    $api_instance->deleteIdp($id);
} catch (Exception $e) {
    echo 'Exception when calling IdpsApi->deleteIdp: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::IdpsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::IdpsApi->new();
my $id = 56; # Integer | ID of the idp

eval { 
    $api_instance->deleteIdp(id => $id);
};
if ($@) {
    warn "Exception when calling IdpsApi->deleteIdp: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.IdpsApi()
id = 56 # Integer | ID of the idp

try: 
    # Delete an idp.
    api_instance.delete_idp(id)
except ApiException as e:
    print("Exception when calling IdpsApi->deleteIdp: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the idp
Required

Responses

Status: 204 - The idp was deleted.


patchIdp

Actions on an idp.


/idps/{id}

Usage and SDK Samples

curl -X PATCH\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/idps/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.IdpsApi;

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

public class IdpsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        IdpsApi apiInstance = new IdpsApi();
        Integer id = 56; // Integer | ID of the idp
        Idps_id_body body = ; // Idps_id_body | Parameters for modifying an idp.
        try {
            idp result = apiInstance.patchIdp(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IdpsApi#patchIdp");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.IdpsApi;

public class IdpsApiExample {

    public static void main(String[] args) {
        IdpsApi apiInstance = new IdpsApi();
        Integer id = 56; // Integer | ID of the idp
        Idps_id_body body = ; // Idps_id_body | Parameters for modifying an idp.
        try {
            idp result = apiInstance.patchIdp(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IdpsApi#patchIdp");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the idp
Idps_id_body *body = ; // Parameters for modifying an idp. (optional)

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

// Actions on an idp.
[apiInstance patchIdpWith:id
    body:body
              completionHandler: ^(idp output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.IdpsApi()
var id = 56; // {{Integer}} ID of the idp
var opts = { 
  'body':  // {{Idps_id_body}} Parameters for modifying an idp.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchIdp(id, opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new IdpsApi();
            var id = 56;  // Integer | ID of the idp
            var body = new Idps_id_body(); // Idps_id_body | Parameters for modifying an idp. (optional) 

            try
            {
                // Actions on an idp.
                idp result = apiInstance.patchIdp(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling IdpsApi.patchIdp: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiIdpsApi();
$id = 56; // Integer | ID of the idp
$body = ; // Idps_id_body | Parameters for modifying an idp.

try {
    $result = $api_instance->patchIdp($id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IdpsApi->patchIdp: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::IdpsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::IdpsApi->new();
my $id = 56; # Integer | ID of the idp
my $body = WWW::SwaggerClient::Object::Idps_id_body->new(); # Idps_id_body | Parameters for modifying an idp.

eval { 
    my $result = $api_instance->patchIdp(id => $id, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling IdpsApi->patchIdp: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.IdpsApi()
id = 56 # Integer | ID of the idp
body =  # Idps_id_body | Parameters for modifying an idp. (optional)

try: 
    # Actions on an idp.
    api_response = api_instance.patch_idp(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IdpsApi->patchIdp: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the idp
Required
Body parameters
Name Description
body

Responses

Status: 200 - The updated idp.


postIdp

Create an idp.


/idps

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/idps"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.IdpsApi;

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

public class IdpsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        IdpsApi apiInstance = new IdpsApi();
        Idps_body body = ; // Idps_body | Parameters for creating an idp.
        try {
            apiInstance.postIdp(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling IdpsApi#postIdp");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.IdpsApi;

public class IdpsApiExample {

    public static void main(String[] args) {
        IdpsApi apiInstance = new IdpsApi();
        Idps_body body = ; // Idps_body | Parameters for creating an idp.
        try {
            apiInstance.postIdp(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling IdpsApi#postIdp");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Idps_body *body = ; // Parameters for creating an idp. (optional)

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

// Create an idp.
[apiInstance postIdpWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.IdpsApi()
var opts = { 
  'body':  // {{Idps_body}} Parameters for creating an idp.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.postIdp(opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new IdpsApi();
            var body = new Idps_body(); // Idps_body | Parameters for creating an idp. (optional) 

            try
            {
                // Create an idp.
                apiInstance.postIdp(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling IdpsApi.postIdp: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiIdpsApi();
$body = ; // Idps_body | Parameters for creating an idp.

try {
    $api_instance->postIdp($body);
} catch (Exception $e) {
    echo 'Exception when calling IdpsApi->postIdp: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::IdpsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::IdpsApi->new();
my $body = WWW::SwaggerClient::Object::Idps_body->new(); # Idps_body | Parameters for creating an idp.

eval { 
    $api_instance->postIdp(body => $body);
};
if ($@) {
    warn "Exception when calling IdpsApi->postIdp: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.IdpsApi()
body =  # Idps_body | Parameters for creating an idp. (optional)

try: 
    # Create an idp.
    api_instance.post_idp(body=body)
except ApiException as e:
    print("Exception when calling IdpsApi->postIdp: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 201 - The idp has been created.

Name Type Format Description
location String

readIdp

Read an idp.


/idps/{id}

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/idps/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.IdpsApi;

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

public class IdpsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        IdpsApi apiInstance = new IdpsApi();
        Integer id = 56; // Integer | ID of the idp
        try {
            idp result = apiInstance.readIdp(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IdpsApi#readIdp");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.IdpsApi;

public class IdpsApiExample {

    public static void main(String[] args) {
        IdpsApi apiInstance = new IdpsApi();
        Integer id = 56; // Integer | ID of the idp
        try {
            idp result = apiInstance.readIdp(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IdpsApi#readIdp");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the idp

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

// Read an idp.
[apiInstance readIdpWith:id
              completionHandler: ^(idp output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.IdpsApi()
var id = 56; // {{Integer}} ID of the idp

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readIdp(id, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new IdpsApi();
            var id = 56;  // Integer | ID of the idp

            try
            {
                // Read an idp.
                idp result = apiInstance.readIdp(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling IdpsApi.readIdp: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiIdpsApi();
$id = 56; // Integer | ID of the idp

try {
    $result = $api_instance->readIdp($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IdpsApi->readIdp: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::IdpsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::IdpsApi->new();
my $id = 56; # Integer | ID of the idp

eval { 
    my $result = $api_instance->readIdp(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling IdpsApi->readIdp: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.IdpsApi()
id = 56 # Integer | ID of the idp

try: 
    # Read an idp.
    api_response = api_instance.read_idp(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IdpsApi->readIdp: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the idp
Required

Responses

Status: 200 - An idp.


readIdps

Read all IDPs.


/idps

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/idps"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.IdpsApi;

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

public class IdpsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        IdpsApi apiInstance = new IdpsApi();
        try {
            array[idp] result = apiInstance.readIdps();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IdpsApi#readIdps");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.IdpsApi;

public class IdpsApiExample {

    public static void main(String[] args) {
        IdpsApi apiInstance = new IdpsApi();
        try {
            array[idp] result = apiInstance.readIdps();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IdpsApi#readIdps");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

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

// Read all IDPs.
[apiInstance readIdpsWithCompletionHandler: 
              ^(array[idp] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.IdpsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readIdps(callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new IdpsApi();

            try
            {
                // Read all IDPs.
                array[idp] result = apiInstance.readIdps();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling IdpsApi.readIdps: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiIdpsApi();

try {
    $result = $api_instance->readIdps();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IdpsApi->readIdps: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::IdpsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::IdpsApi->new();

eval { 
    my $result = $api_instance->readIdps();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling IdpsApi->readIdps: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.IdpsApi()

try: 
    # Read all IDPs.
    api_response = api_instance.read_idps()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IdpsApi->readIdps: %s\n" % e)

Parameters

Responses

Status: 200 - A list of idps.


Info

getInfo

Get information about the instance.

Get information about the instance.


/info

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/info"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InfoApi;

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

public class InfoApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        InfoApi apiInstance = new InfoApi();
        try {
            inline_response_200 result = apiInstance.getInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InfoApi#getInfo");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InfoApi;

public class InfoApiExample {

    public static void main(String[] args) {
        InfoApi apiInstance = new InfoApi();
        try {
            inline_response_200 result = apiInstance.getInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InfoApi#getInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

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

// Get information about the instance.
[apiInstance getInfoWithCompletionHandler: 
              ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.InfoApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getInfo(callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new InfoApi();

            try
            {
                // Get information about the instance.
                inline_response_200 result = apiInstance.getInfo();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InfoApi.getInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiInfoApi();

try {
    $result = $api_instance->getInfo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InfoApi->getInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InfoApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::InfoApi->new();

eval { 
    my $result = $api_instance->getInfo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InfoApi->getInfo: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.InfoApi()

try: 
    # Get information about the instance.
    api_response = api_instance.get_info()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InfoApi->getInfo: %s\n" % e)

Parameters

Responses

Status: 200 - Information about the instance


Items

deleteItem

Delete an item.

The item gets soft-deleted.


/items/{id}

Usage and SDK Samples

curl -X DELETE\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/items/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ItemsApi;

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

public class ItemsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ItemsApi apiInstance = new ItemsApi();
        Integer id = 56; // Integer | ID of the item
        try {
            apiInstance.deleteItem(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling ItemsApi#deleteItem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ItemsApi;

public class ItemsApiExample {

    public static void main(String[] args) {
        ItemsApi apiInstance = new ItemsApi();
        Integer id = 56; // Integer | ID of the item
        try {
            apiInstance.deleteItem(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling ItemsApi#deleteItem");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the item

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

// Delete an item.
[apiInstance deleteItemWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ItemsApi()
var id = 56; // {{Integer}} ID of the item

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteItem(id, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ItemsApi();
            var id = 56;  // Integer | ID of the item

            try
            {
                // Delete an item.
                apiInstance.deleteItem(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ItemsApi.deleteItem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiItemsApi();
$id = 56; // Integer | ID of the item

try {
    $api_instance->deleteItem($id);
} catch (Exception $e) {
    echo 'Exception when calling ItemsApi->deleteItem: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ItemsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ItemsApi->new();
my $id = 56; # Integer | ID of the item

eval { 
    $api_instance->deleteItem(id => $id);
};
if ($@) {
    warn "Exception when calling ItemsApi->deleteItem: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ItemsApi()
id = 56 # Integer | ID of the item

try: 
    # Delete an item.
    api_instance.delete_item(id)
except ApiException as e:
    print("Exception when calling ItemsApi->deleteItem: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the item
Required

Responses

Status: 204 - The key was deleted


getItem

Read an item


/items/{id}

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/items/{id}?format="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ItemsApi;

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

public class ItemsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ItemsApi apiInstance = new ItemsApi();
        Integer id = 56; // Integer | ID of the item
        String format = format_example; // String | Get the entity in a different format like csv, pdf, eln or zip. "pdfa" means archive pdf (PDF/A), same with "zipa".

        try {
            item result = apiInstance.getItem(id, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ItemsApi#getItem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ItemsApi;

public class ItemsApiExample {

    public static void main(String[] args) {
        ItemsApi apiInstance = new ItemsApi();
        Integer id = 56; // Integer | ID of the item
        String format = format_example; // String | Get the entity in a different format like csv, pdf, eln or zip. "pdfa" means archive pdf (PDF/A), same with "zipa".

        try {
            item result = apiInstance.getItem(id, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ItemsApi#getItem");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the item
String *format = format_example; // Get the entity in a different format like csv, pdf, eln or zip. "pdfa" means archive pdf (PDF/A), same with "zipa".
 (optional) (default to json)

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

// Read an item
[apiInstance getItemWith:id
    format:format
              completionHandler: ^(item output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ItemsApi()
var id = 56; // {{Integer}} ID of the item
var opts = { 
  'format': format_example // {{String}} Get the entity in a different format like csv, pdf, eln or zip. "pdfa" means archive pdf (PDF/A), same with "zipa".

};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getItem(id, opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ItemsApi();
            var id = 56;  // Integer | ID of the item
            var format = format_example;  // String | Get the entity in a different format like csv, pdf, eln or zip. "pdfa" means archive pdf (PDF/A), same with "zipa".
 (optional)  (default to json)

            try
            {
                // Read an item
                item result = apiInstance.getItem(id, format);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ItemsApi.getItem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiItemsApi();
$id = 56; // Integer | ID of the item
$format = format_example; // String | Get the entity in a different format like csv, pdf, eln or zip. "pdfa" means archive pdf (PDF/A), same with "zipa".


try {
    $result = $api_instance->getItem($id, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ItemsApi->getItem: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ItemsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ItemsApi->new();
my $id = 56; # Integer | ID of the item
my $format = format_example; # String | Get the entity in a different format like csv, pdf, eln or zip. "pdfa" means archive pdf (PDF/A), same with "zipa".


eval { 
    my $result = $api_instance->getItem(id => $id, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ItemsApi->getItem: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ItemsApi()
id = 56 # Integer | ID of the item
format = format_example # String | Get the entity in a different format like csv, pdf, eln or zip. "pdfa" means archive pdf (PDF/A), same with "zipa".
 (optional) (default to json)

try: 
    # Read an item
    api_response = api_instance.get_item(id, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ItemsApi->getItem: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the item
Required
Query parameters
Name Description
format
String
Get the entity in a different format like csv, pdf, eln or zip. "pdfa" means archive pdf (PDF/A), same with "zipa".

Responses

Status: 200 - An item


patchItem

Modify an item


/items/{id}

Usage and SDK Samples

curl -X PATCH\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/items/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ItemsApi;

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

public class ItemsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ItemsApi apiInstance = new ItemsApi();
        Integer id = 56; // Integer | ID of the item
        Items_id_body body = ; // Items_id_body | Parameters for patching an item
        try {
            item result = apiInstance.patchItem(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ItemsApi#patchItem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ItemsApi;

public class ItemsApiExample {

    public static void main(String[] args) {
        ItemsApi apiInstance = new ItemsApi();
        Integer id = 56; // Integer | ID of the item
        Items_id_body body = ; // Items_id_body | Parameters for patching an item
        try {
            item result = apiInstance.patchItem(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ItemsApi#patchItem");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the item
Items_id_body *body = ; // Parameters for patching an item (optional)

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

// Modify an item
[apiInstance patchItemWith:id
    body:body
              completionHandler: ^(item output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ItemsApi()
var id = 56; // {{Integer}} ID of the item
var opts = { 
  'body':  // {{Items_id_body}} Parameters for patching an item
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchItem(id, opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ItemsApi();
            var id = 56;  // Integer | ID of the item
            var body = new Items_id_body(); // Items_id_body | Parameters for patching an item (optional) 

            try
            {
                // Modify an item
                item result = apiInstance.patchItem(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ItemsApi.patchItem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiItemsApi();
$id = 56; // Integer | ID of the item
$body = ; // Items_id_body | Parameters for patching an item

try {
    $result = $api_instance->patchItem($id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ItemsApi->patchItem: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ItemsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ItemsApi->new();
my $id = 56; # Integer | ID of the item
my $body = WWW::SwaggerClient::Object::Items_id_body->new(); # Items_id_body | Parameters for patching an item

eval { 
    my $result = $api_instance->patchItem(id => $id, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ItemsApi->patchItem: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ItemsApi()
id = 56 # Integer | ID of the item
body =  # Items_id_body | Parameters for patching an item (optional)

try: 
    # Modify an item
    api_response = api_instance.patch_item(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ItemsApi->patchItem: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the item
Required
Body parameters
Name Description
body

Responses

Status: 200 - The patched item


postItem

Create an item


/items

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/items"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ItemsApi;

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

public class ItemsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ItemsApi apiInstance = new ItemsApi();
        Items_body body = ; // Items_body | Parameters for creating an item
        try {
            apiInstance.postItem(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ItemsApi#postItem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ItemsApi;

public class ItemsApiExample {

    public static void main(String[] args) {
        ItemsApi apiInstance = new ItemsApi();
        Items_body body = ; // Items_body | Parameters for creating an item
        try {
            apiInstance.postItem(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ItemsApi#postItem");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Items_body *body = ; // Parameters for creating an item (optional)

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

// Create an item
[apiInstance postItemWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ItemsApi()
var opts = { 
  'body':  // {{Items_body}} Parameters for creating an item
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.postItem(opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ItemsApi();
            var body = new Items_body(); // Items_body | Parameters for creating an item (optional) 

            try
            {
                // Create an item
                apiInstance.postItem(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ItemsApi.postItem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiItemsApi();
$body = ; // Items_body | Parameters for creating an item

try {
    $api_instance->postItem($body);
} catch (Exception $e) {
    echo 'Exception when calling ItemsApi->postItem: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ItemsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ItemsApi->new();
my $body = WWW::SwaggerClient::Object::Items_body->new(); # Items_body | Parameters for creating an item

eval { 
    $api_instance->postItem(body => $body);
};
if ($@) {
    warn "Exception when calling ItemsApi->postItem: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ItemsApi()
body =  # Items_body | Parameters for creating an item (optional)

try: 
    # Create an item
    api_instance.post_item(body=body)
except ApiException as e:
    print("Exception when calling ItemsApi->postItem: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 201 - The item has been created.

Name Type Format Description
location String

readItems

Read all items that are accessible


/items

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/items?q=&extended=&cat=&tags[]=&limit=&offset=&owner="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ItemsApi;

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

public class ItemsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ItemsApi apiInstance = new ItemsApi();
        String q = q_example; // String | Search for a term in title, body or elabid.

        String extended = extended_example; // String | Extended search (advanced query).

        Integer cat = 56; // Integer | The category id of the items.

        array[String] tags[] = ; // array[String] | An array of tags for filtering results containing all of these tags.

        Integer limit = 56; // Integer | Limit the number of results.

        Integer offset = 56; // Integer | Skip a number of results. Use with limit to work the pagination.

        Integer owner = 56; // Integer | Filter results by author (user id)

        try {
            array[item] result = apiInstance.readItems(q, extended, cat, tags[], limit, offset, owner);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ItemsApi#readItems");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ItemsApi;

public class ItemsApiExample {

    public static void main(String[] args) {
        ItemsApi apiInstance = new ItemsApi();
        String q = q_example; // String | Search for a term in title, body or elabid.

        String extended = extended_example; // String | Extended search (advanced query).

        Integer cat = 56; // Integer | The category id of the items.

        array[String] tags[] = ; // array[String] | An array of tags for filtering results containing all of these tags.

        Integer limit = 56; // Integer | Limit the number of results.

        Integer offset = 56; // Integer | Skip a number of results. Use with limit to work the pagination.

        Integer owner = 56; // Integer | Filter results by author (user id)

        try {
            array[item] result = apiInstance.readItems(q, extended, cat, tags[], limit, offset, owner);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ItemsApi#readItems");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *q = q_example; // Search for a term in title, body or elabid.
 (optional)
String *extended = extended_example; // Extended search (advanced query).
 (optional)
Integer *cat = 56; // The category id of the items.
 (optional)
array[String] *tags[] = ; // An array of tags for filtering results containing all of these tags.
 (optional)
Integer *limit = 56; // Limit the number of results.
 (optional) (default to 15)
Integer *offset = 56; // Skip a number of results. Use with limit to work the pagination.
 (optional) (default to 0)
Integer *owner = 56; // Filter results by author (user id)
 (optional)

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

// Read all items that are accessible
[apiInstance readItemsWith:q
    extended:extended
    cat:cat
    tags[]:tags[]
    limit:limit
    offset:offset
    owner:owner
              completionHandler: ^(array[item] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ItemsApi()
var opts = { 
  'q': q_example, // {{String}} Search for a term in title, body or elabid.

  'extended': extended_example, // {{String}} Extended search (advanced query).

  'cat': 56, // {{Integer}} The category id of the items.

  'tags[]': , // {{array[String]}} An array of tags for filtering results containing all of these tags.

  'limit': 56, // {{Integer}} Limit the number of results.

  'offset': 56, // {{Integer}} Skip a number of results. Use with limit to work the pagination.

  'owner': 56 // {{Integer}} Filter results by author (user id)

};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readItems(opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ItemsApi();
            var q = q_example;  // String | Search for a term in title, body or elabid.
 (optional) 
            var extended = extended_example;  // String | Extended search (advanced query).
 (optional) 
            var cat = 56;  // Integer | The category id of the items.
 (optional) 
            var tags[] = new array[String](); // array[String] | An array of tags for filtering results containing all of these tags.
 (optional) 
            var limit = 56;  // Integer | Limit the number of results.
 (optional)  (default to 15)
            var offset = 56;  // Integer | Skip a number of results. Use with limit to work the pagination.
 (optional)  (default to 0)
            var owner = 56;  // Integer | Filter results by author (user id)
 (optional) 

            try
            {
                // Read all items that are accessible
                array[item] result = apiInstance.readItems(q, extended, cat, tags[], limit, offset, owner);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ItemsApi.readItems: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiItemsApi();
$q = q_example; // String | Search for a term in title, body or elabid.

$extended = extended_example; // String | Extended search (advanced query).

$cat = 56; // Integer | The category id of the items.

$tags[] = ; // array[String] | An array of tags for filtering results containing all of these tags.

$limit = 56; // Integer | Limit the number of results.

$offset = 56; // Integer | Skip a number of results. Use with limit to work the pagination.

$owner = 56; // Integer | Filter results by author (user id)


try {
    $result = $api_instance->readItems($q, $extended, $cat, $tags[], $limit, $offset, $owner);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ItemsApi->readItems: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ItemsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ItemsApi->new();
my $q = q_example; # String | Search for a term in title, body or elabid.

my $extended = extended_example; # String | Extended search (advanced query).

my $cat = 56; # Integer | The category id of the items.

my $tags[] = []; # array[String] | An array of tags for filtering results containing all of these tags.

my $limit = 56; # Integer | Limit the number of results.

my $offset = 56; # Integer | Skip a number of results. Use with limit to work the pagination.

my $owner = 56; # Integer | Filter results by author (user id)


eval { 
    my $result = $api_instance->readItems(q => $q, extended => $extended, cat => $cat, tags[] => $tags[], limit => $limit, offset => $offset, owner => $owner);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ItemsApi->readItems: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ItemsApi()
q = q_example # String | Search for a term in title, body or elabid.
 (optional)
extended = extended_example # String | Extended search (advanced query).
 (optional)
cat = 56 # Integer | The category id of the items.
 (optional)
tags[] =  # array[String] | An array of tags for filtering results containing all of these tags.
 (optional)
limit = 56 # Integer | Limit the number of results.
 (optional) (default to 15)
offset = 56 # Integer | Skip a number of results. Use with limit to work the pagination.
 (optional) (default to 0)
owner = 56 # Integer | Filter results by author (user id)
 (optional)

try: 
    # Read all items that are accessible
    api_response = api_instance.read_items(q=q, extended=extended, cat=cat, tags[]=tags[], limit=limit, offset=offset, owner=owner)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ItemsApi->readItems: %s\n" % e)

Parameters

Query parameters
Name Description
q
String
Search for a term in title, body or elabid.
extended
String
Extended search (advanced query).
cat
Integer
The category id of the items.
tags[]
array[String]
An array of tags for filtering results containing all of these tags.
limit
Integer
Limit the number of results.
offset
Integer
Skip a number of results. Use with limit to work the pagination.
owner
Integer
Filter results by author (user id)

Responses

Status: 200 - A list of items


ItemsTypes

deleteItemsType

Delete a resource category.

The resource category gets soft-deleted.


/items_types/{id}

Usage and SDK Samples

curl -X DELETE\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/items_types/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ItemsTypesApi;

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

public class ItemsTypesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ItemsTypesApi apiInstance = new ItemsTypesApi();
        Integer id = 56; // Integer | ID of the resource category.
        try {
            apiInstance.deleteItemsType(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling ItemsTypesApi#deleteItemsType");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ItemsTypesApi;

public class ItemsTypesApiExample {

    public static void main(String[] args) {
        ItemsTypesApi apiInstance = new ItemsTypesApi();
        Integer id = 56; // Integer | ID of the resource category.
        try {
            apiInstance.deleteItemsType(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling ItemsTypesApi#deleteItemsType");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the resource category.

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

// Delete a resource category.
[apiInstance deleteItemsTypeWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ItemsTypesApi()
var id = 56; // {{Integer}} ID of the resource category.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteItemsType(id, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ItemsTypesApi();
            var id = 56;  // Integer | ID of the resource category.

            try
            {
                // Delete a resource category.
                apiInstance.deleteItemsType(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ItemsTypesApi.deleteItemsType: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiItemsTypesApi();
$id = 56; // Integer | ID of the resource category.

try {
    $api_instance->deleteItemsType($id);
} catch (Exception $e) {
    echo 'Exception when calling ItemsTypesApi->deleteItemsType: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ItemsTypesApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ItemsTypesApi->new();
my $id = 56; # Integer | ID of the resource category.

eval { 
    $api_instance->deleteItemsType(id => $id);
};
if ($@) {
    warn "Exception when calling ItemsTypesApi->deleteItemsType: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ItemsTypesApi()
id = 56 # Integer | ID of the resource category.

try: 
    # Delete a resource category.
    api_instance.delete_items_type(id)
except ApiException as e:
    print("Exception when calling ItemsTypesApi->deleteItemsType: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the resource category.
Required

Responses

Status: 204 - The resource category was marked as deleted.


getItemsType

Read a resource category.


/items_types/{id}

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/items_types/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ItemsTypesApi;

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

public class ItemsTypesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ItemsTypesApi apiInstance = new ItemsTypesApi();
        Integer id = 56; // Integer | ID of the resource category.
        try {
            items_type result = apiInstance.getItemsType(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ItemsTypesApi#getItemsType");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ItemsTypesApi;

public class ItemsTypesApiExample {

    public static void main(String[] args) {
        ItemsTypesApi apiInstance = new ItemsTypesApi();
        Integer id = 56; // Integer | ID of the resource category.
        try {
            items_type result = apiInstance.getItemsType(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ItemsTypesApi#getItemsType");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the resource category.

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

// Read a resource category.
[apiInstance getItemsTypeWith:id
              completionHandler: ^(items_type output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ItemsTypesApi()
var id = 56; // {{Integer}} ID of the resource category.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getItemsType(id, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ItemsTypesApi();
            var id = 56;  // Integer | ID of the resource category.

            try
            {
                // Read a resource category.
                items_type result = apiInstance.getItemsType(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ItemsTypesApi.getItemsType: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiItemsTypesApi();
$id = 56; // Integer | ID of the resource category.

try {
    $result = $api_instance->getItemsType($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ItemsTypesApi->getItemsType: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ItemsTypesApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ItemsTypesApi->new();
my $id = 56; # Integer | ID of the resource category.

eval { 
    my $result = $api_instance->getItemsType(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ItemsTypesApi->getItemsType: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ItemsTypesApi()
id = 56 # Integer | ID of the resource category.

try: 
    # Read a resource category.
    api_response = api_instance.get_items_type(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ItemsTypesApi->getItemsType: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the resource category.
Required

Responses

Status: 200 - A resource category.


patchItemsType

Modify a resource category.


/items_types/{id}

Usage and SDK Samples

curl -X PATCH\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/items_types/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ItemsTypesApi;

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

public class ItemsTypesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ItemsTypesApi apiInstance = new ItemsTypesApi();
        Integer id = 56; // Integer | ID of the resource category.
        Items_type body = ; // Items_type | 
        try {
            items_type result = apiInstance.patchItemsType(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ItemsTypesApi#patchItemsType");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ItemsTypesApi;

public class ItemsTypesApiExample {

    public static void main(String[] args) {
        ItemsTypesApi apiInstance = new ItemsTypesApi();
        Integer id = 56; // Integer | ID of the resource category.
        Items_type body = ; // Items_type | 
        try {
            items_type result = apiInstance.patchItemsType(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ItemsTypesApi#patchItemsType");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the resource category.
Items_type *body = ; //  (optional)

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

// Modify a resource category.
[apiInstance patchItemsTypeWith:id
    body:body
              completionHandler: ^(items_type output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ItemsTypesApi()
var id = 56; // {{Integer}} ID of the resource category.
var opts = { 
  'body':  // {{Items_type}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchItemsType(id, opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ItemsTypesApi();
            var id = 56;  // Integer | ID of the resource category.
            var body = new Items_type(); // Items_type |  (optional) 

            try
            {
                // Modify a resource category.
                items_type result = apiInstance.patchItemsType(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ItemsTypesApi.patchItemsType: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiItemsTypesApi();
$id = 56; // Integer | ID of the resource category.
$body = ; // Items_type | 

try {
    $result = $api_instance->patchItemsType($id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ItemsTypesApi->patchItemsType: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ItemsTypesApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ItemsTypesApi->new();
my $id = 56; # Integer | ID of the resource category.
my $body = WWW::SwaggerClient::Object::Items_type->new(); # Items_type | 

eval { 
    my $result = $api_instance->patchItemsType(id => $id, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ItemsTypesApi->patchItemsType: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ItemsTypesApi()
id = 56 # Integer | ID of the resource category.
body =  # Items_type |  (optional)

try: 
    # Modify a resource category.
    api_response = api_instance.patch_items_type(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ItemsTypesApi->patchItemsType: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the resource category.
Required
Body parameters
Name Description
body

Responses

Status: 200 - The patched resource category.


postItemsTypes

Create a resource category


/items_types

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/items_types"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ItemsTypesApi;

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

public class ItemsTypesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ItemsTypesApi apiInstance = new ItemsTypesApi();
        Items_types_body body = ; // Items_types_body | Parameters for creating a resource category
        try {
            apiInstance.postItemsTypes(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ItemsTypesApi#postItemsTypes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ItemsTypesApi;

public class ItemsTypesApiExample {

    public static void main(String[] args) {
        ItemsTypesApi apiInstance = new ItemsTypesApi();
        Items_types_body body = ; // Items_types_body | Parameters for creating a resource category
        try {
            apiInstance.postItemsTypes(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ItemsTypesApi#postItemsTypes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Items_types_body *body = ; // Parameters for creating a resource category (optional)

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

// Create a resource category
[apiInstance postItemsTypesWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ItemsTypesApi()
var opts = { 
  'body':  // {{Items_types_body}} Parameters for creating a resource category
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.postItemsTypes(opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ItemsTypesApi();
            var body = new Items_types_body(); // Items_types_body | Parameters for creating a resource category (optional) 

            try
            {
                // Create a resource category
                apiInstance.postItemsTypes(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ItemsTypesApi.postItemsTypes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiItemsTypesApi();
$body = ; // Items_types_body | Parameters for creating a resource category

try {
    $api_instance->postItemsTypes($body);
} catch (Exception $e) {
    echo 'Exception when calling ItemsTypesApi->postItemsTypes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ItemsTypesApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ItemsTypesApi->new();
my $body = WWW::SwaggerClient::Object::Items_types_body->new(); # Items_types_body | Parameters for creating a resource category

eval { 
    $api_instance->postItemsTypes(body => $body);
};
if ($@) {
    warn "Exception when calling ItemsTypesApi->postItemsTypes: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ItemsTypesApi()
body =  # Items_types_body | Parameters for creating a resource category (optional)

try: 
    # Create a resource category
    api_instance.post_items_types(body=body)
except ApiException as e:
    print("Exception when calling ItemsTypesApi->postItemsTypes: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 201 - The items type has been created.

Name Type Format Description
location String

readItemsTypes

Read all resources categories that are accessible.


/items_types

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/items_types"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ItemsTypesApi;

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

public class ItemsTypesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ItemsTypesApi apiInstance = new ItemsTypesApi();
        try {
            array[items_type] result = apiInstance.readItemsTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ItemsTypesApi#readItemsTypes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ItemsTypesApi;

public class ItemsTypesApiExample {

    public static void main(String[] args) {
        ItemsTypesApi apiInstance = new ItemsTypesApi();
        try {
            array[items_type] result = apiInstance.readItemsTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ItemsTypesApi#readItemsTypes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

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

// Read all resources categories that are accessible.
[apiInstance readItemsTypesWithCompletionHandler: 
              ^(array[items_type] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ItemsTypesApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readItemsTypes(callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ItemsTypesApi();

            try
            {
                // Read all resources categories that are accessible.
                array[items_type] result = apiInstance.readItemsTypes();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ItemsTypesApi.readItemsTypes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiItemsTypesApi();

try {
    $result = $api_instance->readItemsTypes();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ItemsTypesApi->readItemsTypes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ItemsTypesApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ItemsTypesApi->new();

eval { 
    my $result = $api_instance->readItemsTypes();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ItemsTypesApi->readItemsTypes: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ItemsTypesApi()

try: 
    # Read all resources categories that are accessible.
    api_response = api_instance.read_items_types()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ItemsTypesApi->readItemsTypes: %s\n" % e)

Parameters

Responses

Status: 200 - A list of resources categories.


LinksToExperiments




LinksToItems




Notifications

deleteNotifications

Delete all notifications of the user.

All notifications for the user are deleted.


/users/{id}/notifications

Usage and SDK Samples

curl -X DELETE\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/users/{id}/notifications"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NotificationsApi;

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

public class NotificationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        NotificationsApi apiInstance = new NotificationsApi();
        id_2 id = ; // id_2 | ID of the user or `me`.
        try {
            apiInstance.deleteNotifications(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationsApi#deleteNotifications");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NotificationsApi;

public class NotificationsApiExample {

    public static void main(String[] args) {
        NotificationsApi apiInstance = new NotificationsApi();
        id_2 id = ; // id_2 | ID of the user or `me`.
        try {
            apiInstance.deleteNotifications(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationsApi#deleteNotifications");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
id_2 *id = ; // ID of the user or `me`.

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

// Delete all notifications of the user.
[apiInstance deleteNotificationsWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.NotificationsApi()
var id = ; // {{id_2}} ID of the user or `me`.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteNotifications(id, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new NotificationsApi();
            var id = new id_2(); // id_2 | ID of the user or `me`.

            try
            {
                // Delete all notifications of the user.
                apiInstance.deleteNotifications(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NotificationsApi.deleteNotifications: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiNotificationsApi();
$id = ; // id_2 | ID of the user or `me`.

try {
    $api_instance->deleteNotifications($id);
} catch (Exception $e) {
    echo 'Exception when calling NotificationsApi->deleteNotifications: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NotificationsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::NotificationsApi->new();
my $id = ; # id_2 | ID of the user or `me`.

eval { 
    $api_instance->deleteNotifications(id => $id);
};
if ($@) {
    warn "Exception when calling NotificationsApi->deleteNotifications: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.NotificationsApi()
id =  # id_2 | ID of the user or `me`.

try: 
    # Delete all notifications of the user.
    api_instance.delete_notifications(id)
except ApiException as e:
    print("Exception when calling NotificationsApi->deleteNotifications: %s\n" % e)

Parameters

Path parameters
Name Description
id*
id_2
ID of the user or `me`.
Required

Responses

Status: 204 - The notifications were deleted.


patchNotification

Actions on a notification. Only changing `is_ack` column is possible.


/users/{id}/notifications/{subid}

Usage and SDK Samples

curl -X PATCH\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/users/{id}/notifications/{subid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NotificationsApi;

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

public class NotificationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        NotificationsApi apiInstance = new NotificationsApi();
        id_3 id = ; // id_3 | ID of the user or `me`.
        Integer subid = 56; // Integer | ID of the notification.
        try {
            notification result = apiInstance.patchNotification(id, subid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationsApi#patchNotification");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NotificationsApi;

public class NotificationsApiExample {

    public static void main(String[] args) {
        NotificationsApi apiInstance = new NotificationsApi();
        id_3 id = ; // id_3 | ID of the user or `me`.
        Integer subid = 56; // Integer | ID of the notification.
        try {
            notification result = apiInstance.patchNotification(id, subid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationsApi#patchNotification");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
id_3 *id = ; // ID of the user or `me`.
Integer *subid = 56; // ID of the notification.

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

// Actions on a notification. Only changing `is_ack` column is possible.

[apiInstance patchNotificationWith:id
    subid:subid
              completionHandler: ^(notification output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.NotificationsApi()
var id = ; // {{id_3}} ID of the user or `me`.
var subid = 56; // {{Integer}} ID of the notification.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchNotification(id, subid, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new NotificationsApi();
            var id = new id_3(); // id_3 | ID of the user or `me`.
            var subid = 56;  // Integer | ID of the notification.

            try
            {
                // Actions on a notification. Only changing `is_ack` column is possible.

                notification result = apiInstance.patchNotification(id, subid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NotificationsApi.patchNotification: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiNotificationsApi();
$id = ; // id_3 | ID of the user or `me`.
$subid = 56; // Integer | ID of the notification.

try {
    $result = $api_instance->patchNotification($id, $subid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NotificationsApi->patchNotification: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NotificationsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::NotificationsApi->new();
my $id = ; # id_3 | ID of the user or `me`.
my $subid = 56; # Integer | ID of the notification.

eval { 
    my $result = $api_instance->patchNotification(id => $id, subid => $subid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NotificationsApi->patchNotification: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.NotificationsApi()
id =  # id_3 | ID of the user or `me`.
subid = 56 # Integer | ID of the notification.

try: 
    # Actions on a notification. Only changing `is_ack` column is possible.

    api_response = api_instance.patch_notification(id, subid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NotificationsApi->patchNotification: %s\n" % e)

Parameters

Path parameters
Name Description
id*
id_3
ID of the user or `me`.
Required
subid*
Integer
ID of the notification.
Required

Responses

Status: 200 - The updated notification.


readNotification

Read a notification.


/users/{id}/notifications/{subid}

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/users/{id}/notifications/{subid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NotificationsApi;

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

public class NotificationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        NotificationsApi apiInstance = new NotificationsApi();
        id_3 id = ; // id_3 | ID of the user or `me`.
        Integer subid = 56; // Integer | ID of the notification.
        try {
            notification result = apiInstance.readNotification(id, subid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationsApi#readNotification");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NotificationsApi;

public class NotificationsApiExample {

    public static void main(String[] args) {
        NotificationsApi apiInstance = new NotificationsApi();
        id_3 id = ; // id_3 | ID of the user or `me`.
        Integer subid = 56; // Integer | ID of the notification.
        try {
            notification result = apiInstance.readNotification(id, subid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationsApi#readNotification");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
id_3 *id = ; // ID of the user or `me`.
Integer *subid = 56; // ID of the notification.

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

// Read a notification.
[apiInstance readNotificationWith:id
    subid:subid
              completionHandler: ^(notification output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.NotificationsApi()
var id = ; // {{id_3}} ID of the user or `me`.
var subid = 56; // {{Integer}} ID of the notification.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readNotification(id, subid, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new NotificationsApi();
            var id = new id_3(); // id_3 | ID of the user or `me`.
            var subid = 56;  // Integer | ID of the notification.

            try
            {
                // Read a notification.
                notification result = apiInstance.readNotification(id, subid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NotificationsApi.readNotification: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiNotificationsApi();
$id = ; // id_3 | ID of the user or `me`.
$subid = 56; // Integer | ID of the notification.

try {
    $result = $api_instance->readNotification($id, $subid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NotificationsApi->readNotification: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NotificationsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::NotificationsApi->new();
my $id = ; # id_3 | ID of the user or `me`.
my $subid = 56; # Integer | ID of the notification.

eval { 
    my $result = $api_instance->readNotification(id => $id, subid => $subid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NotificationsApi->readNotification: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.NotificationsApi()
id =  # id_3 | ID of the user or `me`.
subid = 56 # Integer | ID of the notification.

try: 
    # Read a notification.
    api_response = api_instance.read_notification(id, subid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NotificationsApi->readNotification: %s\n" % e)

Parameters

Path parameters
Name Description
id*
id_3
ID of the user or `me`.
Required
subid*
Integer
ID of the notification.
Required

Responses

Status: 200 - A notification.


readNotifications

Read notifications of a user.


/users/{id}/notifications

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/users/{id}/notifications"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NotificationsApi;

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

public class NotificationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        NotificationsApi apiInstance = new NotificationsApi();
        id_2 id = ; // id_2 | ID of the user or `me`.
        try {
            inline_response_200_6 result = apiInstance.readNotifications(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationsApi#readNotifications");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NotificationsApi;

public class NotificationsApiExample {

    public static void main(String[] args) {
        NotificationsApi apiInstance = new NotificationsApi();
        id_2 id = ; // id_2 | ID of the user or `me`.
        try {
            inline_response_200_6 result = apiInstance.readNotifications(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationsApi#readNotifications");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
id_2 *id = ; // ID of the user or `me`.

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

// Read notifications of a user.
[apiInstance readNotificationsWith:id
              completionHandler: ^(inline_response_200_6 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.NotificationsApi()
var id = ; // {{id_2}} ID of the user or `me`.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readNotifications(id, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new NotificationsApi();
            var id = new id_2(); // id_2 | ID of the user or `me`.

            try
            {
                // Read notifications of a user.
                inline_response_200_6 result = apiInstance.readNotifications(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NotificationsApi.readNotifications: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiNotificationsApi();
$id = ; // id_2 | ID of the user or `me`.

try {
    $result = $api_instance->readNotifications($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NotificationsApi->readNotifications: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NotificationsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::NotificationsApi->new();
my $id = ; # id_2 | ID of the user or `me`.

eval { 
    my $result = $api_instance->readNotifications(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NotificationsApi->readNotifications: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.NotificationsApi()
id =  # id_2 | ID of the user or `me`.

try: 
    # Read notifications of a user.
    api_response = api_instance.read_notifications(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NotificationsApi->readNotifications: %s\n" % e)

Parameters

Path parameters
Name Description
id*
id_2
ID of the user or `me`.
Required

Responses

Status: 200 - Notifications of a user.


ResourcesStatus

deleteResstatus

Delete a status.


/teams/{id}/items_status/{subid}

Usage and SDK Samples

curl -X DELETE\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/teams/{id}/items_status/{subid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ResourcesStatusApi;

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

public class ResourcesStatusApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ResourcesStatusApi apiInstance = new ResourcesStatusApi();
        Integer id = 56; // Integer | ID of the team.
        Integer subid = 56; // Integer | ID of the status
        try {
            apiInstance.deleteResstatus(id, subid);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResourcesStatusApi#deleteResstatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ResourcesStatusApi;

public class ResourcesStatusApiExample {

    public static void main(String[] args) {
        ResourcesStatusApi apiInstance = new ResourcesStatusApi();
        Integer id = 56; // Integer | ID of the team.
        Integer subid = 56; // Integer | ID of the status
        try {
            apiInstance.deleteResstatus(id, subid);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResourcesStatusApi#deleteResstatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the team.
Integer *subid = 56; // ID of the status

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

// Delete a status.
[apiInstance deleteResstatusWith:id
    subid:subid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ResourcesStatusApi()
var id = 56; // {{Integer}} ID of the team.
var subid = 56; // {{Integer}} ID of the status

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteResstatus(id, subid, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ResourcesStatusApi();
            var id = 56;  // Integer | ID of the team.
            var subid = 56;  // Integer | ID of the status

            try
            {
                // Delete a status.
                apiInstance.deleteResstatus(id, subid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResourcesStatusApi.deleteResstatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiResourcesStatusApi();
$id = 56; // Integer | ID of the team.
$subid = 56; // Integer | ID of the status

try {
    $api_instance->deleteResstatus($id, $subid);
} catch (Exception $e) {
    echo 'Exception when calling ResourcesStatusApi->deleteResstatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ResourcesStatusApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ResourcesStatusApi->new();
my $id = 56; # Integer | ID of the team.
my $subid = 56; # Integer | ID of the status

eval { 
    $api_instance->deleteResstatus(id => $id, subid => $subid);
};
if ($@) {
    warn "Exception when calling ResourcesStatusApi->deleteResstatus: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ResourcesStatusApi()
id = 56 # Integer | ID of the team.
subid = 56 # Integer | ID of the status

try: 
    # Delete a status.
    api_instance.delete_resstatus(id, subid)
except ApiException as e:
    print("Exception when calling ResourcesStatusApi->deleteResstatus: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the team.
Required
subid*
Integer
ID of the status
Required

Responses

Status: 204 - The status was removed.


patchResstatus

Modify a status.


/teams/{id}/items_status/{subid}

Usage and SDK Samples

curl -X PATCH\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/teams/{id}/items_status/{subid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ResourcesStatusApi;

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

public class ResourcesStatusApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ResourcesStatusApi apiInstance = new ResourcesStatusApi();
        Integer id = 56; // Integer | ID of the team.
        Integer subid = 56; // Integer | ID of the status
        Statuslike body = ; // Statuslike | Parameters for modifying a status.
        try {
            statuslike result = apiInstance.patchResstatus(id, subid, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResourcesStatusApi#patchResstatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ResourcesStatusApi;

public class ResourcesStatusApiExample {

    public static void main(String[] args) {
        ResourcesStatusApi apiInstance = new ResourcesStatusApi();
        Integer id = 56; // Integer | ID of the team.
        Integer subid = 56; // Integer | ID of the status
        Statuslike body = ; // Statuslike | Parameters for modifying a status.
        try {
            statuslike result = apiInstance.patchResstatus(id, subid, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResourcesStatusApi#patchResstatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the team.
Integer *subid = 56; // ID of the status
Statuslike *body = ; // Parameters for modifying a status. (optional)

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

// Modify a status.
[apiInstance patchResstatusWith:id
    subid:subid
    body:body
              completionHandler: ^(statuslike output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ResourcesStatusApi()
var id = 56; // {{Integer}} ID of the team.
var subid = 56; // {{Integer}} ID of the status
var opts = { 
  'body':  // {{Statuslike}} Parameters for modifying a status.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchResstatus(idsubid, opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ResourcesStatusApi();
            var id = 56;  // Integer | ID of the team.
            var subid = 56;  // Integer | ID of the status
            var body = new Statuslike(); // Statuslike | Parameters for modifying a status. (optional) 

            try
            {
                // Modify a status.
                statuslike result = apiInstance.patchResstatus(id, subid, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResourcesStatusApi.patchResstatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiResourcesStatusApi();
$id = 56; // Integer | ID of the team.
$subid = 56; // Integer | ID of the status
$body = ; // Statuslike | Parameters for modifying a status.

try {
    $result = $api_instance->patchResstatus($id, $subid, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ResourcesStatusApi->patchResstatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ResourcesStatusApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ResourcesStatusApi->new();
my $id = 56; # Integer | ID of the team.
my $subid = 56; # Integer | ID of the status
my $body = WWW::SwaggerClient::Object::Statuslike->new(); # Statuslike | Parameters for modifying a status.

eval { 
    my $result = $api_instance->patchResstatus(id => $id, subid => $subid, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ResourcesStatusApi->patchResstatus: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ResourcesStatusApi()
id = 56 # Integer | ID of the team.
subid = 56 # Integer | ID of the status
body =  # Statuslike | Parameters for modifying a status. (optional)

try: 
    # Modify a status.
    api_response = api_instance.patch_resstatus(id, subid, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ResourcesStatusApi->patchResstatus: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the team.
Required
subid*
Integer
ID of the status
Required
Body parameters
Name Description
body

Responses

Status: 200 - The updated status.


postTeamOneResstat

Create a new experiments status.


/teams/{id}/items_status

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/teams/{id}/items_status"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ResourcesStatusApi;

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

public class ResourcesStatusApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ResourcesStatusApi apiInstance = new ResourcesStatusApi();
        Integer id = 56; // Integer | ID of the team.
        Id_items_status_body body = ; // Id_items_status_body | Parameters for creating a resources status.
        try {
            apiInstance.postTeamOneResstat(id, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResourcesStatusApi#postTeamOneResstat");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ResourcesStatusApi;

public class ResourcesStatusApiExample {

    public static void main(String[] args) {
        ResourcesStatusApi apiInstance = new ResourcesStatusApi();
        Integer id = 56; // Integer | ID of the team.
        Id_items_status_body body = ; // Id_items_status_body | Parameters for creating a resources status.
        try {
            apiInstance.postTeamOneResstat(id, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResourcesStatusApi#postTeamOneResstat");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the team.
Id_items_status_body *body = ; // Parameters for creating a resources status. (optional)

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

// Create a new experiments status.
[apiInstance postTeamOneResstatWith:id
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ResourcesStatusApi()
var id = 56; // {{Integer}} ID of the team.
var opts = { 
  'body':  // {{Id_items_status_body}} Parameters for creating a resources status.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.postTeamOneResstat(id, opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ResourcesStatusApi();
            var id = 56;  // Integer | ID of the team.
            var body = new Id_items_status_body(); // Id_items_status_body | Parameters for creating a resources status. (optional) 

            try
            {
                // Create a new experiments status.
                apiInstance.postTeamOneResstat(id, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResourcesStatusApi.postTeamOneResstat: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiResourcesStatusApi();
$id = 56; // Integer | ID of the team.
$body = ; // Id_items_status_body | Parameters for creating a resources status.

try {
    $api_instance->postTeamOneResstat($id, $body);
} catch (Exception $e) {
    echo 'Exception when calling ResourcesStatusApi->postTeamOneResstat: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ResourcesStatusApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ResourcesStatusApi->new();
my $id = 56; # Integer | ID of the team.
my $body = WWW::SwaggerClient::Object::Id_items_status_body->new(); # Id_items_status_body | Parameters for creating a resources status.

eval { 
    $api_instance->postTeamOneResstat(id => $id, body => $body);
};
if ($@) {
    warn "Exception when calling ResourcesStatusApi->postTeamOneResstat: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ResourcesStatusApi()
id = 56 # Integer | ID of the team.
body =  # Id_items_status_body | Parameters for creating a resources status. (optional)

try: 
    # Create a new experiments status.
    api_instance.post_team_one_resstat(id, body=body)
except ApiException as e:
    print("Exception when calling ResourcesStatusApi->postTeamOneResstat: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the team.
Required
Body parameters
Name Description
body

Responses

Status: 201 - New resources status created.

Name Type Format Description
location String

readTeamItemsStatus

Read resources status of a team.


/teams/{id}/items_status

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/teams/{id}/items_status"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ResourcesStatusApi;

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

public class ResourcesStatusApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ResourcesStatusApi apiInstance = new ResourcesStatusApi();
        Integer id = 56; // Integer | ID of the team.
        try {
            array[statuslike] result = apiInstance.readTeamItemsStatus(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResourcesStatusApi#readTeamItemsStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ResourcesStatusApi;

public class ResourcesStatusApiExample {

    public static void main(String[] args) {
        ResourcesStatusApi apiInstance = new ResourcesStatusApi();
        Integer id = 56; // Integer | ID of the team.
        try {
            array[statuslike] result = apiInstance.readTeamItemsStatus(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResourcesStatusApi#readTeamItemsStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the team.

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

// Read resources status of a team.
[apiInstance readTeamItemsStatusWith:id
              completionHandler: ^(array[statuslike] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ResourcesStatusApi()
var id = 56; // {{Integer}} ID of the team.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readTeamItemsStatus(id, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ResourcesStatusApi();
            var id = 56;  // Integer | ID of the team.

            try
            {
                // Read resources status of a team.
                array[statuslike] result = apiInstance.readTeamItemsStatus(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResourcesStatusApi.readTeamItemsStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiResourcesStatusApi();
$id = 56; // Integer | ID of the team.

try {
    $result = $api_instance->readTeamItemsStatus($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ResourcesStatusApi->readTeamItemsStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ResourcesStatusApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ResourcesStatusApi->new();
my $id = 56; # Integer | ID of the team.

eval { 
    my $result = $api_instance->readTeamItemsStatus(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ResourcesStatusApi->readTeamItemsStatus: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ResourcesStatusApi()
id = 56 # Integer | ID of the team.

try: 
    # Read resources status of a team.
    api_response = api_instance.read_team_items_status(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ResourcesStatusApi->readTeamItemsStatus: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the team.
Required

Responses

Status: 200 - A list of resources status for the team.


readTeamOneResstatus

Read a status.


/teams/{id}/items_status/{subid}

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/teams/{id}/items_status/{subid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ResourcesStatusApi;

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

public class ResourcesStatusApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ResourcesStatusApi apiInstance = new ResourcesStatusApi();
        Integer id = 56; // Integer | ID of the team.
        Integer subid = 56; // Integer | ID of the status
        try {
            statuslike result = apiInstance.readTeamOneResstatus(id, subid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResourcesStatusApi#readTeamOneResstatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ResourcesStatusApi;

public class ResourcesStatusApiExample {

    public static void main(String[] args) {
        ResourcesStatusApi apiInstance = new ResourcesStatusApi();
        Integer id = 56; // Integer | ID of the team.
        Integer subid = 56; // Integer | ID of the status
        try {
            statuslike result = apiInstance.readTeamOneResstatus(id, subid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResourcesStatusApi#readTeamOneResstatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the team.
Integer *subid = 56; // ID of the status

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

// Read a status.
[apiInstance readTeamOneResstatusWith:id
    subid:subid
              completionHandler: ^(statuslike output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.ResourcesStatusApi()
var id = 56; // {{Integer}} ID of the team.
var subid = 56; // {{Integer}} ID of the status

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readTeamOneResstatus(id, subid, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ResourcesStatusApi();
            var id = 56;  // Integer | ID of the team.
            var subid = 56;  // Integer | ID of the status

            try
            {
                // Read a status.
                statuslike result = apiInstance.readTeamOneResstatus(id, subid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResourcesStatusApi.readTeamOneResstatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiResourcesStatusApi();
$id = 56; // Integer | ID of the team.
$subid = 56; // Integer | ID of the status

try {
    $result = $api_instance->readTeamOneResstatus($id, $subid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ResourcesStatusApi->readTeamOneResstatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ResourcesStatusApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ResourcesStatusApi->new();
my $id = 56; # Integer | ID of the team.
my $subid = 56; # Integer | ID of the status

eval { 
    my $result = $api_instance->readTeamOneResstatus(id => $id, subid => $subid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ResourcesStatusApi->readTeamOneResstatus: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.ResourcesStatusApi()
id = 56 # Integer | ID of the team.
subid = 56 # Integer | ID of the status

try: 
    # Read a status.
    api_response = api_instance.read_team_one_resstatus(id, subid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ResourcesStatusApi->readTeamOneResstatus: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the team.
Required
subid*
Integer
ID of the status
Required

Responses

Status: 200 - Read a status.


Revisions

patchEntityRevision

Restore a revision.


/{entity_type}/{id}/revisions/{subid}

Usage and SDK Samples

curl -X PATCH\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/{entity_type}/{id}/revisions/{subid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RevisionsApi;

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

public class RevisionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        RevisionsApi apiInstance = new RevisionsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        Integer subid = 56; // Integer | ID of the revision
        Revisions_subid_body body = ; // Revisions_subid_body | Parameters for restoring an entity revision.
        try {
            revision result = apiInstance.patchEntityRevision(entityType, id, subid, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RevisionsApi#patchEntityRevision");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RevisionsApi;

public class RevisionsApiExample {

    public static void main(String[] args) {
        RevisionsApi apiInstance = new RevisionsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        Integer subid = 56; // Integer | ID of the revision
        Revisions_subid_body body = ; // Revisions_subid_body | Parameters for restoring an entity revision.
        try {
            revision result = apiInstance.patchEntityRevision(entityType, id, subid, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RevisionsApi#patchEntityRevision");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *entityType = entityType_example; // Entity type
Integer *id = 56; // ID of the entity
Integer *subid = 56; // ID of the revision
Revisions_subid_body *body = ; // Parameters for restoring an entity revision. (optional)

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

// Restore a revision.
[apiInstance patchEntityRevisionWith:entityType
    id:id
    subid:subid
    body:body
              completionHandler: ^(revision output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.RevisionsApi()
var entityType = entityType_example; // {{String}} Entity type
var id = 56; // {{Integer}} ID of the entity
var subid = 56; // {{Integer}} ID of the revision
var opts = { 
  'body':  // {{Revisions_subid_body}} Parameters for restoring an entity revision.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchEntityRevision(entityTypeidsubid, opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new RevisionsApi();
            var entityType = entityType_example;  // String | Entity type
            var id = 56;  // Integer | ID of the entity
            var subid = 56;  // Integer | ID of the revision
            var body = new Revisions_subid_body(); // Revisions_subid_body | Parameters for restoring an entity revision. (optional) 

            try
            {
                // Restore a revision.
                revision result = apiInstance.patchEntityRevision(entityType, id, subid, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RevisionsApi.patchEntityRevision: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiRevisionsApi();
$entityType = entityType_example; // String | Entity type
$id = 56; // Integer | ID of the entity
$subid = 56; // Integer | ID of the revision
$body = ; // Revisions_subid_body | Parameters for restoring an entity revision.

try {
    $result = $api_instance->patchEntityRevision($entityType, $id, $subid, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RevisionsApi->patchEntityRevision: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RevisionsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::RevisionsApi->new();
my $entityType = entityType_example; # String | Entity type
my $id = 56; # Integer | ID of the entity
my $subid = 56; # Integer | ID of the revision
my $body = WWW::SwaggerClient::Object::Revisions_subid_body->new(); # Revisions_subid_body | Parameters for restoring an entity revision.

eval { 
    my $result = $api_instance->patchEntityRevision(entityType => $entityType, id => $id, subid => $subid, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RevisionsApi->patchEntityRevision: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.RevisionsApi()
entityType = entityType_example # String | Entity type
id = 56 # Integer | ID of the entity
subid = 56 # Integer | ID of the revision
body =  # Revisions_subid_body | Parameters for restoring an entity revision. (optional)

try: 
    # Restore a revision.
    api_response = api_instance.patch_entity_revision(entityType, id, subid, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RevisionsApi->patchEntityRevision: %s\n" % e)

Parameters

Path parameters
Name Description
entity_type*
String
Entity type
Required
id*
Integer
ID of the entity
Required
subid*
Integer
ID of the revision
Required
Body parameters
Name Description
body

Responses

Status: 200 - The (unchanged) revision


postEntityRevisions

Create a revision.


/{entity_type}/{id}/revisions

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/{entity_type}/{id}/revisions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RevisionsApi;

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

public class RevisionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        RevisionsApi apiInstance = new RevisionsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        Id_revisions_body body = ; // Id_revisions_body | Parameters for creating a revision
        try {
            apiInstance.postEntityRevisions(entityType, id, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling RevisionsApi#postEntityRevisions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RevisionsApi;

public class RevisionsApiExample {

    public static void main(String[] args) {
        RevisionsApi apiInstance = new RevisionsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        Id_revisions_body body = ; // Id_revisions_body | Parameters for creating a revision
        try {
            apiInstance.postEntityRevisions(entityType, id, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling RevisionsApi#postEntityRevisions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *entityType = entityType_example; // Entity type
Integer *id = 56; // ID of the entity
Id_revisions_body *body = ; // Parameters for creating a revision (optional)

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

// Create a revision.
[apiInstance postEntityRevisionsWith:entityType
    id:id
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.RevisionsApi()
var entityType = entityType_example; // {{String}} Entity type
var id = 56; // {{Integer}} ID of the entity
var opts = { 
  'body':  // {{Id_revisions_body}} Parameters for creating a revision
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.postEntityRevisions(entityTypeid, opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new RevisionsApi();
            var entityType = entityType_example;  // String | Entity type
            var id = 56;  // Integer | ID of the entity
            var body = new Id_revisions_body(); // Id_revisions_body | Parameters for creating a revision (optional) 

            try
            {
                // Create a revision.
                apiInstance.postEntityRevisions(entityType, id, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RevisionsApi.postEntityRevisions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiRevisionsApi();
$entityType = entityType_example; // String | Entity type
$id = 56; // Integer | ID of the entity
$body = ; // Id_revisions_body | Parameters for creating a revision

try {
    $api_instance->postEntityRevisions($entityType, $id, $body);
} catch (Exception $e) {
    echo 'Exception when calling RevisionsApi->postEntityRevisions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RevisionsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::RevisionsApi->new();
my $entityType = entityType_example; # String | Entity type
my $id = 56; # Integer | ID of the entity
my $body = WWW::SwaggerClient::Object::Id_revisions_body->new(); # Id_revisions_body | Parameters for creating a revision

eval { 
    $api_instance->postEntityRevisions(entityType => $entityType, id => $id, body => $body);
};
if ($@) {
    warn "Exception when calling RevisionsApi->postEntityRevisions: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.RevisionsApi()
entityType = entityType_example # String | Entity type
id = 56 # Integer | ID of the entity
body =  # Id_revisions_body | Parameters for creating a revision (optional)

try: 
    # Create a revision.
    api_instance.post_entity_revisions(entityType, id, body=body)
except ApiException as e:
    print("Exception when calling RevisionsApi->postEntityRevisions: %s\n" % e)

Parameters

Path parameters
Name Description
entity_type*
String
Entity type
Required
id*
Integer
ID of the entity
Required
Body parameters
Name Description
body

Responses

Status: 201 - The revision has been created.

Name Type Format Description
location String

readEntityRevision

Read a revision of that entity.


/{entity_type}/{id}/revisions/{subid}

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/{entity_type}/{id}/revisions/{subid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RevisionsApi;

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

public class RevisionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        RevisionsApi apiInstance = new RevisionsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        Integer subid = 56; // Integer | ID of the revision
        try {
            revision result = apiInstance.readEntityRevision(entityType, id, subid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RevisionsApi#readEntityRevision");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RevisionsApi;

public class RevisionsApiExample {

    public static void main(String[] args) {
        RevisionsApi apiInstance = new RevisionsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        Integer subid = 56; // Integer | ID of the revision
        try {
            revision result = apiInstance.readEntityRevision(entityType, id, subid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RevisionsApi#readEntityRevision");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *entityType = entityType_example; // Entity type
Integer *id = 56; // ID of the entity
Integer *subid = 56; // ID of the revision

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

// Read a revision of that entity.
[apiInstance readEntityRevisionWith:entityType
    id:id
    subid:subid
              completionHandler: ^(revision output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.RevisionsApi()
var entityType = entityType_example; // {{String}} Entity type
var id = 56; // {{Integer}} ID of the entity
var subid = 56; // {{Integer}} ID of the revision

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readEntityRevision(entityType, id, subid, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new RevisionsApi();
            var entityType = entityType_example;  // String | Entity type
            var id = 56;  // Integer | ID of the entity
            var subid = 56;  // Integer | ID of the revision

            try
            {
                // Read a revision of that entity.
                revision result = apiInstance.readEntityRevision(entityType, id, subid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RevisionsApi.readEntityRevision: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiRevisionsApi();
$entityType = entityType_example; // String | Entity type
$id = 56; // Integer | ID of the entity
$subid = 56; // Integer | ID of the revision

try {
    $result = $api_instance->readEntityRevision($entityType, $id, $subid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RevisionsApi->readEntityRevision: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RevisionsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::RevisionsApi->new();
my $entityType = entityType_example; # String | Entity type
my $id = 56; # Integer | ID of the entity
my $subid = 56; # Integer | ID of the revision

eval { 
    my $result = $api_instance->readEntityRevision(entityType => $entityType, id => $id, subid => $subid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RevisionsApi->readEntityRevision: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.RevisionsApi()
entityType = entityType_example # String | Entity type
id = 56 # Integer | ID of the entity
subid = 56 # Integer | ID of the revision

try: 
    # Read a revision of that entity.
    api_response = api_instance.read_entity_revision(entityType, id, subid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RevisionsApi->readEntityRevision: %s\n" % e)

Parameters

Path parameters
Name Description
entity_type*
String
Entity type
Required
id*
Integer
ID of the entity
Required
subid*
Integer
ID of the revision
Required

Responses

Status: 200 - A revision.


readEntityRevisions

Read all revisions of that entity.


/{entity_type}/{id}/revisions

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/{entity_type}/{id}/revisions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RevisionsApi;

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

public class RevisionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        RevisionsApi apiInstance = new RevisionsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        try {
            array[inline_response_200_7] result = apiInstance.readEntityRevisions(entityType, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RevisionsApi#readEntityRevisions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RevisionsApi;

public class RevisionsApiExample {

    public static void main(String[] args) {
        RevisionsApi apiInstance = new RevisionsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        try {
            array[inline_response_200_7] result = apiInstance.readEntityRevisions(entityType, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RevisionsApi#readEntityRevisions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *entityType = entityType_example; // Entity type
Integer *id = 56; // ID of the entity

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

// Read all revisions of that entity.
[apiInstance readEntityRevisionsWith:entityType
    id:id
              completionHandler: ^(array[inline_response_200_7] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.RevisionsApi()
var entityType = entityType_example; // {{String}} Entity type
var id = 56; // {{Integer}} ID of the entity

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readEntityRevisions(entityType, id, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new RevisionsApi();
            var entityType = entityType_example;  // String | Entity type
            var id = 56;  // Integer | ID of the entity

            try
            {
                // Read all revisions of that entity.
                array[inline_response_200_7] result = apiInstance.readEntityRevisions(entityType, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RevisionsApi.readEntityRevisions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiRevisionsApi();
$entityType = entityType_example; // String | Entity type
$id = 56; // Integer | ID of the entity

try {
    $result = $api_instance->readEntityRevisions($entityType, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RevisionsApi->readEntityRevisions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RevisionsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::RevisionsApi->new();
my $entityType = entityType_example; # String | Entity type
my $id = 56; # Integer | ID of the entity

eval { 
    my $result = $api_instance->readEntityRevisions(entityType => $entityType, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RevisionsApi->readEntityRevisions: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.RevisionsApi()
entityType = entityType_example # String | Entity type
id = 56 # Integer | ID of the entity

try: 
    # Read all revisions of that entity.
    api_response = api_instance.read_entity_revisions(entityType, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RevisionsApi->readEntityRevisions: %s\n" % e)

Parameters

Path parameters
Name Description
entity_type*
String
Entity type
Required
id*
Integer
ID of the entity
Required

Responses

Status: 200 - A list of revisions for that entity


Steps

deleteStep

Delete a step.

The step gets deleted.


/{entity_type}/{id}/steps/{subid}

Usage and SDK Samples

curl -X DELETE\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/{entity_type}/{id}/steps/{subid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StepsApi;

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

public class StepsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        StepsApi apiInstance = new StepsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        Integer subid = 56; // Integer | ID of the step
        try {
            apiInstance.deleteStep(entityType, id, subid);
        } catch (ApiException e) {
            System.err.println("Exception when calling StepsApi#deleteStep");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StepsApi;

public class StepsApiExample {

    public static void main(String[] args) {
        StepsApi apiInstance = new StepsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        Integer subid = 56; // Integer | ID of the step
        try {
            apiInstance.deleteStep(entityType, id, subid);
        } catch (ApiException e) {
            System.err.println("Exception when calling StepsApi#deleteStep");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *entityType = entityType_example; // Entity type
Integer *id = 56; // ID of the entity
Integer *subid = 56; // ID of the step

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

// Delete a step.
[apiInstance deleteStepWith:entityType
    id:id
    subid:subid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.StepsApi()
var entityType = entityType_example; // {{String}} Entity type
var id = 56; // {{Integer}} ID of the entity
var subid = 56; // {{Integer}} ID of the step

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteStep(entityType, id, subid, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new StepsApi();
            var entityType = entityType_example;  // String | Entity type
            var id = 56;  // Integer | ID of the entity
            var subid = 56;  // Integer | ID of the step

            try
            {
                // Delete a step.
                apiInstance.deleteStep(entityType, id, subid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StepsApi.deleteStep: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiStepsApi();
$entityType = entityType_example; // String | Entity type
$id = 56; // Integer | ID of the entity
$subid = 56; // Integer | ID of the step

try {
    $api_instance->deleteStep($entityType, $id, $subid);
} catch (Exception $e) {
    echo 'Exception when calling StepsApi->deleteStep: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StepsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::StepsApi->new();
my $entityType = entityType_example; # String | Entity type
my $id = 56; # Integer | ID of the entity
my $subid = 56; # Integer | ID of the step

eval { 
    $api_instance->deleteStep(entityType => $entityType, id => $id, subid => $subid);
};
if ($@) {
    warn "Exception when calling StepsApi->deleteStep: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.StepsApi()
entityType = entityType_example # String | Entity type
id = 56 # Integer | ID of the entity
subid = 56 # Integer | ID of the step

try: 
    # Delete a step.
    api_instance.delete_step(entityType, id, subid)
except ApiException as e:
    print("Exception when calling StepsApi->deleteStep: %s\n" % e)

Parameters

Path parameters
Name Description
entity_type*
String
Entity type
Required
id*
Integer
ID of the entity
Required
subid*
Integer
ID of the step
Required

Responses

Status: 204 - The step was deleted.


patchStep

Actions on a step.


/{entity_type}/{id}/steps/{subid}

Usage and SDK Samples

curl -X PATCH\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/{entity_type}/{id}/steps/{subid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StepsApi;

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

public class StepsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        StepsApi apiInstance = new StepsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        Integer subid = 56; // Integer | ID of the step
        Steps_subid_body body = ; // Steps_subid_body | Parameters for modifying a step
        try {
            step result = apiInstance.patchStep(entityType, id, subid, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StepsApi#patchStep");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StepsApi;

public class StepsApiExample {

    public static void main(String[] args) {
        StepsApi apiInstance = new StepsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        Integer subid = 56; // Integer | ID of the step
        Steps_subid_body body = ; // Steps_subid_body | Parameters for modifying a step
        try {
            step result = apiInstance.patchStep(entityType, id, subid, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StepsApi#patchStep");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *entityType = entityType_example; // Entity type
Integer *id = 56; // ID of the entity
Integer *subid = 56; // ID of the step
Steps_subid_body *body = ; // Parameters for modifying a step (optional)

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

// Actions on a step.

[apiInstance patchStepWith:entityType
    id:id
    subid:subid
    body:body
              completionHandler: ^(step output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.StepsApi()
var entityType = entityType_example; // {{String}} Entity type
var id = 56; // {{Integer}} ID of the entity
var subid = 56; // {{Integer}} ID of the step
var opts = { 
  'body':  // {{Steps_subid_body}} Parameters for modifying a step
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchStep(entityTypeidsubid, opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new StepsApi();
            var entityType = entityType_example;  // String | Entity type
            var id = 56;  // Integer | ID of the entity
            var subid = 56;  // Integer | ID of the step
            var body = new Steps_subid_body(); // Steps_subid_body | Parameters for modifying a step (optional) 

            try
            {
                // Actions on a step.

                step result = apiInstance.patchStep(entityType, id, subid, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StepsApi.patchStep: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiStepsApi();
$entityType = entityType_example; // String | Entity type
$id = 56; // Integer | ID of the entity
$subid = 56; // Integer | ID of the step
$body = ; // Steps_subid_body | Parameters for modifying a step

try {
    $result = $api_instance->patchStep($entityType, $id, $subid, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StepsApi->patchStep: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StepsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::StepsApi->new();
my $entityType = entityType_example; # String | Entity type
my $id = 56; # Integer | ID of the entity
my $subid = 56; # Integer | ID of the step
my $body = WWW::SwaggerClient::Object::Steps_subid_body->new(); # Steps_subid_body | Parameters for modifying a step

eval { 
    my $result = $api_instance->patchStep(entityType => $entityType, id => $id, subid => $subid, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StepsApi->patchStep: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.StepsApi()
entityType = entityType_example # String | Entity type
id = 56 # Integer | ID of the entity
subid = 56 # Integer | ID of the step
body =  # Steps_subid_body | Parameters for modifying a step (optional)

try: 
    # Actions on a step.

    api_response = api_instance.patch_step(entityType, id, subid, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StepsApi->patchStep: %s\n" % e)

Parameters

Path parameters
Name Description
entity_type*
String
Entity type
Required
id*
Integer
ID of the entity
Required
subid*
Integer
ID of the step
Required
Body parameters
Name Description
body

Responses

Status: 200 - The updated step.


postStep

Create a step.


/{entity_type}/{id}/steps

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/{entity_type}/{id}/steps"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StepsApi;

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

public class StepsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        StepsApi apiInstance = new StepsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        Id_steps_body body = ; // Id_steps_body | Parameters for creating a step.
        try {
            apiInstance.postStep(entityType, id, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling StepsApi#postStep");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StepsApi;

public class StepsApiExample {

    public static void main(String[] args) {
        StepsApi apiInstance = new StepsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        Id_steps_body body = ; // Id_steps_body | Parameters for creating a step.
        try {
            apiInstance.postStep(entityType, id, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling StepsApi#postStep");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *entityType = entityType_example; // Entity type
Integer *id = 56; // ID of the entity
Id_steps_body *body = ; // Parameters for creating a step. (optional)

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

// Create a step.
[apiInstance postStepWith:entityType
    id:id
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.StepsApi()
var entityType = entityType_example; // {{String}} Entity type
var id = 56; // {{Integer}} ID of the entity
var opts = { 
  'body':  // {{Id_steps_body}} Parameters for creating a step.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.postStep(entityTypeid, opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new StepsApi();
            var entityType = entityType_example;  // String | Entity type
            var id = 56;  // Integer | ID of the entity
            var body = new Id_steps_body(); // Id_steps_body | Parameters for creating a step. (optional) 

            try
            {
                // Create a step.
                apiInstance.postStep(entityType, id, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StepsApi.postStep: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiStepsApi();
$entityType = entityType_example; // String | Entity type
$id = 56; // Integer | ID of the entity
$body = ; // Id_steps_body | Parameters for creating a step.

try {
    $api_instance->postStep($entityType, $id, $body);
} catch (Exception $e) {
    echo 'Exception when calling StepsApi->postStep: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StepsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::StepsApi->new();
my $entityType = entityType_example; # String | Entity type
my $id = 56; # Integer | ID of the entity
my $body = WWW::SwaggerClient::Object::Id_steps_body->new(); # Id_steps_body | Parameters for creating a step.

eval { 
    $api_instance->postStep(entityType => $entityType, id => $id, body => $body);
};
if ($@) {
    warn "Exception when calling StepsApi->postStep: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.StepsApi()
entityType = entityType_example # String | Entity type
id = 56 # Integer | ID of the entity
body =  # Id_steps_body | Parameters for creating a step. (optional)

try: 
    # Create a step.
    api_instance.post_step(entityType, id, body=body)
except ApiException as e:
    print("Exception when calling StepsApi->postStep: %s\n" % e)

Parameters

Path parameters
Name Description
entity_type*
String
Entity type
Required
id*
Integer
ID of the entity
Required
Body parameters
Name Description
body

Responses

Status: 201 - The step has been created.

Name Type Format Description
location String

readSteps

Read all steps of that entity.


/{entity_type}/{id}/steps

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/{entity_type}/{id}/steps"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StepsApi;

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

public class StepsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        StepsApi apiInstance = new StepsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        try {
            array[step] result = apiInstance.readSteps(entityType, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StepsApi#readSteps");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StepsApi;

public class StepsApiExample {

    public static void main(String[] args) {
        StepsApi apiInstance = new StepsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        try {
            array[step] result = apiInstance.readSteps(entityType, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StepsApi#readSteps");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *entityType = entityType_example; // Entity type
Integer *id = 56; // ID of the entity

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

// Read all steps of that entity.
[apiInstance readStepsWith:entityType
    id:id
              completionHandler: ^(array[step] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.StepsApi()
var entityType = entityType_example; // {{String}} Entity type
var id = 56; // {{Integer}} ID of the entity

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readSteps(entityType, id, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new StepsApi();
            var entityType = entityType_example;  // String | Entity type
            var id = 56;  // Integer | ID of the entity

            try
            {
                // Read all steps of that entity.
                array[step] result = apiInstance.readSteps(entityType, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StepsApi.readSteps: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiStepsApi();
$entityType = entityType_example; // String | Entity type
$id = 56; // Integer | ID of the entity

try {
    $result = $api_instance->readSteps($entityType, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StepsApi->readSteps: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StepsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::StepsApi->new();
my $entityType = entityType_example; # String | Entity type
my $id = 56; # Integer | ID of the entity

eval { 
    my $result = $api_instance->readSteps(entityType => $entityType, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StepsApi->readSteps: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.StepsApi()
entityType = entityType_example # String | Entity type
id = 56 # Integer | ID of the entity

try: 
    # Read all steps of that entity.
    api_response = api_instance.read_steps(entityType, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StepsApi->readSteps: %s\n" % e)

Parameters

Path parameters
Name Description
entity_type*
String
Entity type
Required
id*
Integer
ID of the entity
Required

Responses

Status: 200 - A list of steps


Tags

deleteTag

Delete all tags.

All the tags from that entity get removed.


/{entity_type}/{id}/tags

Usage and SDK Samples

curl -X DELETE\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/{entity_type}/{id}/tags"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TagsApi;

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

public class TagsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        TagsApi apiInstance = new TagsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        try {
            apiInstance.deleteTag(entityType, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#deleteTag");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TagsApi;

public class TagsApiExample {

    public static void main(String[] args) {
        TagsApi apiInstance = new TagsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        try {
            apiInstance.deleteTag(entityType, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#deleteTag");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *entityType = entityType_example; // Entity type
Integer *id = 56; // ID of the entity

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

// Delete all tags.
[apiInstance deleteTagWith:entityType
    id:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.TagsApi()
var entityType = entityType_example; // {{String}} Entity type
var id = 56; // {{Integer}} ID of the entity

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteTag(entityType, id, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new TagsApi();
            var entityType = entityType_example;  // String | Entity type
            var id = 56;  // Integer | ID of the entity

            try
            {
                // Delete all tags.
                apiInstance.deleteTag(entityType, id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TagsApi.deleteTag: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiTagsApi();
$entityType = entityType_example; // String | Entity type
$id = 56; // Integer | ID of the entity

try {
    $api_instance->deleteTag($entityType, $id);
} catch (Exception $e) {
    echo 'Exception when calling TagsApi->deleteTag: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TagsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TagsApi->new();
my $entityType = entityType_example; # String | Entity type
my $id = 56; # Integer | ID of the entity

eval { 
    $api_instance->deleteTag(entityType => $entityType, id => $id);
};
if ($@) {
    warn "Exception when calling TagsApi->deleteTag: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.TagsApi()
entityType = entityType_example # String | Entity type
id = 56 # Integer | ID of the entity

try: 
    # Delete all tags.
    api_instance.delete_tag(entityType, id)
except ApiException as e:
    print("Exception when calling TagsApi->deleteTag: %s\n" % e)

Parameters

Path parameters
Name Description
entity_type*
String
Entity type
Required
id*
Integer
ID of the entity
Required

Responses

Status: 204 - The tags were deleted.


patchTag

Actions on a tag (like removing it from the entity).


/{entity_type}/{id}/tags/{subid}

Usage and SDK Samples

curl -X PATCH\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/{entity_type}/{id}/tags/{subid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TagsApi;

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

public class TagsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        TagsApi apiInstance = new TagsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        Integer subid = 56; // Integer | ID of the tag
        Tags_subid_body body = ; // Tags_subid_body | Parameters for modifying a tag
        try {
            tag result = apiInstance.patchTag(entityType, id, subid, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#patchTag");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TagsApi;

public class TagsApiExample {

    public static void main(String[] args) {
        TagsApi apiInstance = new TagsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        Integer subid = 56; // Integer | ID of the tag
        Tags_subid_body body = ; // Tags_subid_body | Parameters for modifying a tag
        try {
            tag result = apiInstance.patchTag(entityType, id, subid, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#patchTag");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *entityType = entityType_example; // Entity type
Integer *id = 56; // ID of the entity
Integer *subid = 56; // ID of the tag
Tags_subid_body *body = ; // Parameters for modifying a tag (optional)

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

// Actions on a tag (like removing it from the entity).

[apiInstance patchTagWith:entityType
    id:id
    subid:subid
    body:body
              completionHandler: ^(tag output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.TagsApi()
var entityType = entityType_example; // {{String}} Entity type
var id = 56; // {{Integer}} ID of the entity
var subid = 56; // {{Integer}} ID of the tag
var opts = { 
  'body':  // {{Tags_subid_body}} Parameters for modifying a tag
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchTag(entityTypeidsubid, opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new TagsApi();
            var entityType = entityType_example;  // String | Entity type
            var id = 56;  // Integer | ID of the entity
            var subid = 56;  // Integer | ID of the tag
            var body = new Tags_subid_body(); // Tags_subid_body | Parameters for modifying a tag (optional) 

            try
            {
                // Actions on a tag (like removing it from the entity).

                tag result = apiInstance.patchTag(entityType, id, subid, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TagsApi.patchTag: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiTagsApi();
$entityType = entityType_example; // String | Entity type
$id = 56; // Integer | ID of the entity
$subid = 56; // Integer | ID of the tag
$body = ; // Tags_subid_body | Parameters for modifying a tag

try {
    $result = $api_instance->patchTag($entityType, $id, $subid, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TagsApi->patchTag: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TagsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TagsApi->new();
my $entityType = entityType_example; # String | Entity type
my $id = 56; # Integer | ID of the entity
my $subid = 56; # Integer | ID of the tag
my $body = WWW::SwaggerClient::Object::Tags_subid_body->new(); # Tags_subid_body | Parameters for modifying a tag

eval { 
    my $result = $api_instance->patchTag(entityType => $entityType, id => $id, subid => $subid, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TagsApi->patchTag: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.TagsApi()
entityType = entityType_example # String | Entity type
id = 56 # Integer | ID of the entity
subid = 56 # Integer | ID of the tag
body =  # Tags_subid_body | Parameters for modifying a tag (optional)

try: 
    # Actions on a tag (like removing it from the entity).

    api_response = api_instance.patch_tag(entityType, id, subid, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagsApi->patchTag: %s\n" % e)

Parameters

Path parameters
Name Description
entity_type*
String
Entity type
Required
id*
Integer
ID of the entity
Required
subid*
Integer
ID of the tag
Required
Body parameters
Name Description
body

Responses

Status: 200 - The updated tag.


postTag

Create a tag.


/{entity_type}/{id}/tags

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/{entity_type}/{id}/tags"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TagsApi;

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

public class TagsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        TagsApi apiInstance = new TagsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        Id_tags_body body = ; // Id_tags_body | Parameters for creating a tag.
        try {
            apiInstance.postTag(entityType, id, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#postTag");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TagsApi;

public class TagsApiExample {

    public static void main(String[] args) {
        TagsApi apiInstance = new TagsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        Id_tags_body body = ; // Id_tags_body | Parameters for creating a tag.
        try {
            apiInstance.postTag(entityType, id, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#postTag");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *entityType = entityType_example; // Entity type
Integer *id = 56; // ID of the entity
Id_tags_body *body = ; // Parameters for creating a tag. (optional)

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

// Create a tag.
[apiInstance postTagWith:entityType
    id:id
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.TagsApi()
var entityType = entityType_example; // {{String}} Entity type
var id = 56; // {{Integer}} ID of the entity
var opts = { 
  'body':  // {{Id_tags_body}} Parameters for creating a tag.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.postTag(entityTypeid, opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new TagsApi();
            var entityType = entityType_example;  // String | Entity type
            var id = 56;  // Integer | ID of the entity
            var body = new Id_tags_body(); // Id_tags_body | Parameters for creating a tag. (optional) 

            try
            {
                // Create a tag.
                apiInstance.postTag(entityType, id, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TagsApi.postTag: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiTagsApi();
$entityType = entityType_example; // String | Entity type
$id = 56; // Integer | ID of the entity
$body = ; // Id_tags_body | Parameters for creating a tag.

try {
    $api_instance->postTag($entityType, $id, $body);
} catch (Exception $e) {
    echo 'Exception when calling TagsApi->postTag: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TagsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TagsApi->new();
my $entityType = entityType_example; # String | Entity type
my $id = 56; # Integer | ID of the entity
my $body = WWW::SwaggerClient::Object::Id_tags_body->new(); # Id_tags_body | Parameters for creating a tag.

eval { 
    $api_instance->postTag(entityType => $entityType, id => $id, body => $body);
};
if ($@) {
    warn "Exception when calling TagsApi->postTag: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.TagsApi()
entityType = entityType_example # String | Entity type
id = 56 # Integer | ID of the entity
body =  # Id_tags_body | Parameters for creating a tag. (optional)

try: 
    # Create a tag.
    api_instance.post_tag(entityType, id, body=body)
except ApiException as e:
    print("Exception when calling TagsApi->postTag: %s\n" % e)

Parameters

Path parameters
Name Description
entity_type*
String
Entity type
Required
id*
Integer
ID of the entity
Required
Body parameters
Name Description
body

Responses

Status: 201 - The tag has been created.

Name Type Format Description
location String

readTag

Read a tag.


/{entity_type}/{id}/tags/{subid}

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/{entity_type}/{id}/tags/{subid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TagsApi;

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

public class TagsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        TagsApi apiInstance = new TagsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        Integer subid = 56; // Integer | ID of the tag
        try {
            tag result = apiInstance.readTag(entityType, id, subid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#readTag");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TagsApi;

public class TagsApiExample {

    public static void main(String[] args) {
        TagsApi apiInstance = new TagsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        Integer subid = 56; // Integer | ID of the tag
        try {
            tag result = apiInstance.readTag(entityType, id, subid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#readTag");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *entityType = entityType_example; // Entity type
Integer *id = 56; // ID of the entity
Integer *subid = 56; // ID of the tag

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

// Read a tag.
[apiInstance readTagWith:entityType
    id:id
    subid:subid
              completionHandler: ^(tag output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.TagsApi()
var entityType = entityType_example; // {{String}} Entity type
var id = 56; // {{Integer}} ID of the entity
var subid = 56; // {{Integer}} ID of the tag

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readTag(entityType, id, subid, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new TagsApi();
            var entityType = entityType_example;  // String | Entity type
            var id = 56;  // Integer | ID of the entity
            var subid = 56;  // Integer | ID of the tag

            try
            {
                // Read a tag.
                tag result = apiInstance.readTag(entityType, id, subid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TagsApi.readTag: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiTagsApi();
$entityType = entityType_example; // String | Entity type
$id = 56; // Integer | ID of the entity
$subid = 56; // Integer | ID of the tag

try {
    $result = $api_instance->readTag($entityType, $id, $subid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TagsApi->readTag: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TagsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TagsApi->new();
my $entityType = entityType_example; # String | Entity type
my $id = 56; # Integer | ID of the entity
my $subid = 56; # Integer | ID of the tag

eval { 
    my $result = $api_instance->readTag(entityType => $entityType, id => $id, subid => $subid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TagsApi->readTag: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.TagsApi()
entityType = entityType_example # String | Entity type
id = 56 # Integer | ID of the entity
subid = 56 # Integer | ID of the tag

try: 
    # Read a tag.
    api_response = api_instance.read_tag(entityType, id, subid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagsApi->readTag: %s\n" % e)

Parameters

Path parameters
Name Description
entity_type*
String
Entity type
Required
id*
Integer
ID of the entity
Required
subid*
Integer
ID of the tag
Required

Responses

Status: 200 - A tag.


readTags

Read all tags of that entity.


/{entity_type}/{id}/tags

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/{entity_type}/{id}/tags"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TagsApi;

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

public class TagsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        TagsApi apiInstance = new TagsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        try {
            array[tag] result = apiInstance.readTags(entityType, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#readTags");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TagsApi;

public class TagsApiExample {

    public static void main(String[] args) {
        TagsApi apiInstance = new TagsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        try {
            array[tag] result = apiInstance.readTags(entityType, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#readTags");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *entityType = entityType_example; // Entity type
Integer *id = 56; // ID of the entity

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

// Read all tags of that entity.
[apiInstance readTagsWith:entityType
    id:id
              completionHandler: ^(array[tag] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.TagsApi()
var entityType = entityType_example; // {{String}} Entity type
var id = 56; // {{Integer}} ID of the entity

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readTags(entityType, id, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new TagsApi();
            var entityType = entityType_example;  // String | Entity type
            var id = 56;  // Integer | ID of the entity

            try
            {
                // Read all tags of that entity.
                array[tag] result = apiInstance.readTags(entityType, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TagsApi.readTags: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiTagsApi();
$entityType = entityType_example; // String | Entity type
$id = 56; // Integer | ID of the entity

try {
    $result = $api_instance->readTags($entityType, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TagsApi->readTags: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TagsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TagsApi->new();
my $entityType = entityType_example; # String | Entity type
my $id = 56; # Integer | ID of the entity

eval { 
    my $result = $api_instance->readTags(entityType => $entityType, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TagsApi->readTags: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.TagsApi()
entityType = entityType_example # String | Entity type
id = 56 # Integer | ID of the entity

try: 
    # Read all tags of that entity.
    api_response = api_instance.read_tags(entityType, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagsApi->readTags: %s\n" % e)

Parameters

Path parameters
Name Description
entity_type*
String
Entity type
Required
id*
Integer
ID of the entity
Required

Responses

Status: 200 - A list of tags


TeamTags

deleteTeamTag

Delete a tag.


/team_tags/{id}

Usage and SDK Samples

curl -X DELETE\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/team_tags/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TeamTagsApi;

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

public class TeamTagsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        TeamTagsApi apiInstance = new TeamTagsApi();
        Integer id = 56; // Integer | ID of the tag.
        try {
            apiInstance.deleteTeamTag(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamTagsApi#deleteTeamTag");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TeamTagsApi;

public class TeamTagsApiExample {

    public static void main(String[] args) {
        TeamTagsApi apiInstance = new TeamTagsApi();
        Integer id = 56; // Integer | ID of the tag.
        try {
            apiInstance.deleteTeamTag(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamTagsApi#deleteTeamTag");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the tag.

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

// Delete a tag.
[apiInstance deleteTeamTagWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.TeamTagsApi()
var id = 56; // {{Integer}} ID of the tag.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteTeamTag(id, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new TeamTagsApi();
            var id = 56;  // Integer | ID of the tag.

            try
            {
                // Delete a tag.
                apiInstance.deleteTeamTag(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TeamTagsApi.deleteTeamTag: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiTeamTagsApi();
$id = 56; // Integer | ID of the tag.

try {
    $api_instance->deleteTeamTag($id);
} catch (Exception $e) {
    echo 'Exception when calling TeamTagsApi->deleteTeamTag: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TeamTagsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TeamTagsApi->new();
my $id = 56; # Integer | ID of the tag.

eval { 
    $api_instance->deleteTeamTag(id => $id);
};
if ($@) {
    warn "Exception when calling TeamTagsApi->deleteTeamTag: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.TeamTagsApi()
id = 56 # Integer | ID of the tag.

try: 
    # Delete a tag.
    api_instance.delete_team_tag(id)
except ApiException as e:
    print("Exception when calling TeamTagsApi->deleteTeamTag: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the tag.
Required

Responses

Status: 204 - The tag was removed.


patchTags

Actions on tags.


/team_tags

Usage and SDK Samples

curl -X PATCH\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/team_tags"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TeamTagsApi;

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

public class TeamTagsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        TeamTagsApi apiInstance = new TeamTagsApi();
        Team_tags_body_1 body = ; // Team_tags_body_1 | Parameters for modifying team tags.
        try {
            array[tag] result = apiInstance.patchTags(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamTagsApi#patchTags");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TeamTagsApi;

public class TeamTagsApiExample {

    public static void main(String[] args) {
        TeamTagsApi apiInstance = new TeamTagsApi();
        Team_tags_body_1 body = ; // Team_tags_body_1 | Parameters for modifying team tags.
        try {
            array[tag] result = apiInstance.patchTags(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamTagsApi#patchTags");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Team_tags_body_1 *body = ; // Parameters for modifying team tags. (optional)

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

// Actions on tags.

[apiInstance patchTagsWith:body
              completionHandler: ^(array[tag] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.TeamTagsApi()
var opts = { 
  'body':  // {{Team_tags_body_1}} Parameters for modifying team tags.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchTags(opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new TeamTagsApi();
            var body = new Team_tags_body_1(); // Team_tags_body_1 | Parameters for modifying team tags. (optional) 

            try
            {
                // Actions on tags.

                array[tag] result = apiInstance.patchTags(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TeamTagsApi.patchTags: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiTeamTagsApi();
$body = ; // Team_tags_body_1 | Parameters for modifying team tags.

try {
    $result = $api_instance->patchTags($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamTagsApi->patchTags: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TeamTagsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TeamTagsApi->new();
my $body = WWW::SwaggerClient::Object::Team_tags_body_1->new(); # Team_tags_body_1 | Parameters for modifying team tags.

eval { 
    my $result = $api_instance->patchTags(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TeamTagsApi->patchTags: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.TeamTagsApi()
body =  # Team_tags_body_1 | Parameters for modifying team tags. (optional)

try: 
    # Actions on tags.

    api_response = api_instance.patch_tags(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TeamTagsApi->patchTags: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - The team tag has been modified.


patchTeamTag

Actions on a tag.


/team_tags/{id}

Usage and SDK Samples

curl -X PATCH\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/team_tags/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TeamTagsApi;

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

public class TeamTagsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        TeamTagsApi apiInstance = new TeamTagsApi();
        Integer id = 56; // Integer | ID of the tag.
        Team_tags_id_body body = ; // Team_tags_id_body | Parameters for modifying a tag.
        try {
            tag result = apiInstance.patchTeamTag(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamTagsApi#patchTeamTag");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TeamTagsApi;

public class TeamTagsApiExample {

    public static void main(String[] args) {
        TeamTagsApi apiInstance = new TeamTagsApi();
        Integer id = 56; // Integer | ID of the tag.
        Team_tags_id_body body = ; // Team_tags_id_body | Parameters for modifying a tag.
        try {
            tag result = apiInstance.patchTeamTag(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamTagsApi#patchTeamTag");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the tag.
Team_tags_id_body *body = ; // Parameters for modifying a tag. (optional)

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

// Actions on a tag.

[apiInstance patchTeamTagWith:id
    body:body
              completionHandler: ^(tag output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.TeamTagsApi()
var id = 56; // {{Integer}} ID of the tag.
var opts = { 
  'body':  // {{Team_tags_id_body}} Parameters for modifying a tag.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchTeamTag(id, opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new TeamTagsApi();
            var id = 56;  // Integer | ID of the tag.
            var body = new Team_tags_id_body(); // Team_tags_id_body | Parameters for modifying a tag. (optional) 

            try
            {
                // Actions on a tag.

                tag result = apiInstance.patchTeamTag(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TeamTagsApi.patchTeamTag: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiTeamTagsApi();
$id = 56; // Integer | ID of the tag.
$body = ; // Team_tags_id_body | Parameters for modifying a tag.

try {
    $result = $api_instance->patchTeamTag($id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamTagsApi->patchTeamTag: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TeamTagsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TeamTagsApi->new();
my $id = 56; # Integer | ID of the tag.
my $body = WWW::SwaggerClient::Object::Team_tags_id_body->new(); # Team_tags_id_body | Parameters for modifying a tag.

eval { 
    my $result = $api_instance->patchTeamTag(id => $id, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TeamTagsApi->patchTeamTag: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.TeamTagsApi()
id = 56 # Integer | ID of the tag.
body =  # Team_tags_id_body | Parameters for modifying a tag. (optional)

try: 
    # Actions on a tag.

    api_response = api_instance.patch_team_tag(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TeamTagsApi->patchTeamTag: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the tag.
Required
Body parameters
Name Description
body

Responses

Status: 200 - The team tag has been modified.


postTeamTag

Create a tag in the team.


/team_tags

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/team_tags"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TeamTagsApi;

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

public class TeamTagsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        TeamTagsApi apiInstance = new TeamTagsApi();
        Team_tags_body body = ; // Team_tags_body | Parameters for adding a tag in the team.
        try {
            apiInstance.postTeamTag(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamTagsApi#postTeamTag");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TeamTagsApi;

public class TeamTagsApiExample {

    public static void main(String[] args) {
        TeamTagsApi apiInstance = new TeamTagsApi();
        Team_tags_body body = ; // Team_tags_body | Parameters for adding a tag in the team.
        try {
            apiInstance.postTeamTag(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamTagsApi#postTeamTag");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Team_tags_body *body = ; // Parameters for adding a tag in the team. (optional)

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

// Create a tag in the team.
[apiInstance postTeamTagWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.TeamTagsApi()
var opts = { 
  'body':  // {{Team_tags_body}} Parameters for adding a tag in the team.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.postTeamTag(opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new TeamTagsApi();
            var body = new Team_tags_body(); // Team_tags_body | Parameters for adding a tag in the team. (optional) 

            try
            {
                // Create a tag in the team.
                apiInstance.postTeamTag(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TeamTagsApi.postTeamTag: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiTeamTagsApi();
$body = ; // Team_tags_body | Parameters for adding a tag in the team.

try {
    $api_instance->postTeamTag($body);
} catch (Exception $e) {
    echo 'Exception when calling TeamTagsApi->postTeamTag: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TeamTagsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TeamTagsApi->new();
my $body = WWW::SwaggerClient::Object::Team_tags_body->new(); # Team_tags_body | Parameters for adding a tag in the team.

eval { 
    $api_instance->postTeamTag(body => $body);
};
if ($@) {
    warn "Exception when calling TeamTagsApi->postTeamTag: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.TeamTagsApi()
body =  # Team_tags_body | Parameters for adding a tag in the team. (optional)

try: 
    # Create a tag in the team.
    api_instance.post_team_tag(body=body)
except ApiException as e:
    print("Exception when calling TeamTagsApi->postTeamTag: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 201 - The tag has been added.

Name Type Format Description
location String

readTeamTag

Read a tag.


/team_tags/{id}

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/team_tags/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TeamTagsApi;

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

public class TeamTagsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        TeamTagsApi apiInstance = new TeamTagsApi();
        Integer id = 56; // Integer | ID of the tag.
        try {
            inline_response_200_3 result = apiInstance.readTeamTag(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamTagsApi#readTeamTag");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TeamTagsApi;

public class TeamTagsApiExample {

    public static void main(String[] args) {
        TeamTagsApi apiInstance = new TeamTagsApi();
        Integer id = 56; // Integer | ID of the tag.
        try {
            inline_response_200_3 result = apiInstance.readTeamTag(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamTagsApi#readTeamTag");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the tag.

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

// Read a tag.
[apiInstance readTeamTagWith:id
              completionHandler: ^(inline_response_200_3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.TeamTagsApi()
var id = 56; // {{Integer}} ID of the tag.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readTeamTag(id, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new TeamTagsApi();
            var id = 56;  // Integer | ID of the tag.

            try
            {
                // Read a tag.
                inline_response_200_3 result = apiInstance.readTeamTag(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TeamTagsApi.readTeamTag: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiTeamTagsApi();
$id = 56; // Integer | ID of the tag.

try {
    $result = $api_instance->readTeamTag($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamTagsApi->readTeamTag: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TeamTagsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TeamTagsApi->new();
my $id = 56; # Integer | ID of the tag.

eval { 
    my $result = $api_instance->readTeamTag(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TeamTagsApi->readTeamTag: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.TeamTagsApi()
id = 56 # Integer | ID of the tag.

try: 
    # Read a tag.
    api_response = api_instance.read_team_tag(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TeamTagsApi->readTeamTag: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the tag.
Required

Responses

Status: 200 - A tag.


readTeamTags

Read all tags for the team.


/team_tags

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/team_tags"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TeamTagsApi;

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

public class TeamTagsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        TeamTagsApi apiInstance = new TeamTagsApi();
        try {
            inline_response_200_2 result = apiInstance.readTeamTags();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamTagsApi#readTeamTags");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TeamTagsApi;

public class TeamTagsApiExample {

    public static void main(String[] args) {
        TeamTagsApi apiInstance = new TeamTagsApi();
        try {
            inline_response_200_2 result = apiInstance.readTeamTags();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamTagsApi#readTeamTags");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

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

// Read all tags for the team.
[apiInstance readTeamTagsWithCompletionHandler: 
              ^(inline_response_200_2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.TeamTagsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readTeamTags(callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new TeamTagsApi();

            try
            {
                // Read all tags for the team.
                inline_response_200_2 result = apiInstance.readTeamTags();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TeamTagsApi.readTeamTags: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiTeamTagsApi();

try {
    $result = $api_instance->readTeamTags();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamTagsApi->readTeamTags: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TeamTagsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TeamTagsApi->new();

eval { 
    my $result = $api_instance->readTeamTags();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TeamTagsApi->readTeamTags: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.TeamTagsApi()

try: 
    # Read all tags for the team.
    api_response = api_instance.read_team_tags()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TeamTagsApi->readTeamTags: %s\n" % e)

Parameters

Responses

Status: 200 - A list of tags.


Teamgroups

deleteTeamgroup

Delete a teamgroup.


/teams/{id}/teamgroups/{subid}

Usage and SDK Samples

curl -X DELETE\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/teams/{id}/teamgroups/{subid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TeamgroupsApi;

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

public class TeamgroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        TeamgroupsApi apiInstance = new TeamgroupsApi();
        Integer id = 56; // Integer | ID of the team.
        Integer subid = 56; // Integer | ID of the teamgroup.
        try {
            apiInstance.deleteTeamgroup(id, subid);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamgroupsApi#deleteTeamgroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TeamgroupsApi;

public class TeamgroupsApiExample {

    public static void main(String[] args) {
        TeamgroupsApi apiInstance = new TeamgroupsApi();
        Integer id = 56; // Integer | ID of the team.
        Integer subid = 56; // Integer | ID of the teamgroup.
        try {
            apiInstance.deleteTeamgroup(id, subid);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamgroupsApi#deleteTeamgroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the team.
Integer *subid = 56; // ID of the teamgroup.

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

// Delete a teamgroup.
[apiInstance deleteTeamgroupWith:id
    subid:subid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.TeamgroupsApi()
var id = 56; // {{Integer}} ID of the team.
var subid = 56; // {{Integer}} ID of the teamgroup.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteTeamgroup(id, subid, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new TeamgroupsApi();
            var id = 56;  // Integer | ID of the team.
            var subid = 56;  // Integer | ID of the teamgroup.

            try
            {
                // Delete a teamgroup.
                apiInstance.deleteTeamgroup(id, subid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TeamgroupsApi.deleteTeamgroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiTeamgroupsApi();
$id = 56; // Integer | ID of the team.
$subid = 56; // Integer | ID of the teamgroup.

try {
    $api_instance->deleteTeamgroup($id, $subid);
} catch (Exception $e) {
    echo 'Exception when calling TeamgroupsApi->deleteTeamgroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TeamgroupsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TeamgroupsApi->new();
my $id = 56; # Integer | ID of the team.
my $subid = 56; # Integer | ID of the teamgroup.

eval { 
    $api_instance->deleteTeamgroup(id => $id, subid => $subid);
};
if ($@) {
    warn "Exception when calling TeamgroupsApi->deleteTeamgroup: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.TeamgroupsApi()
id = 56 # Integer | ID of the team.
subid = 56 # Integer | ID of the teamgroup.

try: 
    # Delete a teamgroup.
    api_instance.delete_teamgroup(id, subid)
except ApiException as e:
    print("Exception when calling TeamgroupsApi->deleteTeamgroup: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the team.
Required
subid*
Integer
ID of the teamgroup.
Required

Responses

Status: 204 - The teamgroup was removed.


patchTeamgroup

Modify a teamgroup.


/teams/{id}/teamgroups/{subid}

Usage and SDK Samples

curl -X PATCH\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/teams/{id}/teamgroups/{subid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TeamgroupsApi;

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

public class TeamgroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        TeamgroupsApi apiInstance = new TeamgroupsApi();
        Integer id = 56; // Integer | ID of the team.
        Integer subid = 56; // Integer | ID of the teamgroup.
        Teamgroups_subid_body body = ; // Teamgroups_subid_body | Parameters for modifying a teamgroup.
        try {
            teamgroup result = apiInstance.patchTeamgroup(id, subid, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamgroupsApi#patchTeamgroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TeamgroupsApi;

public class TeamgroupsApiExample {

    public static void main(String[] args) {
        TeamgroupsApi apiInstance = new TeamgroupsApi();
        Integer id = 56; // Integer | ID of the team.
        Integer subid = 56; // Integer | ID of the teamgroup.
        Teamgroups_subid_body body = ; // Teamgroups_subid_body | Parameters for modifying a teamgroup.
        try {
            teamgroup result = apiInstance.patchTeamgroup(id, subid, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamgroupsApi#patchTeamgroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the team.
Integer *subid = 56; // ID of the teamgroup.
Teamgroups_subid_body *body = ; // Parameters for modifying a teamgroup. (optional)

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

// Modify a teamgroup.
[apiInstance patchTeamgroupWith:id
    subid:subid
    body:body
              completionHandler: ^(teamgroup output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.TeamgroupsApi()
var id = 56; // {{Integer}} ID of the team.
var subid = 56; // {{Integer}} ID of the teamgroup.
var opts = { 
  'body':  // {{Teamgroups_subid_body}} Parameters for modifying a teamgroup.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchTeamgroup(idsubid, opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new TeamgroupsApi();
            var id = 56;  // Integer | ID of the team.
            var subid = 56;  // Integer | ID of the teamgroup.
            var body = new Teamgroups_subid_body(); // Teamgroups_subid_body | Parameters for modifying a teamgroup. (optional) 

            try
            {
                // Modify a teamgroup.
                teamgroup result = apiInstance.patchTeamgroup(id, subid, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TeamgroupsApi.patchTeamgroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiTeamgroupsApi();
$id = 56; // Integer | ID of the team.
$subid = 56; // Integer | ID of the teamgroup.
$body = ; // Teamgroups_subid_body | Parameters for modifying a teamgroup.

try {
    $result = $api_instance->patchTeamgroup($id, $subid, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamgroupsApi->patchTeamgroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TeamgroupsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TeamgroupsApi->new();
my $id = 56; # Integer | ID of the team.
my $subid = 56; # Integer | ID of the teamgroup.
my $body = WWW::SwaggerClient::Object::Teamgroups_subid_body->new(); # Teamgroups_subid_body | Parameters for modifying a teamgroup.

eval { 
    my $result = $api_instance->patchTeamgroup(id => $id, subid => $subid, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TeamgroupsApi->patchTeamgroup: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.TeamgroupsApi()
id = 56 # Integer | ID of the team.
subid = 56 # Integer | ID of the teamgroup.
body =  # Teamgroups_subid_body | Parameters for modifying a teamgroup. (optional)

try: 
    # Modify a teamgroup.
    api_response = api_instance.patch_teamgroup(id, subid, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TeamgroupsApi->patchTeamgroup: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the team.
Required
subid*
Integer
ID of the teamgroup.
Required
Body parameters
Name Description
body

Responses

Status: 200 - The updated teamgroup.


postTeamgroups

Create a new teamgroup.


/teams/{id}/teamgroups

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/teams/{id}/teamgroups"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TeamgroupsApi;

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

public class TeamgroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        TeamgroupsApi apiInstance = new TeamgroupsApi();
        Integer id = 56; // Integer | ID of the team.
        Id_teamgroups_body body = ; // Id_teamgroups_body | Parameters for creating a teamgroup.
        try {
            apiInstance.postTeamgroups(id, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamgroupsApi#postTeamgroups");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TeamgroupsApi;

public class TeamgroupsApiExample {

    public static void main(String[] args) {
        TeamgroupsApi apiInstance = new TeamgroupsApi();
        Integer id = 56; // Integer | ID of the team.
        Id_teamgroups_body body = ; // Id_teamgroups_body | Parameters for creating a teamgroup.
        try {
            apiInstance.postTeamgroups(id, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamgroupsApi#postTeamgroups");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the team.
Id_teamgroups_body *body = ; // Parameters for creating a teamgroup. (optional)

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

// Create a new teamgroup.
[apiInstance postTeamgroupsWith:id
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.TeamgroupsApi()
var id = 56; // {{Integer}} ID of the team.
var opts = { 
  'body':  // {{Id_teamgroups_body}} Parameters for creating a teamgroup.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.postTeamgroups(id, opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new TeamgroupsApi();
            var id = 56;  // Integer | ID of the team.
            var body = new Id_teamgroups_body(); // Id_teamgroups_body | Parameters for creating a teamgroup. (optional) 

            try
            {
                // Create a new teamgroup.
                apiInstance.postTeamgroups(id, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TeamgroupsApi.postTeamgroups: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiTeamgroupsApi();
$id = 56; // Integer | ID of the team.
$body = ; // Id_teamgroups_body | Parameters for creating a teamgroup.

try {
    $api_instance->postTeamgroups($id, $body);
} catch (Exception $e) {
    echo 'Exception when calling TeamgroupsApi->postTeamgroups: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TeamgroupsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TeamgroupsApi->new();
my $id = 56; # Integer | ID of the team.
my $body = WWW::SwaggerClient::Object::Id_teamgroups_body->new(); # Id_teamgroups_body | Parameters for creating a teamgroup.

eval { 
    $api_instance->postTeamgroups(id => $id, body => $body);
};
if ($@) {
    warn "Exception when calling TeamgroupsApi->postTeamgroups: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.TeamgroupsApi()
id = 56 # Integer | ID of the team.
body =  # Id_teamgroups_body | Parameters for creating a teamgroup. (optional)

try: 
    # Create a new teamgroup.
    api_instance.post_teamgroups(id, body=body)
except ApiException as e:
    print("Exception when calling TeamgroupsApi->postTeamgroups: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the team.
Required
Body parameters
Name Description
body

Responses

Status: 201 - New teamgroup.

Name Type Format Description
location String

readTeamTeamgroups

Read teamgroups of a team.


/teams/{id}/teamgroups

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/teams/{id}/teamgroups"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TeamgroupsApi;

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

public class TeamgroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        TeamgroupsApi apiInstance = new TeamgroupsApi();
        Integer id = 56; // Integer | ID of the team.
        try {
            array[teamgroup] result = apiInstance.readTeamTeamgroups(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamgroupsApi#readTeamTeamgroups");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TeamgroupsApi;

public class TeamgroupsApiExample {

    public static void main(String[] args) {
        TeamgroupsApi apiInstance = new TeamgroupsApi();
        Integer id = 56; // Integer | ID of the team.
        try {
            array[teamgroup] result = apiInstance.readTeamTeamgroups(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamgroupsApi#readTeamTeamgroups");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the team.

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

// Read teamgroups of a team.
[apiInstance readTeamTeamgroupsWith:id
              completionHandler: ^(array[teamgroup] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.TeamgroupsApi()
var id = 56; // {{Integer}} ID of the team.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readTeamTeamgroups(id, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new TeamgroupsApi();
            var id = 56;  // Integer | ID of the team.

            try
            {
                // Read teamgroups of a team.
                array[teamgroup] result = apiInstance.readTeamTeamgroups(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TeamgroupsApi.readTeamTeamgroups: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiTeamgroupsApi();
$id = 56; // Integer | ID of the team.

try {
    $result = $api_instance->readTeamTeamgroups($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamgroupsApi->readTeamTeamgroups: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TeamgroupsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TeamgroupsApi->new();
my $id = 56; # Integer | ID of the team.

eval { 
    my $result = $api_instance->readTeamTeamgroups(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TeamgroupsApi->readTeamTeamgroups: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.TeamgroupsApi()
id = 56 # Integer | ID of the team.

try: 
    # Read teamgroups of a team.
    api_response = api_instance.read_team_teamgroups(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TeamgroupsApi->readTeamTeamgroups: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the team.
Required

Responses

Status: 200 - A list of teamgroups for the team.


readTeamgroup

Read a teamgroup.


/teams/{id}/teamgroups/{subid}

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/teams/{id}/teamgroups/{subid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TeamgroupsApi;

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

public class TeamgroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        TeamgroupsApi apiInstance = new TeamgroupsApi();
        Integer id = 56; // Integer | ID of the team.
        Integer subid = 56; // Integer | ID of the teamgroup.
        try {
            inline_response_200_4 result = apiInstance.readTeamgroup(id, subid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamgroupsApi#readTeamgroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TeamgroupsApi;

public class TeamgroupsApiExample {

    public static void main(String[] args) {
        TeamgroupsApi apiInstance = new TeamgroupsApi();
        Integer id = 56; // Integer | ID of the team.
        Integer subid = 56; // Integer | ID of the teamgroup.
        try {
            inline_response_200_4 result = apiInstance.readTeamgroup(id, subid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamgroupsApi#readTeamgroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the team.
Integer *subid = 56; // ID of the teamgroup.

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

// Read a teamgroup.
[apiInstance readTeamgroupWith:id
    subid:subid
              completionHandler: ^(inline_response_200_4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.TeamgroupsApi()
var id = 56; // {{Integer}} ID of the team.
var subid = 56; // {{Integer}} ID of the teamgroup.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readTeamgroup(id, subid, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new TeamgroupsApi();
            var id = 56;  // Integer | ID of the team.
            var subid = 56;  // Integer | ID of the teamgroup.

            try
            {
                // Read a teamgroup.
                inline_response_200_4 result = apiInstance.readTeamgroup(id, subid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TeamgroupsApi.readTeamgroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiTeamgroupsApi();
$id = 56; // Integer | ID of the team.
$subid = 56; // Integer | ID of the teamgroup.

try {
    $result = $api_instance->readTeamgroup($id, $subid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamgroupsApi->readTeamgroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TeamgroupsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TeamgroupsApi->new();
my $id = 56; # Integer | ID of the team.
my $subid = 56; # Integer | ID of the teamgroup.

eval { 
    my $result = $api_instance->readTeamgroup(id => $id, subid => $subid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TeamgroupsApi->readTeamgroup: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.TeamgroupsApi()
id = 56 # Integer | ID of the team.
subid = 56 # Integer | ID of the teamgroup.

try: 
    # Read a teamgroup.
    api_response = api_instance.read_teamgroup(id, subid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TeamgroupsApi->readTeamgroup: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the team.
Required
subid*
Integer
ID of the teamgroup.
Required

Responses

Status: 200 - A teamgroup.


Teams

patchTeam

Actions on a team.


/teams/{id}

Usage and SDK Samples

curl -X PATCH\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/teams/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TeamsApi;

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

public class TeamsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        TeamsApi apiInstance = new TeamsApi();
        id id = ; // id | ID of the team or `current`.
        Team body = ; // Team | Parameters for modifying a team.
        try {
            team result = apiInstance.patchTeam(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamsApi#patchTeam");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TeamsApi;

public class TeamsApiExample {

    public static void main(String[] args) {
        TeamsApi apiInstance = new TeamsApi();
        id id = ; // id | ID of the team or `current`.
        Team body = ; // Team | Parameters for modifying a team.
        try {
            team result = apiInstance.patchTeam(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamsApi#patchTeam");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
id *id = ; // ID of the team or `current`.
Team *body = ; // Parameters for modifying a team. (optional)

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

// Actions on a team.

[apiInstance patchTeamWith:id
    body:body
              completionHandler: ^(team output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.TeamsApi()
var id = ; // {{id}} ID of the team or `current`.
var opts = { 
  'body':  // {{Team}} Parameters for modifying a team.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchTeam(id, opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new TeamsApi();
            var id = new id(); // id | ID of the team or `current`.
            var body = new Team(); // Team | Parameters for modifying a team. (optional) 

            try
            {
                // Actions on a team.

                team result = apiInstance.patchTeam(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TeamsApi.patchTeam: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiTeamsApi();
$id = ; // id | ID of the team or `current`.
$body = ; // Team | Parameters for modifying a team.

try {
    $result = $api_instance->patchTeam($id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamsApi->patchTeam: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TeamsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TeamsApi->new();
my $id = ; # id | ID of the team or `current`.
my $body = WWW::SwaggerClient::Object::Team->new(); # Team | Parameters for modifying a team.

eval { 
    my $result = $api_instance->patchTeam(id => $id, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TeamsApi->patchTeam: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.TeamsApi()
id =  # id | ID of the team or `current`.
body =  # Team | Parameters for modifying a team. (optional)

try: 
    # Actions on a team.

    api_response = api_instance.patch_team(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TeamsApi->patchTeam: %s\n" % e)

Parameters

Path parameters
Name Description
id*
id
ID of the team or `current`.
Required
Body parameters
Name Description
body

Responses

Status: 200 - The updated team.


postTeams

Create a new team.


/teams

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/teams"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TeamsApi;

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

public class TeamsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        TeamsApi apiInstance = new TeamsApi();
        Teams_body body = ; // Teams_body | Parameters for creating a new team.
        try {
            apiInstance.postTeams(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamsApi#postTeams");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TeamsApi;

public class TeamsApiExample {

    public static void main(String[] args) {
        TeamsApi apiInstance = new TeamsApi();
        Teams_body body = ; // Teams_body | Parameters for creating a new team.
        try {
            apiInstance.postTeams(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamsApi#postTeams");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Teams_body *body = ; // Parameters for creating a new team. (optional)

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

// Create a new team.
[apiInstance postTeamsWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.TeamsApi()
var opts = { 
  'body':  // {{Teams_body}} Parameters for creating a new team.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.postTeams(opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new TeamsApi();
            var body = new Teams_body(); // Teams_body | Parameters for creating a new team. (optional) 

            try
            {
                // Create a new team.
                apiInstance.postTeams(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TeamsApi.postTeams: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiTeamsApi();
$body = ; // Teams_body | Parameters for creating a new team.

try {
    $api_instance->postTeams($body);
} catch (Exception $e) {
    echo 'Exception when calling TeamsApi->postTeams: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TeamsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TeamsApi->new();
my $body = WWW::SwaggerClient::Object::Teams_body->new(); # Teams_body | Parameters for creating a new team.

eval { 
    $api_instance->postTeams(body => $body);
};
if ($@) {
    warn "Exception when calling TeamsApi->postTeams: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.TeamsApi()
body =  # Teams_body | Parameters for creating a new team. (optional)

try: 
    # Create a new team.
    api_instance.post_teams(body=body)
except ApiException as e:
    print("Exception when calling TeamsApi->postTeams: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 201 - The team has been created.

Name Type Format Description
location String

readTeam

Read a team. Requires Admin permissions.


/teams/{id}

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/teams/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TeamsApi;

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

public class TeamsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        TeamsApi apiInstance = new TeamsApi();
        id id = ; // id | ID of the team or `current`.
        try {
            team result = apiInstance.readTeam(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamsApi#readTeam");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TeamsApi;

public class TeamsApiExample {

    public static void main(String[] args) {
        TeamsApi apiInstance = new TeamsApi();
        id id = ; // id | ID of the team or `current`.
        try {
            team result = apiInstance.readTeam(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamsApi#readTeam");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
id *id = ; // ID of the team or `current`.

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

// Read a team. Requires Admin permissions.
[apiInstance readTeamWith:id
              completionHandler: ^(team output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.TeamsApi()
var id = ; // {{id}} ID of the team or `current`.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readTeam(id, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new TeamsApi();
            var id = new id(); // id | ID of the team or `current`.

            try
            {
                // Read a team. Requires Admin permissions.
                team result = apiInstance.readTeam(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TeamsApi.readTeam: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiTeamsApi();
$id = ; // id | ID of the team or `current`.

try {
    $result = $api_instance->readTeam($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamsApi->readTeam: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TeamsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TeamsApi->new();
my $id = ; # id | ID of the team or `current`.

eval { 
    my $result = $api_instance->readTeam(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TeamsApi->readTeam: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.TeamsApi()
id =  # id | ID of the team or `current`.

try: 
    # Read a team. Requires Admin permissions.
    api_response = api_instance.read_team(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TeamsApi->readTeam: %s\n" % e)

Parameters

Path parameters
Name Description
id*
id
ID of the team or `current`.
Required

Responses

Status: 200 - A team.


readTeams

Read all teams. Requires Sysadmin permissions.


/teams

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/teams"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TeamsApi;

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

public class TeamsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        TeamsApi apiInstance = new TeamsApi();
        try {
            array[team] result = apiInstance.readTeams();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamsApi#readTeams");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TeamsApi;

public class TeamsApiExample {

    public static void main(String[] args) {
        TeamsApi apiInstance = new TeamsApi();
        try {
            array[team] result = apiInstance.readTeams();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamsApi#readTeams");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

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

// Read all teams. Requires Sysadmin permissions.
[apiInstance readTeamsWithCompletionHandler: 
              ^(array[team] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.TeamsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readTeams(callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new TeamsApi();

            try
            {
                // Read all teams. Requires Sysadmin permissions.
                array[team] result = apiInstance.readTeams();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TeamsApi.readTeams: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiTeamsApi();

try {
    $result = $api_instance->readTeams();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamsApi->readTeams: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TeamsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TeamsApi->new();

eval { 
    my $result = $api_instance->readTeams();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TeamsApi->readTeams: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.TeamsApi()

try: 
    # Read all teams. Requires Sysadmin permissions.
    api_response = api_instance.read_teams()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TeamsApi->readTeams: %s\n" % e)

Parameters

Responses

Status: 200 - A list of teams.


Todolist

deleteTodoitem

Delete a todoitem.


/todolist/{id}

Usage and SDK Samples

curl -X DELETE\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/todolist/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TodolistApi;

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

public class TodolistApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        TodolistApi apiInstance = new TodolistApi();
        Integer id = 56; // Integer | ID of the todoitem.
        try {
            apiInstance.deleteTodoitem(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling TodolistApi#deleteTodoitem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TodolistApi;

public class TodolistApiExample {

    public static void main(String[] args) {
        TodolistApi apiInstance = new TodolistApi();
        Integer id = 56; // Integer | ID of the todoitem.
        try {
            apiInstance.deleteTodoitem(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling TodolistApi#deleteTodoitem");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the todoitem.

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

// Delete a todoitem.
[apiInstance deleteTodoitemWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.TodolistApi()
var id = 56; // {{Integer}} ID of the todoitem.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteTodoitem(id, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new TodolistApi();
            var id = 56;  // Integer | ID of the todoitem.

            try
            {
                // Delete a todoitem.
                apiInstance.deleteTodoitem(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TodolistApi.deleteTodoitem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiTodolistApi();
$id = 56; // Integer | ID of the todoitem.

try {
    $api_instance->deleteTodoitem($id);
} catch (Exception $e) {
    echo 'Exception when calling TodolistApi->deleteTodoitem: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TodolistApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TodolistApi->new();
my $id = 56; # Integer | ID of the todoitem.

eval { 
    $api_instance->deleteTodoitem(id => $id);
};
if ($@) {
    warn "Exception when calling TodolistApi->deleteTodoitem: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.TodolistApi()
id = 56 # Integer | ID of the todoitem.

try: 
    # Delete a todoitem.
    api_instance.delete_todoitem(id)
except ApiException as e:
    print("Exception when calling TodolistApi->deleteTodoitem: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the todoitem.
Required

Responses

Status: 204 - The todoitem was removed.


patchTodoitem

Actions on a todoitem.


/todolist/{id}

Usage and SDK Samples

curl -X PATCH\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/todolist/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TodolistApi;

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

public class TodolistApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        TodolistApi apiInstance = new TodolistApi();
        Integer id = 56; // Integer | ID of the todoitem.
        Todolist_id_body body = ; // Todolist_id_body | Parameters for modifying a todoitem.
        try {
            todoitem result = apiInstance.patchTodoitem(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TodolistApi#patchTodoitem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TodolistApi;

public class TodolistApiExample {

    public static void main(String[] args) {
        TodolistApi apiInstance = new TodolistApi();
        Integer id = 56; // Integer | ID of the todoitem.
        Todolist_id_body body = ; // Todolist_id_body | Parameters for modifying a todoitem.
        try {
            todoitem result = apiInstance.patchTodoitem(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TodolistApi#patchTodoitem");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the todoitem.
Todolist_id_body *body = ; // Parameters for modifying a todoitem. (optional)

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

// Actions on a todoitem.

[apiInstance patchTodoitemWith:id
    body:body
              completionHandler: ^(todoitem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.TodolistApi()
var id = 56; // {{Integer}} ID of the todoitem.
var opts = { 
  'body':  // {{Todolist_id_body}} Parameters for modifying a todoitem.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchTodoitem(id, opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new TodolistApi();
            var id = 56;  // Integer | ID of the todoitem.
            var body = new Todolist_id_body(); // Todolist_id_body | Parameters for modifying a todoitem. (optional) 

            try
            {
                // Actions on a todoitem.

                todoitem result = apiInstance.patchTodoitem(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TodolistApi.patchTodoitem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiTodolistApi();
$id = 56; // Integer | ID of the todoitem.
$body = ; // Todolist_id_body | Parameters for modifying a todoitem.

try {
    $result = $api_instance->patchTodoitem($id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TodolistApi->patchTodoitem: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TodolistApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TodolistApi->new();
my $id = 56; # Integer | ID of the todoitem.
my $body = WWW::SwaggerClient::Object::Todolist_id_body->new(); # Todolist_id_body | Parameters for modifying a todoitem.

eval { 
    my $result = $api_instance->patchTodoitem(id => $id, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TodolistApi->patchTodoitem: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.TodolistApi()
id = 56 # Integer | ID of the todoitem.
body =  # Todolist_id_body | Parameters for modifying a todoitem. (optional)

try: 
    # Actions on a todoitem.

    api_response = api_instance.patch_todoitem(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TodolistApi->patchTodoitem: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the todoitem.
Required
Body parameters
Name Description
body

Responses

Status: 200 - The updated todoitem.


postTodolist

Create a todo item


/todolist

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/todolist"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TodolistApi;

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

public class TodolistApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        TodolistApi apiInstance = new TodolistApi();
        Todolist_body body = ; // Todolist_body | Parameters for creating a todoitem.
        try {
            apiInstance.postTodolist(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling TodolistApi#postTodolist");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TodolistApi;

public class TodolistApiExample {

    public static void main(String[] args) {
        TodolistApi apiInstance = new TodolistApi();
        Todolist_body body = ; // Todolist_body | Parameters for creating a todoitem.
        try {
            apiInstance.postTodolist(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling TodolistApi#postTodolist");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Todolist_body *body = ; // Parameters for creating a todoitem. (optional)

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

// Create a todo item
[apiInstance postTodolistWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.TodolistApi()
var opts = { 
  'body':  // {{Todolist_body}} Parameters for creating a todoitem.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.postTodolist(opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new TodolistApi();
            var body = new Todolist_body(); // Todolist_body | Parameters for creating a todoitem. (optional) 

            try
            {
                // Create a todo item
                apiInstance.postTodolist(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TodolistApi.postTodolist: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiTodolistApi();
$body = ; // Todolist_body | Parameters for creating a todoitem.

try {
    $api_instance->postTodolist($body);
} catch (Exception $e) {
    echo 'Exception when calling TodolistApi->postTodolist: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TodolistApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TodolistApi->new();
my $body = WWW::SwaggerClient::Object::Todolist_body->new(); # Todolist_body | Parameters for creating a todoitem.

eval { 
    $api_instance->postTodolist(body => $body);
};
if ($@) {
    warn "Exception when calling TodolistApi->postTodolist: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.TodolistApi()
body =  # Todolist_body | Parameters for creating a todoitem. (optional)

try: 
    # Create a todo item
    api_instance.post_todolist(body=body)
except ApiException as e:
    print("Exception when calling TodolistApi->postTodolist: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 201 - The todo entry has been created.

Name Type Format Description
location String

readTodoitem

Read a todo entry.


/todolist/{id}

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/todolist/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TodolistApi;

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

public class TodolistApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        TodolistApi apiInstance = new TodolistApi();
        Integer id = 56; // Integer | ID of the todoitem.
        try {
            todoitem result = apiInstance.readTodoitem(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TodolistApi#readTodoitem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TodolistApi;

public class TodolistApiExample {

    public static void main(String[] args) {
        TodolistApi apiInstance = new TodolistApi();
        Integer id = 56; // Integer | ID of the todoitem.
        try {
            todoitem result = apiInstance.readTodoitem(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TodolistApi#readTodoitem");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // ID of the todoitem.

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

// Read a todo entry.
[apiInstance readTodoitemWith:id
              completionHandler: ^(todoitem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.TodolistApi()
var id = 56; // {{Integer}} ID of the todoitem.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readTodoitem(id, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new TodolistApi();
            var id = 56;  // Integer | ID of the todoitem.

            try
            {
                // Read a todo entry.
                todoitem result = apiInstance.readTodoitem(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TodolistApi.readTodoitem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiTodolistApi();
$id = 56; // Integer | ID of the todoitem.

try {
    $result = $api_instance->readTodoitem($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TodolistApi->readTodoitem: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TodolistApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TodolistApi->new();
my $id = 56; # Integer | ID of the todoitem.

eval { 
    my $result = $api_instance->readTodoitem(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TodolistApi->readTodoitem: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.TodolistApi()
id = 56 # Integer | ID of the todoitem.

try: 
    # Read a todo entry.
    api_response = api_instance.read_todoitem(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TodolistApi->readTodoitem: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
ID of the todoitem.
Required

Responses

Status: 200 - A todoitem.


readTodolist

Read all todoitems.


/todolist

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/todolist"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TodolistApi;

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

public class TodolistApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        TodolistApi apiInstance = new TodolistApi();
        try {
            array[todoitem] result = apiInstance.readTodolist();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TodolistApi#readTodolist");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TodolistApi;

public class TodolistApiExample {

    public static void main(String[] args) {
        TodolistApi apiInstance = new TodolistApi();
        try {
            array[todoitem] result = apiInstance.readTodolist();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TodolistApi#readTodolist");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

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

// Read all todoitems.
[apiInstance readTodolistWithCompletionHandler: 
              ^(array[todoitem] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.TodolistApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readTodolist(callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new TodolistApi();

            try
            {
                // Read all todoitems.
                array[todoitem] result = apiInstance.readTodolist();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TodolistApi.readTodolist: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiTodolistApi();

try {
    $result = $api_instance->readTodolist();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TodolistApi->readTodolist: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TodolistApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TodolistApi->new();

eval { 
    my $result = $api_instance->readTodolist();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TodolistApi->readTodolist: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.TodolistApi()

try: 
    # Read all todoitems.
    api_response = api_instance.read_todolist()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TodolistApi->readTodolist: %s\n" % e)

Parameters

Responses

Status: 200 - A list of things to do.


UnfinishedSteps

readUnfinishedSteps

Read all unfinished steps.


/unfinished_steps

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/unfinished_steps?scope="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UnfinishedStepsApi;

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

public class UnfinishedStepsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        UnfinishedStepsApi apiInstance = new UnfinishedStepsApi();
        String scope = scope_example; // String | Set to "team" to extend the list to other members.

        try {
            array[unfinished_steps] result = apiInstance.readUnfinishedSteps(scope);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnfinishedStepsApi#readUnfinishedSteps");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UnfinishedStepsApi;

public class UnfinishedStepsApiExample {

    public static void main(String[] args) {
        UnfinishedStepsApi apiInstance = new UnfinishedStepsApi();
        String scope = scope_example; // String | Set to "team" to extend the list to other members.

        try {
            array[unfinished_steps] result = apiInstance.readUnfinishedSteps(scope);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnfinishedStepsApi#readUnfinishedSteps");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *scope = scope_example; // Set to "team" to extend the list to other members.
 (optional) (default to user)

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

// Read all unfinished steps.
[apiInstance readUnfinishedStepsWith:scope
              completionHandler: ^(array[unfinished_steps] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.UnfinishedStepsApi()
var opts = { 
  'scope': scope_example // {{String}} Set to "team" to extend the list to other members.

};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readUnfinishedSteps(opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new UnfinishedStepsApi();
            var scope = scope_example;  // String | Set to "team" to extend the list to other members.
 (optional)  (default to user)

            try
            {
                // Read all unfinished steps.
                array[unfinished_steps] result = apiInstance.readUnfinishedSteps(scope);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UnfinishedStepsApi.readUnfinishedSteps: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiUnfinishedStepsApi();
$scope = scope_example; // String | Set to "team" to extend the list to other members.


try {
    $result = $api_instance->readUnfinishedSteps($scope);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UnfinishedStepsApi->readUnfinishedSteps: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UnfinishedStepsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UnfinishedStepsApi->new();
my $scope = scope_example; # String | Set to "team" to extend the list to other members.


eval { 
    my $result = $api_instance->readUnfinishedSteps(scope => $scope);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UnfinishedStepsApi->readUnfinishedSteps: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.UnfinishedStepsApi()
scope = scope_example # String | Set to "team" to extend the list to other members.
 (optional) (default to user)

try: 
    # Read all unfinished steps.
    api_response = api_instance.read_unfinished_steps(scope=scope)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UnfinishedStepsApi->readUnfinishedSteps: %s\n" % e)

Parameters

Query parameters
Name Description
scope
String
Set to "team" to extend the list to other members.

Responses

Status: 200 - A list of unfinished steps


Uploads

deleteUpload

Delete an upload.

The upload gets deleted.


/{entity_type}/{id}/uploads/{subid}

Usage and SDK Samples

curl -X DELETE\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/{entity_type}/{id}/uploads/{subid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UploadsApi;

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

public class UploadsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        UploadsApi apiInstance = new UploadsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        Integer subid = 56; // Integer | ID of the upload
        try {
            apiInstance.deleteUpload(entityType, id, subid);
        } catch (ApiException e) {
            System.err.println("Exception when calling UploadsApi#deleteUpload");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UploadsApi;

public class UploadsApiExample {

    public static void main(String[] args) {
        UploadsApi apiInstance = new UploadsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        Integer subid = 56; // Integer | ID of the upload
        try {
            apiInstance.deleteUpload(entityType, id, subid);
        } catch (ApiException e) {
            System.err.println("Exception when calling UploadsApi#deleteUpload");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *entityType = entityType_example; // Entity type
Integer *id = 56; // ID of the entity
Integer *subid = 56; // ID of the upload

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

// Delete an upload.
[apiInstance deleteUploadWith:entityType
    id:id
    subid:subid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.UploadsApi()
var entityType = entityType_example; // {{String}} Entity type
var id = 56; // {{Integer}} ID of the entity
var subid = 56; // {{Integer}} ID of the upload

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteUpload(entityType, id, subid, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new UploadsApi();
            var entityType = entityType_example;  // String | Entity type
            var id = 56;  // Integer | ID of the entity
            var subid = 56;  // Integer | ID of the upload

            try
            {
                // Delete an upload.
                apiInstance.deleteUpload(entityType, id, subid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UploadsApi.deleteUpload: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiUploadsApi();
$entityType = entityType_example; // String | Entity type
$id = 56; // Integer | ID of the entity
$subid = 56; // Integer | ID of the upload

try {
    $api_instance->deleteUpload($entityType, $id, $subid);
} catch (Exception $e) {
    echo 'Exception when calling UploadsApi->deleteUpload: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UploadsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UploadsApi->new();
my $entityType = entityType_example; # String | Entity type
my $id = 56; # Integer | ID of the entity
my $subid = 56; # Integer | ID of the upload

eval { 
    $api_instance->deleteUpload(entityType => $entityType, id => $id, subid => $subid);
};
if ($@) {
    warn "Exception when calling UploadsApi->deleteUpload: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.UploadsApi()
entityType = entityType_example # String | Entity type
id = 56 # Integer | ID of the entity
subid = 56 # Integer | ID of the upload

try: 
    # Delete an upload.
    api_instance.delete_upload(entityType, id, subid)
except ApiException as e:
    print("Exception when calling UploadsApi->deleteUpload: %s\n" % e)

Parameters

Path parameters
Name Description
entity_type*
String
Entity type
Required
id*
Integer
ID of the entity
Required
subid*
Integer
ID of the upload
Required

Responses

Status: 204 - The upload was deleted.


patchUpload

Modify attributes such as "real_name", "comment" or "state" of an upload.


/{entity_type}/{id}/uploads/{subid}

Usage and SDK Samples

curl -X PATCH\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/{entity_type}/{id}/uploads/{subid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UploadsApi;

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

public class UploadsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        UploadsApi apiInstance = new UploadsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        Integer subid = 56; // Integer | ID of the upload
        Uploads_subid_body_1 body = ; // Uploads_subid_body_1 | Parameters for modifying an upload attributes.
        try {
            upload result = apiInstance.patchUpload(entityType, id, subid, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UploadsApi#patchUpload");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UploadsApi;

public class UploadsApiExample {

    public static void main(String[] args) {
        UploadsApi apiInstance = new UploadsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        Integer subid = 56; // Integer | ID of the upload
        Uploads_subid_body_1 body = ; // Uploads_subid_body_1 | Parameters for modifying an upload attributes.
        try {
            upload result = apiInstance.patchUpload(entityType, id, subid, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UploadsApi#patchUpload");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *entityType = entityType_example; // Entity type
Integer *id = 56; // ID of the entity
Integer *subid = 56; // ID of the upload
Uploads_subid_body_1 *body = ; // Parameters for modifying an upload attributes. (optional)

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

// Modify attributes such as "real_name", "comment" or "state" of an upload.

[apiInstance patchUploadWith:entityType
    id:id
    subid:subid
    body:body
              completionHandler: ^(upload output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.UploadsApi()
var entityType = entityType_example; // {{String}} Entity type
var id = 56; // {{Integer}} ID of the entity
var subid = 56; // {{Integer}} ID of the upload
var opts = { 
  'body':  // {{Uploads_subid_body_1}} Parameters for modifying an upload attributes.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchUpload(entityTypeidsubid, opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new UploadsApi();
            var entityType = entityType_example;  // String | Entity type
            var id = 56;  // Integer | ID of the entity
            var subid = 56;  // Integer | ID of the upload
            var body = new Uploads_subid_body_1(); // Uploads_subid_body_1 | Parameters for modifying an upload attributes. (optional) 

            try
            {
                // Modify attributes such as "real_name", "comment" or "state" of an upload.

                upload result = apiInstance.patchUpload(entityType, id, subid, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UploadsApi.patchUpload: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiUploadsApi();
$entityType = entityType_example; // String | Entity type
$id = 56; // Integer | ID of the entity
$subid = 56; // Integer | ID of the upload
$body = ; // Uploads_subid_body_1 | Parameters for modifying an upload attributes.

try {
    $result = $api_instance->patchUpload($entityType, $id, $subid, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UploadsApi->patchUpload: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UploadsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UploadsApi->new();
my $entityType = entityType_example; # String | Entity type
my $id = 56; # Integer | ID of the entity
my $subid = 56; # Integer | ID of the upload
my $body = WWW::SwaggerClient::Object::Uploads_subid_body_1->new(); # Uploads_subid_body_1 | Parameters for modifying an upload attributes.

eval { 
    my $result = $api_instance->patchUpload(entityType => $entityType, id => $id, subid => $subid, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UploadsApi->patchUpload: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.UploadsApi()
entityType = entityType_example # String | Entity type
id = 56 # Integer | ID of the entity
subid = 56 # Integer | ID of the upload
body =  # Uploads_subid_body_1 | Parameters for modifying an upload attributes. (optional)

try: 
    # Modify attributes such as "real_name", "comment" or "state" of an upload.

    api_response = api_instance.patch_upload(entityType, id, subid, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UploadsApi->patchUpload: %s\n" % e)

Parameters

Path parameters
Name Description
entity_type*
String
Entity type
Required
id*
Integer
ID of the entity
Required
subid*
Integer
ID of the upload
Required
Body parameters
Name Description
body

Responses

Status: 200 - The updated upload.


postUpload

Create an upload.


/{entity_type}/{id}/uploads

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: multipart/form-data"\
"https://elab.local:3148/api/v2/{entity_type}/{id}/uploads"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UploadsApi;

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

public class UploadsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        UploadsApi apiInstance = new UploadsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        byte[] file = file_example; // byte[] | 
        String comment = comment_example; // String | 
        try {
            apiInstance.postUpload(entityType, id, file, comment);
        } catch (ApiException e) {
            System.err.println("Exception when calling UploadsApi#postUpload");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UploadsApi;

public class UploadsApiExample {

    public static void main(String[] args) {
        UploadsApi apiInstance = new UploadsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        byte[] file = file_example; // byte[] | 
        String comment = comment_example; // String | 
        try {
            apiInstance.postUpload(entityType, id, file, comment);
        } catch (ApiException e) {
            System.err.println("Exception when calling UploadsApi#postUpload");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *entityType = entityType_example; // Entity type
Integer *id = 56; // ID of the entity
byte[] *file = file_example; //  (optional)
String *comment = comment_example; //  (optional)

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

// Create an upload.
[apiInstance postUploadWith:entityType
    id:id
    file:file
    comment:comment
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.UploadsApi()
var entityType = entityType_example; // {{String}} Entity type
var id = 56; // {{Integer}} ID of the entity
var opts = { 
  'file': file_example // {{byte[]}} 
  'comment': comment_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.postUpload(entityTypeid, opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new UploadsApi();
            var entityType = entityType_example;  // String | Entity type
            var id = 56;  // Integer | ID of the entity
            var file = file_example;  // byte[] |  (optional) 
            var comment = comment_example;  // String |  (optional) 

            try
            {
                // Create an upload.
                apiInstance.postUpload(entityType, id, file, comment);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UploadsApi.postUpload: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiUploadsApi();
$entityType = entityType_example; // String | Entity type
$id = 56; // Integer | ID of the entity
$file = file_example; // byte[] | 
$comment = comment_example; // String | 

try {
    $api_instance->postUpload($entityType, $id, $file, $comment);
} catch (Exception $e) {
    echo 'Exception when calling UploadsApi->postUpload: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UploadsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UploadsApi->new();
my $entityType = entityType_example; # String | Entity type
my $id = 56; # Integer | ID of the entity
my $file = file_example; # byte[] | 
my $comment = comment_example; # String | 

eval { 
    $api_instance->postUpload(entityType => $entityType, id => $id, file => $file, comment => $comment);
};
if ($@) {
    warn "Exception when calling UploadsApi->postUpload: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.UploadsApi()
entityType = entityType_example # String | Entity type
id = 56 # Integer | ID of the entity
file = file_example # byte[] |  (optional)
comment = comment_example # String |  (optional)

try: 
    # Create an upload.
    api_instance.post_upload(entityType, id, file=file, comment=comment)
except ApiException as e:
    print("Exception when calling UploadsApi->postUpload: %s\n" % e)

Parameters

Path parameters
Name Description
entity_type*
String
Entity type
Required
id*
Integer
ID of the entity
Required
Form parameters
Name Description
file
byte[] (binary)
comment
String

Responses

Status: 201 - The file has been uploaded.

Name Type Format Description
location String

postUploadReplace

Replace an existing uploaded file. The existing file will be archived and the new one will be added.


/{entity_type}/{id}/uploads/{subid}

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: multipart/form-data"\
"https://elab.local:3148/api/v2/{entity_type}/{id}/uploads/{subid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UploadsApi;

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

public class UploadsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        UploadsApi apiInstance = new UploadsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        Integer subid = 56; // Integer | ID of the upload
        byte[] file = file_example; // byte[] | 
        String comment = comment_example; // String | 
        try {
            apiInstance.postUploadReplace(entityType, id, subid, file, comment);
        } catch (ApiException e) {
            System.err.println("Exception when calling UploadsApi#postUploadReplace");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UploadsApi;

public class UploadsApiExample {

    public static void main(String[] args) {
        UploadsApi apiInstance = new UploadsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        Integer subid = 56; // Integer | ID of the upload
        byte[] file = file_example; // byte[] | 
        String comment = comment_example; // String | 
        try {
            apiInstance.postUploadReplace(entityType, id, subid, file, comment);
        } catch (ApiException e) {
            System.err.println("Exception when calling UploadsApi#postUploadReplace");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *entityType = entityType_example; // Entity type
Integer *id = 56; // ID of the entity
Integer *subid = 56; // ID of the upload
byte[] *file = file_example; //  (optional)
String *comment = comment_example; //  (optional)

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

// Replace an existing uploaded file. The existing file will be archived and the new one will be added.
[apiInstance postUploadReplaceWith:entityType
    id:id
    subid:subid
    file:file
    comment:comment
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.UploadsApi()
var entityType = entityType_example; // {{String}} Entity type
var id = 56; // {{Integer}} ID of the entity
var subid = 56; // {{Integer}} ID of the upload
var opts = { 
  'file': file_example // {{byte[]}} 
  'comment': comment_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.postUploadReplace(entityTypeidsubid, opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new UploadsApi();
            var entityType = entityType_example;  // String | Entity type
            var id = 56;  // Integer | ID of the entity
            var subid = 56;  // Integer | ID of the upload
            var file = file_example;  // byte[] |  (optional) 
            var comment = comment_example;  // String |  (optional) 

            try
            {
                // Replace an existing uploaded file. The existing file will be archived and the new one will be added.
                apiInstance.postUploadReplace(entityType, id, subid, file, comment);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UploadsApi.postUploadReplace: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiUploadsApi();
$entityType = entityType_example; // String | Entity type
$id = 56; // Integer | ID of the entity
$subid = 56; // Integer | ID of the upload
$file = file_example; // byte[] | 
$comment = comment_example; // String | 

try {
    $api_instance->postUploadReplace($entityType, $id, $subid, $file, $comment);
} catch (Exception $e) {
    echo 'Exception when calling UploadsApi->postUploadReplace: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UploadsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UploadsApi->new();
my $entityType = entityType_example; # String | Entity type
my $id = 56; # Integer | ID of the entity
my $subid = 56; # Integer | ID of the upload
my $file = file_example; # byte[] | 
my $comment = comment_example; # String | 

eval { 
    $api_instance->postUploadReplace(entityType => $entityType, id => $id, subid => $subid, file => $file, comment => $comment);
};
if ($@) {
    warn "Exception when calling UploadsApi->postUploadReplace: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.UploadsApi()
entityType = entityType_example # String | Entity type
id = 56 # Integer | ID of the entity
subid = 56 # Integer | ID of the upload
file = file_example # byte[] |  (optional)
comment = comment_example # String |  (optional)

try: 
    # Replace an existing uploaded file. The existing file will be archived and the new one will be added.
    api_instance.post_upload_replace(entityType, id, subid, file=file, comment=comment)
except ApiException as e:
    print("Exception when calling UploadsApi->postUploadReplace: %s\n" % e)

Parameters

Path parameters
Name Description
entity_type*
String
Entity type
Required
id*
Integer
ID of the entity
Required
subid*
Integer
ID of the upload
Required
Form parameters
Name Description
file
byte[] (binary)
comment
String

Responses

Status: 201 - The file has been uploaded.

Name Type Format Description
location String

readUpload

Read an upload.


/{entity_type}/{id}/uploads/{subid}

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json,*/*"\
"https://elab.local:3148/api/v2/{entity_type}/{id}/uploads/{subid}?format="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UploadsApi;

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

public class UploadsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        UploadsApi apiInstance = new UploadsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        Integer subid = 56; // Integer | ID of the upload
        String format = format_example; // String | To download the file itself, use `binary` format parameter. In python library, when downloading a file content, make sure to add ` _preload_content=False` into the call to `read_upload()`.

        try {
            upload result = apiInstance.readUpload(entityType, id, subid, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UploadsApi#readUpload");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UploadsApi;

public class UploadsApiExample {

    public static void main(String[] args) {
        UploadsApi apiInstance = new UploadsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        Integer subid = 56; // Integer | ID of the upload
        String format = format_example; // String | To download the file itself, use `binary` format parameter. In python library, when downloading a file content, make sure to add ` _preload_content=False` into the call to `read_upload()`.

        try {
            upload result = apiInstance.readUpload(entityType, id, subid, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UploadsApi#readUpload");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *entityType = entityType_example; // Entity type
Integer *id = 56; // ID of the entity
Integer *subid = 56; // ID of the upload
String *format = format_example; // To download the file itself, use `binary` format parameter. In python library, when downloading a file content, make sure to add ` _preload_content=False` into the call to `read_upload()`.
 (optional) (default to json)

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

// Read an upload.
[apiInstance readUploadWith:entityType
    id:id
    subid:subid
    format:format
              completionHandler: ^(upload output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.UploadsApi()
var entityType = entityType_example; // {{String}} Entity type
var id = 56; // {{Integer}} ID of the entity
var subid = 56; // {{Integer}} ID of the upload
var opts = { 
  'format': format_example // {{String}} To download the file itself, use `binary` format parameter. In python library, when downloading a file content, make sure to add ` _preload_content=False` into the call to `read_upload()`.

};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readUpload(entityType, id, subid, opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new UploadsApi();
            var entityType = entityType_example;  // String | Entity type
            var id = 56;  // Integer | ID of the entity
            var subid = 56;  // Integer | ID of the upload
            var format = format_example;  // String | To download the file itself, use `binary` format parameter. In python library, when downloading a file content, make sure to add ` _preload_content=False` into the call to `read_upload()`.
 (optional)  (default to json)

            try
            {
                // Read an upload.
                upload result = apiInstance.readUpload(entityType, id, subid, format);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UploadsApi.readUpload: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiUploadsApi();
$entityType = entityType_example; // String | Entity type
$id = 56; // Integer | ID of the entity
$subid = 56; // Integer | ID of the upload
$format = format_example; // String | To download the file itself, use `binary` format parameter. In python library, when downloading a file content, make sure to add ` _preload_content=False` into the call to `read_upload()`.


try {
    $result = $api_instance->readUpload($entityType, $id, $subid, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UploadsApi->readUpload: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UploadsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UploadsApi->new();
my $entityType = entityType_example; # String | Entity type
my $id = 56; # Integer | ID of the entity
my $subid = 56; # Integer | ID of the upload
my $format = format_example; # String | To download the file itself, use `binary` format parameter. In python library, when downloading a file content, make sure to add ` _preload_content=False` into the call to `read_upload()`.


eval { 
    my $result = $api_instance->readUpload(entityType => $entityType, id => $id, subid => $subid, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UploadsApi->readUpload: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.UploadsApi()
entityType = entityType_example # String | Entity type
id = 56 # Integer | ID of the entity
subid = 56 # Integer | ID of the upload
format = format_example # String | To download the file itself, use `binary` format parameter. In python library, when downloading a file content, make sure to add ` _preload_content=False` into the call to `read_upload()`.
 (optional) (default to json)

try: 
    # Read an upload.
    api_response = api_instance.read_upload(entityType, id, subid, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UploadsApi->readUpload: %s\n" % e)

Parameters

Path parameters
Name Description
entity_type*
String
Entity type
Required
id*
Integer
ID of the entity
Required
subid*
Integer
ID of the upload
Required
Query parameters
Name Description
format
String
To download the file itself, use `binary` format parameter. In python library, when downloading a file content, make sure to add ` _preload_content=False` into the call to `read_upload()`.

Responses

Status: 200 - An upload. Note: with binary output, Content-Type header will vary depending of the file type being sent.


readUploads

Read attached files of that entity.


/{entity_type}/{id}/uploads

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/{entity_type}/{id}/uploads"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UploadsApi;

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

public class UploadsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        UploadsApi apiInstance = new UploadsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        try {
            array[upload] result = apiInstance.readUploads(entityType, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UploadsApi#readUploads");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UploadsApi;

public class UploadsApiExample {

    public static void main(String[] args) {
        UploadsApi apiInstance = new UploadsApi();
        String entityType = entityType_example; // String | Entity type
        Integer id = 56; // Integer | ID of the entity
        try {
            array[upload] result = apiInstance.readUploads(entityType, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UploadsApi#readUploads");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *entityType = entityType_example; // Entity type
Integer *id = 56; // ID of the entity

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

// Read attached files of that entity.
[apiInstance readUploadsWith:entityType
    id:id
              completionHandler: ^(array[upload] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.UploadsApi()
var entityType = entityType_example; // {{String}} Entity type
var id = 56; // {{Integer}} ID of the entity

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readUploads(entityType, id, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new UploadsApi();
            var entityType = entityType_example;  // String | Entity type
            var id = 56;  // Integer | ID of the entity

            try
            {
                // Read attached files of that entity.
                array[upload] result = apiInstance.readUploads(entityType, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UploadsApi.readUploads: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiUploadsApi();
$entityType = entityType_example; // String | Entity type
$id = 56; // Integer | ID of the entity

try {
    $result = $api_instance->readUploads($entityType, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UploadsApi->readUploads: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UploadsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UploadsApi->new();
my $entityType = entityType_example; # String | Entity type
my $id = 56; # Integer | ID of the entity

eval { 
    my $result = $api_instance->readUploads(entityType => $entityType, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UploadsApi->readUploads: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.UploadsApi()
entityType = entityType_example # String | Entity type
id = 56 # Integer | ID of the entity

try: 
    # Read attached files of that entity.
    api_response = api_instance.read_uploads(entityType, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UploadsApi->readUploads: %s\n" % e)

Parameters

Path parameters
Name Description
entity_type*
String
Entity type
Required
id*
Integer
ID of the entity
Required

Responses

Status: 200 - A list of uploads.


Users

patchUser

Modify a user.

Note: it is possible to use "me" instead of the userid to access the user of the API key.


/users/{id}

Usage and SDK Samples

curl -X PATCH\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/users/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        UsersApi apiInstance = new UsersApi();
        id_1 id = ; // id_1 | ID of the user or `me`.
        Users_id_body body = ; // Users_id_body | Parameters for modifying a user.
        try {
            users result = apiInstance.patchUser(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#patchUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        id_1 id = ; // id_1 | ID of the user or `me`.
        Users_id_body body = ; // Users_id_body | Parameters for modifying a user.
        try {
            users result = apiInstance.patchUser(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#patchUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
id_1 *id = ; // ID of the user or `me`.
Users_id_body *body = ; // Parameters for modifying a user. (optional)

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

// Modify a user.
[apiInstance patchUserWith:id
    body:body
              completionHandler: ^(users output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.UsersApi()
var id = ; // {{id_1}} ID of the user or `me`.
var opts = { 
  'body':  // {{Users_id_body}} Parameters for modifying a user.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchUser(id, opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new UsersApi();
            var id = new id_1(); // id_1 | ID of the user or `me`.
            var body = new Users_id_body(); // Users_id_body | Parameters for modifying a user. (optional) 

            try
            {
                // Modify a user.
                users result = apiInstance.patchUser(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.patchUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiUsersApi();
$id = ; // id_1 | ID of the user or `me`.
$body = ; // Users_id_body | Parameters for modifying a user.

try {
    $result = $api_instance->patchUser($id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->patchUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UsersApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $id = ; # id_1 | ID of the user or `me`.
my $body = WWW::SwaggerClient::Object::Users_id_body->new(); # Users_id_body | Parameters for modifying a user.

eval { 
    my $result = $api_instance->patchUser(id => $id, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->patchUser: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.UsersApi()
id =  # id_1 | ID of the user or `me`.
body =  # Users_id_body | Parameters for modifying a user. (optional)

try: 
    # Modify a user.
    api_response = api_instance.patch_user(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->patchUser: %s\n" % e)

Parameters

Path parameters
Name Description
id*
id_1
ID of the user or `me`.
Required
Body parameters
Name Description
body

Responses

Status: 200 - Public properties of a user.


postUser

Create a new user.

An Admin can create a user in its own team only. A sysadmin can specify the team.


/users

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://elab.local:3148/api/v2/users"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        UsersApi apiInstance = new UsersApi();
        Users_body body = ; // Users_body | Parameters for creating a user.
        try {
            apiInstance.postUser(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#postUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        Users_body body = ; // Users_body | Parameters for creating a user.
        try {
            apiInstance.postUser(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#postUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Users_body *body = ; // Parameters for creating a user. (optional)

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

// Create a new user.
[apiInstance postUserWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.UsersApi()
var opts = { 
  'body':  // {{Users_body}} Parameters for creating a user.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.postUser(opts, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new UsersApi();
            var body = new Users_body(); // Users_body | Parameters for creating a user. (optional) 

            try
            {
                // Create a new user.
                apiInstance.postUser(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.postUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiUsersApi();
$body = ; // Users_body | Parameters for creating a user.

try {
    $api_instance->postUser($body);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->postUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UsersApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $body = WWW::SwaggerClient::Object::Users_body->new(); # Users_body | Parameters for creating a user.

eval { 
    $api_instance->postUser(body => $body);
};
if ($@) {
    warn "Exception when calling UsersApi->postUser: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.UsersApi()
body =  # Users_body | Parameters for creating a user. (optional)

try: 
    # Create a new user.
    api_instance.post_user(body=body)
except ApiException as e:
    print("Exception when calling UsersApi->postUser: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 201 - The user has been created.

Name Type Format Description
location String

readUser

Read information of a user.

Note: it is possible to use "me" instead of the userid to access the user of the API key.


/users/{id}

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/users/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        UsersApi apiInstance = new UsersApi();
        id_1 id = ; // id_1 | ID of the user or `me`.
        try {
            users result = apiInstance.readUser(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#readUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        id_1 id = ; // id_1 | ID of the user or `me`.
        try {
            users result = apiInstance.readUser(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#readUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
id_1 *id = ; // ID of the user or `me`.

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

// Read information of a user.
[apiInstance readUserWith:id
              completionHandler: ^(users output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.UsersApi()
var id = ; // {{id_1}} ID of the user or `me`.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readUser(id, callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new UsersApi();
            var id = new id_1(); // id_1 | ID of the user or `me`.

            try
            {
                // Read information of a user.
                users result = apiInstance.readUser(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.readUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiUsersApi();
$id = ; // id_1 | ID of the user or `me`.

try {
    $result = $api_instance->readUser($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->readUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UsersApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $id = ; # id_1 | ID of the user or `me`.

eval { 
    my $result = $api_instance->readUser(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->readUser: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.UsersApi()
id =  # id_1 | ID of the user or `me`.

try: 
    # Read information of a user.
    api_response = api_instance.read_user(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->readUser: %s\n" % e)

Parameters

Path parameters
Name Description
id*
id_1
ID of the user or `me`.
Required

Responses

Status: 200 - Public properties of a user.


readUsers

Read users from instance.

If Sysadmin all users will be shown. If Admin only the users from the team. Normal users will be shown an error.


/users

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://elab.local:3148/api/v2/users"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        UsersApi apiInstance = new UsersApi();
        try {
            array[inline_response_200_5] result = apiInstance.readUsers();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#readUsers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        try {
            array[inline_response_200_5] result = apiInstance.readUsers();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#readUsers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

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

// Read users from instance.
[apiInstance readUsersWithCompletionHandler: 
              ^(array[inline_response_200_5] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ELabFtwRestApiV2Documentation = require('e_lab_ftw_rest_api_v2_documentation');
var defaultClient = ELabFtwRestApiV2Documentation.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new ELabFtwRestApiV2Documentation.UsersApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readUsers(callback);
using System;
using System.Diagnostics;
using elabapi_python.Api;
using elabapi_python.Client;
using elabapi_python.Model;

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

            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new UsersApi();

            try
            {
                // Read users from instance.
                array[inline_response_200_5] result = apiInstance.readUsers();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.readUsers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiUsersApi();

try {
    $result = $api_instance->readUsers();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->readUsers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UsersApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UsersApi->new();

eval { 
    my $result = $api_instance->readUsers();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->readUsers: $@\n";
}
from __future__ import print_statement
import time
import elabapi_python
from elabapi_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
elabapi_python.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# elabapi_python.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = elabapi_python.UsersApi()

try: 
    # Read users from instance.
    api_response = api_instance.read_users()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->readUsers: %s\n" % e)

Parameters

Responses

Status: 200 - A list of users