BamBirds

Agent

addAgent

Agent endpoint: Add a agent


/api/agents

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:3000/api/agents" \
 -d '{
  "name" : "BamBirds",
  "source" : "https://sme.uni-bamberg.de/bambirds/bambirds",
  "maintainer" : "Diedrich Wolter",
  "docker_image" : "registry.sme.uni-bamberg.de/bambirds/bambirds"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AgentApi;

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

public class AgentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        AgentApi apiInstance = new AgentApi();
        InputAgent inputAgent = ; // InputAgent | 

        try {
            Agent result = apiInstance.addAgent(inputAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentApi#addAgent");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AgentApi;

public class AgentApiExample {
    public static void main(String[] args) {
        AgentApi apiInstance = new AgentApi();
        InputAgent inputAgent = ; // InputAgent | 

        try {
            Agent result = apiInstance.addAgent(inputAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentApi#addAgent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
AgentApi *apiInstance = [[AgentApi alloc] init];
InputAgent *inputAgent = ; //  (optional)

// Agent endpoint: Add a agent
[apiInstance addAgentWith:inputAgent
              completionHandler: ^(Agent output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var BamBirds = require('bam_birds');
var defaultClient = BamBirds.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new BamBirds.AgentApi()
var opts = {
  'inputAgent':  // {InputAgent} 
};

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

namespace Example
{
    public class addAgentExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new AgentApi();
            var inputAgent = new InputAgent(); // InputAgent |  (optional) 

            try {
                // Agent endpoint: Add a agent
                Agent result = apiInstance.addAgent(inputAgent);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AgentApi.addAgent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AgentApi();
$inputAgent = ; // InputAgent | 

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AgentApi->new();
my $inputAgent = WWW::OPenAPIClient::Object::InputAgent->new(); # InputAgent | 

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AgentApi()
inputAgent =  # InputAgent |  (optional)

try:
    # Agent endpoint: Add a agent
    api_response = api_instance.add_agent(inputAgent=inputAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AgentApi->addAgent: %s\n" % e)
extern crate AgentApi;

pub fn main() {
    let inputAgent = ; // InputAgent

    let mut context = AgentApi::Context::default();
    let result = client.addAgent(inputAgent, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
inputAgent

Responses


addAgentVersion

AgentVersion endpoint: Add an agent version


/api/agents/{agent_id}/versions

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:3000/api/agents/{agent_id}/versions" \
 -d '{
  "type" : "submission",
  "tag" : "v19",
  "date" : "2020-08-01"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AgentApi;

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

public class AgentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        AgentApi apiInstance = new AgentApi();
        Integer agentId = 56; // Integer | ID of the agent
        InputAgentVersion inputAgentVersion = ; // InputAgentVersion | 

        try {
            array[AgentVersion] result = apiInstance.addAgentVersion(agentId, inputAgentVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentApi#addAgentVersion");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AgentApi;

public class AgentApiExample {
    public static void main(String[] args) {
        AgentApi apiInstance = new AgentApi();
        Integer agentId = 56; // Integer | ID of the agent
        InputAgentVersion inputAgentVersion = ; // InputAgentVersion | 

        try {
            array[AgentVersion] result = apiInstance.addAgentVersion(agentId, inputAgentVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentApi#addAgentVersion");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
AgentApi *apiInstance = [[AgentApi alloc] init];
Integer *agentId = 56; // ID of the agent (default to null)
InputAgentVersion *inputAgentVersion = ; //  (optional)

// AgentVersion endpoint: Add an agent version
[apiInstance addAgentVersionWith:agentId
    inputAgentVersion:inputAgentVersion
              completionHandler: ^(array[AgentVersion] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var BamBirds = require('bam_birds');
var defaultClient = BamBirds.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new BamBirds.AgentApi()
var agentId = 56; // {Integer} ID of the agent
var opts = {
  'inputAgentVersion':  // {InputAgentVersion} 
};

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

namespace Example
{
    public class addAgentVersionExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new AgentApi();
            var agentId = 56;  // Integer | ID of the agent (default to null)
            var inputAgentVersion = new InputAgentVersion(); // InputAgentVersion |  (optional) 

            try {
                // AgentVersion endpoint: Add an agent version
                array[AgentVersion] result = apiInstance.addAgentVersion(agentId, inputAgentVersion);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AgentApi.addAgentVersion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AgentApi();
$agentId = 56; // Integer | ID of the agent
$inputAgentVersion = ; // InputAgentVersion | 

try {
    $result = $api_instance->addAgentVersion($agentId, $inputAgentVersion);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AgentApi->addAgentVersion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AgentApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AgentApi->new();
my $agentId = 56; # Integer | ID of the agent
my $inputAgentVersion = WWW::OPenAPIClient::Object::InputAgentVersion->new(); # InputAgentVersion | 

eval {
    my $result = $api_instance->addAgentVersion(agentId => $agentId, inputAgentVersion => $inputAgentVersion);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AgentApi->addAgentVersion: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AgentApi()
agentId = 56 # Integer | ID of the agent (default to null)
inputAgentVersion =  # InputAgentVersion |  (optional)

try:
    # AgentVersion endpoint: Add an agent version
    api_response = api_instance.add_agent_version(agentId, inputAgentVersion=inputAgentVersion)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AgentApi->addAgentVersion: %s\n" % e)
extern crate AgentApi;

pub fn main() {
    let agentId = 56; // Integer
    let inputAgentVersion = ; // InputAgentVersion

    let mut context = AgentApi::Context::default();
    let result = client.addAgentVersion(agentId, inputAgentVersion, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
agent_id*
Integer (int32)
ID of the agent
Required
Body parameters
Name Description
inputAgentVersion

Responses


addAgentVersionAttempts

AgentVersionAttempts endpoint: Add an agent version attempt


/api/agents/{agent_id}/versions/{version_id}/attempts

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:3000/api/agents/{agent_id}/versions/{version_id}/attempts" \
 -d '{
  "duration" : "00:05:00",
  "max_score" : 28400,
  "first_score" : 24900,
  "count_attempts" : 20,
  "time_until_max_score" : "00:01:34",
  "time_until_first_score" : "00:00:20",
  "attempts_until_first_score" : 0,
  "attempts_until_max_score" : 5
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AgentApi;

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

public class AgentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        AgentApi apiInstance = new AgentApi();
        Integer agentId = 56; // Integer | ID of the agent
        Integer versionId = 56; // Integer | ID of the agent version
        InputAgentVersionAttempt inputAgentVersionAttempt = ; // InputAgentVersionAttempt | 

        try {
            array[AgentVersionAttempt] result = apiInstance.addAgentVersionAttempts(agentId, versionId, inputAgentVersionAttempt);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentApi#addAgentVersionAttempts");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AgentApi;

public class AgentApiExample {
    public static void main(String[] args) {
        AgentApi apiInstance = new AgentApi();
        Integer agentId = 56; // Integer | ID of the agent
        Integer versionId = 56; // Integer | ID of the agent version
        InputAgentVersionAttempt inputAgentVersionAttempt = ; // InputAgentVersionAttempt | 

        try {
            array[AgentVersionAttempt] result = apiInstance.addAgentVersionAttempts(agentId, versionId, inputAgentVersionAttempt);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentApi#addAgentVersionAttempts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
AgentApi *apiInstance = [[AgentApi alloc] init];
Integer *agentId = 56; // ID of the agent (default to null)
Integer *versionId = 56; // ID of the agent version (default to null)
InputAgentVersionAttempt *inputAgentVersionAttempt = ; //  (optional)

// AgentVersionAttempts endpoint: Add an agent version attempt
[apiInstance addAgentVersionAttemptsWith:agentId
    versionId:versionId
    inputAgentVersionAttempt:inputAgentVersionAttempt
              completionHandler: ^(array[AgentVersionAttempt] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var BamBirds = require('bam_birds');
var defaultClient = BamBirds.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new BamBirds.AgentApi()
var agentId = 56; // {Integer} ID of the agent
var versionId = 56; // {Integer} ID of the agent version
var opts = {
  'inputAgentVersionAttempt':  // {InputAgentVersionAttempt} 
};

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

namespace Example
{
    public class addAgentVersionAttemptsExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new AgentApi();
            var agentId = 56;  // Integer | ID of the agent (default to null)
            var versionId = 56;  // Integer | ID of the agent version (default to null)
            var inputAgentVersionAttempt = new InputAgentVersionAttempt(); // InputAgentVersionAttempt |  (optional) 

            try {
                // AgentVersionAttempts endpoint: Add an agent version attempt
                array[AgentVersionAttempt] result = apiInstance.addAgentVersionAttempts(agentId, versionId, inputAgentVersionAttempt);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AgentApi.addAgentVersionAttempts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AgentApi();
$agentId = 56; // Integer | ID of the agent
$versionId = 56; // Integer | ID of the agent version
$inputAgentVersionAttempt = ; // InputAgentVersionAttempt | 

try {
    $result = $api_instance->addAgentVersionAttempts($agentId, $versionId, $inputAgentVersionAttempt);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AgentApi->addAgentVersionAttempts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AgentApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AgentApi->new();
my $agentId = 56; # Integer | ID of the agent
my $versionId = 56; # Integer | ID of the agent version
my $inputAgentVersionAttempt = WWW::OPenAPIClient::Object::InputAgentVersionAttempt->new(); # InputAgentVersionAttempt | 

eval {
    my $result = $api_instance->addAgentVersionAttempts(agentId => $agentId, versionId => $versionId, inputAgentVersionAttempt => $inputAgentVersionAttempt);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AgentApi->addAgentVersionAttempts: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AgentApi()
agentId = 56 # Integer | ID of the agent (default to null)
versionId = 56 # Integer | ID of the agent version (default to null)
inputAgentVersionAttempt =  # InputAgentVersionAttempt |  (optional)

try:
    # AgentVersionAttempts endpoint: Add an agent version attempt
    api_response = api_instance.add_agent_version_attempts(agentId, versionId, inputAgentVersionAttempt=inputAgentVersionAttempt)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AgentApi->addAgentVersionAttempts: %s\n" % e)
extern crate AgentApi;

pub fn main() {
    let agentId = 56; // Integer
    let versionId = 56; // Integer
    let inputAgentVersionAttempt = ; // InputAgentVersionAttempt

    let mut context = AgentApi::Context::default();
    let result = client.addAgentVersionAttempts(agentId, versionId, inputAgentVersionAttempt, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
agent_id*
Integer (int32)
ID of the agent
Required
version_id*
Integer (int32)
ID of the agent version
Required
Body parameters
Name Description
inputAgentVersionAttempt

Responses


deleteAgent

Agent endpoint: delete a agent


/api/agents/{id}

Usage and SDK Samples

curl -X DELETE \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "http://localhost:3000/api/agents/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AgentApi;

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

public class AgentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        AgentApi apiInstance = new AgentApi();
        Integer id = 56; // Integer | ID of the agent

        try {
            Agent result = apiInstance.deleteAgent(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentApi#deleteAgent");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AgentApi;

public class AgentApiExample {
    public static void main(String[] args) {
        AgentApi apiInstance = new AgentApi();
        Integer id = 56; // Integer | ID of the agent

        try {
            Agent result = apiInstance.deleteAgent(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentApi#deleteAgent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
AgentApi *apiInstance = [[AgentApi alloc] init];
Integer *id = 56; // ID of the agent (default to null)

// Agent endpoint: delete a agent
[apiInstance deleteAgentWith:id
              completionHandler: ^(Agent output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var BamBirds = require('bam_birds');
var defaultClient = BamBirds.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new BamBirds.AgentApi()
var id = 56; // {Integer} ID of the agent

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

namespace Example
{
    public class deleteAgentExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new AgentApi();
            var id = 56;  // Integer | ID of the agent (default to null)

            try {
                // Agent endpoint: delete a agent
                Agent result = apiInstance.deleteAgent(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AgentApi.deleteAgent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AgentApi();
$id = 56; // Integer | ID of the agent

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AgentApi->new();
my $id = 56; # Integer | ID of the agent

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AgentApi()
id = 56 # Integer | ID of the agent (default to null)

try:
    # Agent endpoint: delete a agent
    api_response = api_instance.delete_agent(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AgentApi->deleteAgent: %s\n" % e)
extern crate AgentApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = AgentApi::Context::default();
    let result = client.deleteAgent(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
ID of the agent
Required

Responses


deleteAgentVersion

AgentVersion endpoint: delete an agent version


/api/agents/{agent_id}/versions/{version_id}

Usage and SDK Samples

curl -X DELETE \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:3000/api/agents/{agent_id}/versions/{version_id}" \
 -d '{
  "difficulty_id" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AgentApi;

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

public class AgentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        AgentApi apiInstance = new AgentApi();
        Integer agentId = 56; // Integer | ID of the agent
        Integer versionId = 56; // Integer | ID of the agent version
        array[InlineObject] inlineObject = ; // array[InlineObject] | 

        try {
            AgentVersion result = apiInstance.deleteAgentVersion(agentId, versionId, inlineObject);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentApi#deleteAgentVersion");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AgentApi;

public class AgentApiExample {
    public static void main(String[] args) {
        AgentApi apiInstance = new AgentApi();
        Integer agentId = 56; // Integer | ID of the agent
        Integer versionId = 56; // Integer | ID of the agent version
        array[InlineObject] inlineObject = ; // array[InlineObject] | 

        try {
            AgentVersion result = apiInstance.deleteAgentVersion(agentId, versionId, inlineObject);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentApi#deleteAgentVersion");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
AgentApi *apiInstance = [[AgentApi alloc] init];
Integer *agentId = 56; // ID of the agent (default to null)
Integer *versionId = 56; // ID of the agent version (default to null)
array[InlineObject] *inlineObject = ; //  (optional)

// AgentVersion endpoint: delete an agent version
[apiInstance deleteAgentVersionWith:agentId
    versionId:versionId
    inlineObject:inlineObject
              completionHandler: ^(AgentVersion output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var BamBirds = require('bam_birds');
var defaultClient = BamBirds.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new BamBirds.AgentApi()
var agentId = 56; // {Integer} ID of the agent
var versionId = 56; // {Integer} ID of the agent version
var opts = {
  'inlineObject':  // {array[InlineObject]} 
};

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

namespace Example
{
    public class deleteAgentVersionExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new AgentApi();
            var agentId = 56;  // Integer | ID of the agent (default to null)
            var versionId = 56;  // Integer | ID of the agent version (default to null)
            var inlineObject = new array[InlineObject](); // array[InlineObject] |  (optional) 

            try {
                // AgentVersion endpoint: delete an agent version
                AgentVersion result = apiInstance.deleteAgentVersion(agentId, versionId, inlineObject);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AgentApi.deleteAgentVersion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AgentApi();
$agentId = 56; // Integer | ID of the agent
$versionId = 56; // Integer | ID of the agent version
$inlineObject = ; // array[InlineObject] | 

try {
    $result = $api_instance->deleteAgentVersion($agentId, $versionId, $inlineObject);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AgentApi->deleteAgentVersion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AgentApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AgentApi->new();
my $agentId = 56; # Integer | ID of the agent
my $versionId = 56; # Integer | ID of the agent version
my $inlineObject = [WWW::OPenAPIClient::Object::array[InlineObject]->new()]; # array[InlineObject] | 

eval {
    my $result = $api_instance->deleteAgentVersion(agentId => $agentId, versionId => $versionId, inlineObject => $inlineObject);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AgentApi->deleteAgentVersion: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AgentApi()
agentId = 56 # Integer | ID of the agent (default to null)
versionId = 56 # Integer | ID of the agent version (default to null)
inlineObject =  # array[InlineObject] |  (optional)

try:
    # AgentVersion endpoint: delete an agent version
    api_response = api_instance.delete_agent_version(agentId, versionId, inlineObject=inlineObject)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AgentApi->deleteAgentVersion: %s\n" % e)
extern crate AgentApi;

pub fn main() {
    let agentId = 56; // Integer
    let versionId = 56; // Integer
    let inlineObject = ; // array[InlineObject]

    let mut context = AgentApi::Context::default();
    let result = client.deleteAgentVersion(agentId, versionId, inlineObject, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
agent_id*
Integer (int32)
ID of the agent
Required
version_id*
Integer (int32)
ID of the agent version
Required
Body parameters
Name Description
inlineObject

Responses


getAgent

Agent endpoint: Returns details about a agent


/api/agents/{id}

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "http://localhost:3000/api/agents/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AgentApi;

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

public class AgentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        AgentApi apiInstance = new AgentApi();
        Integer id = 56; // Integer | ID of the agent

        try {
            Agent result = apiInstance.getAgent(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentApi#getAgent");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AgentApi;

public class AgentApiExample {
    public static void main(String[] args) {
        AgentApi apiInstance = new AgentApi();
        Integer id = 56; // Integer | ID of the agent

        try {
            Agent result = apiInstance.getAgent(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentApi#getAgent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
AgentApi *apiInstance = [[AgentApi alloc] init];
Integer *id = 56; // ID of the agent (default to null)

// Agent endpoint: Returns details about a agent
[apiInstance getAgentWith:id
              completionHandler: ^(Agent output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var BamBirds = require('bam_birds');
var defaultClient = BamBirds.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new BamBirds.AgentApi()
var id = 56; // {Integer} ID of the agent

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

namespace Example
{
    public class getAgentExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new AgentApi();
            var id = 56;  // Integer | ID of the agent (default to null)

            try {
                // Agent endpoint: Returns details about a agent
                Agent result = apiInstance.getAgent(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AgentApi.getAgent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AgentApi();
$id = 56; // Integer | ID of the agent

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AgentApi->new();
my $id = 56; # Integer | ID of the agent

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AgentApi()
id = 56 # Integer | ID of the agent (default to null)

try:
    # Agent endpoint: Returns details about a agent
    api_response = api_instance.get_agent(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AgentApi->getAgent: %s\n" % e)
extern crate AgentApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = AgentApi::Context::default();
    let result = client.getAgent(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
ID of the agent
Required

Responses


getAgentVersion

AgentVersion endpoint: Returns details about an agent version


/api/agents/{agent_id}/versions/{version_id}

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "http://localhost:3000/api/agents/{agent_id}/versions/{version_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AgentApi;

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

public class AgentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        AgentApi apiInstance = new AgentApi();
        Integer agentId = 56; // Integer | ID of the agent
        Integer versionId = 56; // Integer | ID of the agent version

        try {
            AgentVersion result = apiInstance.getAgentVersion(agentId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentApi#getAgentVersion");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AgentApi;

public class AgentApiExample {
    public static void main(String[] args) {
        AgentApi apiInstance = new AgentApi();
        Integer agentId = 56; // Integer | ID of the agent
        Integer versionId = 56; // Integer | ID of the agent version

        try {
            AgentVersion result = apiInstance.getAgentVersion(agentId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentApi#getAgentVersion");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
AgentApi *apiInstance = [[AgentApi alloc] init];
Integer *agentId = 56; // ID of the agent (default to null)
Integer *versionId = 56; // ID of the agent version (default to null)

// AgentVersion endpoint: Returns details about an agent version
[apiInstance getAgentVersionWith:agentId
    versionId:versionId
              completionHandler: ^(AgentVersion output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var BamBirds = require('bam_birds');
var defaultClient = BamBirds.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new BamBirds.AgentApi()
var agentId = 56; // {Integer} ID of the agent
var versionId = 56; // {Integer} ID of the agent version

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

namespace Example
{
    public class getAgentVersionExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new AgentApi();
            var agentId = 56;  // Integer | ID of the agent (default to null)
            var versionId = 56;  // Integer | ID of the agent version (default to null)

            try {
                // AgentVersion endpoint: Returns details about an agent version
                AgentVersion result = apiInstance.getAgentVersion(agentId, versionId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AgentApi.getAgentVersion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AgentApi();
$agentId = 56; // Integer | ID of the agent
$versionId = 56; // Integer | ID of the agent version

try {
    $result = $api_instance->getAgentVersion($agentId, $versionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AgentApi->getAgentVersion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AgentApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AgentApi->new();
my $agentId = 56; # Integer | ID of the agent
my $versionId = 56; # Integer | ID of the agent version

eval {
    my $result = $api_instance->getAgentVersion(agentId => $agentId, versionId => $versionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AgentApi->getAgentVersion: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AgentApi()
agentId = 56 # Integer | ID of the agent (default to null)
versionId = 56 # Integer | ID of the agent version (default to null)

try:
    # AgentVersion endpoint: Returns details about an agent version
    api_response = api_instance.get_agent_version(agentId, versionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AgentApi->getAgentVersion: %s\n" % e)
extern crate AgentApi;

pub fn main() {
    let agentId = 56; // Integer
    let versionId = 56; // Integer

    let mut context = AgentApi::Context::default();
    let result = client.getAgentVersion(agentId, versionId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
agent_id*
Integer (int32)
ID of the agent
Required
version_id*
Integer (int32)
ID of the agent version
Required

Responses


listAgentVersion

AgentVersion endpoint: Returns all versions of the agent


/api/agents/{agent_id}/versions

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "http://localhost:3000/api/agents/{agent_id}/versions"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AgentApi;

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

public class AgentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        AgentApi apiInstance = new AgentApi();
        Integer agentId = 56; // Integer | ID of the agent

        try {
            array[AgentVersion] result = apiInstance.listAgentVersion(agentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentApi#listAgentVersion");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AgentApi;

public class AgentApiExample {
    public static void main(String[] args) {
        AgentApi apiInstance = new AgentApi();
        Integer agentId = 56; // Integer | ID of the agent

        try {
            array[AgentVersion] result = apiInstance.listAgentVersion(agentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentApi#listAgentVersion");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
AgentApi *apiInstance = [[AgentApi alloc] init];
Integer *agentId = 56; // ID of the agent (default to null)

// AgentVersion endpoint: Returns all versions of the agent
[apiInstance listAgentVersionWith:agentId
              completionHandler: ^(array[AgentVersion] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var BamBirds = require('bam_birds');
var defaultClient = BamBirds.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new BamBirds.AgentApi()
var agentId = 56; // {Integer} ID of the agent

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

namespace Example
{
    public class listAgentVersionExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new AgentApi();
            var agentId = 56;  // Integer | ID of the agent (default to null)

            try {
                // AgentVersion endpoint: Returns all versions of the agent
                array[AgentVersion] result = apiInstance.listAgentVersion(agentId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AgentApi.listAgentVersion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AgentApi();
$agentId = 56; // Integer | ID of the agent

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AgentApi->new();
my $agentId = 56; # Integer | ID of the agent

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AgentApi()
agentId = 56 # Integer | ID of the agent (default to null)

try:
    # AgentVersion endpoint: Returns all versions of the agent
    api_response = api_instance.list_agent_version(agentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AgentApi->listAgentVersion: %s\n" % e)
extern crate AgentApi;

pub fn main() {
    let agentId = 56; // Integer

    let mut context = AgentApi::Context::default();
    let result = client.listAgentVersion(agentId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
agent_id*
Integer (int32)
ID of the agent
Required

Responses


listAgentVersionAttempts

AgentVersionAttempts endpoint: Returns all attempts by the agent version


/api/agents/{agent_id}/versions/{version_id}/attempts

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "http://localhost:3000/api/agents/{agent_id}/versions/{version_id}/attempts?offset=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AgentApi;

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

public class AgentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        AgentApi apiInstance = new AgentApi();
        Integer agentId = 56; // Integer | ID of the agent
        Integer versionId = 56; // Integer | ID of the agent version
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return

        try {
            array[AgentVersionAttempt] result = apiInstance.listAgentVersionAttempts(agentId, versionId, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentApi#listAgentVersionAttempts");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AgentApi;

public class AgentApiExample {
    public static void main(String[] args) {
        AgentApi apiInstance = new AgentApi();
        Integer agentId = 56; // Integer | ID of the agent
        Integer versionId = 56; // Integer | ID of the agent version
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return

        try {
            array[AgentVersionAttempt] result = apiInstance.listAgentVersionAttempts(agentId, versionId, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentApi#listAgentVersionAttempts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
AgentApi *apiInstance = [[AgentApi alloc] init];
Integer *agentId = 56; // ID of the agent (default to null)
Integer *versionId = 56; // ID of the agent version (default to null)
Integer *offset = 56; // The number of items to skip before starting to collect the result set (optional) (default to null)
Integer *limit = 56; // The numbers of items to return (optional) (default to null)

// AgentVersionAttempts endpoint: Returns all attempts by the agent version
[apiInstance listAgentVersionAttemptsWith:agentId
    versionId:versionId
    offset:offset
    limit:limit
              completionHandler: ^(array[AgentVersionAttempt] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var BamBirds = require('bam_birds');
var defaultClient = BamBirds.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new BamBirds.AgentApi()
var agentId = 56; // {Integer} ID of the agent
var versionId = 56; // {Integer} ID of the agent version
var opts = {
  'offset': 56, // {Integer} The number of items to skip before starting to collect the result set
  'limit': 56 // {Integer} The numbers of items to return
};

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

namespace Example
{
    public class listAgentVersionAttemptsExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new AgentApi();
            var agentId = 56;  // Integer | ID of the agent (default to null)
            var versionId = 56;  // Integer | ID of the agent version (default to null)
            var offset = 56;  // Integer | The number of items to skip before starting to collect the result set (optional)  (default to null)
            var limit = 56;  // Integer | The numbers of items to return (optional)  (default to null)

            try {
                // AgentVersionAttempts endpoint: Returns all attempts by the agent version
                array[AgentVersionAttempt] result = apiInstance.listAgentVersionAttempts(agentId, versionId, offset, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AgentApi.listAgentVersionAttempts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AgentApi();
$agentId = 56; // Integer | ID of the agent
$versionId = 56; // Integer | ID of the agent version
$offset = 56; // Integer | The number of items to skip before starting to collect the result set
$limit = 56; // Integer | The numbers of items to return

try {
    $result = $api_instance->listAgentVersionAttempts($agentId, $versionId, $offset, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AgentApi->listAgentVersionAttempts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AgentApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AgentApi->new();
my $agentId = 56; # Integer | ID of the agent
my $versionId = 56; # Integer | ID of the agent version
my $offset = 56; # Integer | The number of items to skip before starting to collect the result set
my $limit = 56; # Integer | The numbers of items to return

eval {
    my $result = $api_instance->listAgentVersionAttempts(agentId => $agentId, versionId => $versionId, offset => $offset, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AgentApi->listAgentVersionAttempts: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AgentApi()
agentId = 56 # Integer | ID of the agent (default to null)
versionId = 56 # Integer | ID of the agent version (default to null)
offset = 56 # Integer | The number of items to skip before starting to collect the result set (optional) (default to null)
limit = 56 # Integer | The numbers of items to return (optional) (default to null)

try:
    # AgentVersionAttempts endpoint: Returns all attempts by the agent version
    api_response = api_instance.list_agent_version_attempts(agentId, versionId, offset=offset, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AgentApi->listAgentVersionAttempts: %s\n" % e)
extern crate AgentApi;

pub fn main() {
    let agentId = 56; // Integer
    let versionId = 56; // Integer
    let offset = 56; // Integer
    let limit = 56; // Integer

    let mut context = AgentApi::Context::default();
    let result = client.listAgentVersionAttempts(agentId, versionId, offset, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
agent_id*
Integer (int32)
ID of the agent
Required
version_id*
Integer (int32)
ID of the agent version
Required
Query parameters
Name Description
offset
Integer
The number of items to skip before starting to collect the result set
limit
Integer
The numbers of items to return

Responses


listAgents

Agent endpoint: Get all difficulties


/api/agents

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "http://localhost:3000/api/agents"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AgentApi;

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

public class AgentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        AgentApi apiInstance = new AgentApi();

        try {
            array[Agent] result = apiInstance.listAgents();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentApi#listAgents");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AgentApi;

public class AgentApiExample {
    public static void main(String[] args) {
        AgentApi apiInstance = new AgentApi();

        try {
            array[Agent] result = apiInstance.listAgents();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentApi#listAgents");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
AgentApi *apiInstance = [[AgentApi alloc] init];

// Agent endpoint: Get all difficulties
[apiInstance listAgentsWithCompletionHandler: 
              ^(array[Agent] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var BamBirds = require('bam_birds');
var defaultClient = BamBirds.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new BamBirds.AgentApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listAgents(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listAgentsExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new AgentApi();

            try {
                // Agent endpoint: Get all difficulties
                array[Agent] result = apiInstance.listAgents();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AgentApi.listAgents: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AgentApi();

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AgentApi->new();

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AgentApi()

try:
    # Agent endpoint: Get all difficulties
    api_response = api_instance.list_agents()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AgentApi->listAgents: %s\n" % e)
extern crate AgentApi;

pub fn main() {

    let mut context = AgentApi::Context::default();
    let result = client.listAgents(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


updateAgent

Agent endpoint: Update agent info


/api/agents/{id}

Usage and SDK Samples

curl -X PUT \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:3000/api/agents/{id}" \
 -d '{
  "name" : "BamBirds",
  "source" : "https://sme.uni-bamberg.de/bambirds/bambirds",
  "maintainer" : "Diedrich Wolter",
  "docker_image" : "registry.sme.uni-bamberg.de/bambirds/bambirds"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AgentApi;

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

public class AgentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        AgentApi apiInstance = new AgentApi();
        Integer id = 56; // Integer | ID of the agent
        InputAgent inputAgent = ; // InputAgent | 

        try {
            Agent result = apiInstance.updateAgent(id, inputAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentApi#updateAgent");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AgentApi;

public class AgentApiExample {
    public static void main(String[] args) {
        AgentApi apiInstance = new AgentApi();
        Integer id = 56; // Integer | ID of the agent
        InputAgent inputAgent = ; // InputAgent | 

        try {
            Agent result = apiInstance.updateAgent(id, inputAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentApi#updateAgent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
AgentApi *apiInstance = [[AgentApi alloc] init];
Integer *id = 56; // ID of the agent (default to null)
InputAgent *inputAgent = ; //  (optional)

// Agent endpoint: Update agent info
[apiInstance updateAgentWith:id
    inputAgent:inputAgent
              completionHandler: ^(Agent output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var BamBirds = require('bam_birds');
var defaultClient = BamBirds.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new BamBirds.AgentApi()
var id = 56; // {Integer} ID of the agent
var opts = {
  'inputAgent':  // {InputAgent} 
};

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

namespace Example
{
    public class updateAgentExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new AgentApi();
            var id = 56;  // Integer | ID of the agent (default to null)
            var inputAgent = new InputAgent(); // InputAgent |  (optional) 

            try {
                // Agent endpoint: Update agent info
                Agent result = apiInstance.updateAgent(id, inputAgent);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AgentApi.updateAgent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AgentApi();
$id = 56; // Integer | ID of the agent
$inputAgent = ; // InputAgent | 

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AgentApi->new();
my $id = 56; # Integer | ID of the agent
my $inputAgent = WWW::OPenAPIClient::Object::InputAgent->new(); # InputAgent | 

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AgentApi()
id = 56 # Integer | ID of the agent (default to null)
inputAgent =  # InputAgent |  (optional)

try:
    # Agent endpoint: Update agent info
    api_response = api_instance.update_agent(id, inputAgent=inputAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AgentApi->updateAgent: %s\n" % e)
extern crate AgentApi;

pub fn main() {
    let id = 56; // Integer
    let inputAgent = ; // InputAgent

    let mut context = AgentApi::Context::default();
    let result = client.updateAgent(id, inputAgent, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
ID of the agent
Required
Body parameters
Name Description
inputAgent

Responses


updateAgentVersion

AgentVersion endpoint: Update an agent version


/api/agents/{agent_id}/versions/{version_id}

Usage and SDK Samples

curl -X PUT \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:3000/api/agents/{agent_id}/versions/{version_id}" \
 -d '{
  "type" : "submission",
  "tag" : "v19",
  "date" : "2020-08-01"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AgentApi;

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

public class AgentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        AgentApi apiInstance = new AgentApi();
        Integer agentId = 56; // Integer | ID of the agent
        Integer versionId = 56; // Integer | ID of the agent version
        array[InputAgentVersion] inputAgentVersion = ; // array[InputAgentVersion] | 

        try {
            AgentVersion result = apiInstance.updateAgentVersion(agentId, versionId, inputAgentVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentApi#updateAgentVersion");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AgentApi;

public class AgentApiExample {
    public static void main(String[] args) {
        AgentApi apiInstance = new AgentApi();
        Integer agentId = 56; // Integer | ID of the agent
        Integer versionId = 56; // Integer | ID of the agent version
        array[InputAgentVersion] inputAgentVersion = ; // array[InputAgentVersion] | 

        try {
            AgentVersion result = apiInstance.updateAgentVersion(agentId, versionId, inputAgentVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentApi#updateAgentVersion");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
AgentApi *apiInstance = [[AgentApi alloc] init];
Integer *agentId = 56; // ID of the agent (default to null)
Integer *versionId = 56; // ID of the agent version (default to null)
array[InputAgentVersion] *inputAgentVersion = ; //  (optional)

// AgentVersion endpoint: Update an agent version
[apiInstance updateAgentVersionWith:agentId
    versionId:versionId
    inputAgentVersion:inputAgentVersion
              completionHandler: ^(AgentVersion output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var BamBirds = require('bam_birds');
var defaultClient = BamBirds.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new BamBirds.AgentApi()
var agentId = 56; // {Integer} ID of the agent
var versionId = 56; // {Integer} ID of the agent version
var opts = {
  'inputAgentVersion':  // {array[InputAgentVersion]} 
};

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

namespace Example
{
    public class updateAgentVersionExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new AgentApi();
            var agentId = 56;  // Integer | ID of the agent (default to null)
            var versionId = 56;  // Integer | ID of the agent version (default to null)
            var inputAgentVersion = new array[InputAgentVersion](); // array[InputAgentVersion] |  (optional) 

            try {
                // AgentVersion endpoint: Update an agent version
                AgentVersion result = apiInstance.updateAgentVersion(agentId, versionId, inputAgentVersion);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AgentApi.updateAgentVersion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AgentApi();
$agentId = 56; // Integer | ID of the agent
$versionId = 56; // Integer | ID of the agent version
$inputAgentVersion = ; // array[InputAgentVersion] | 

try {
    $result = $api_instance->updateAgentVersion($agentId, $versionId, $inputAgentVersion);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AgentApi->updateAgentVersion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AgentApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AgentApi->new();
my $agentId = 56; # Integer | ID of the agent
my $versionId = 56; # Integer | ID of the agent version
my $inputAgentVersion = [WWW::OPenAPIClient::Object::array[InputAgentVersion]->new()]; # array[InputAgentVersion] | 

eval {
    my $result = $api_instance->updateAgentVersion(agentId => $agentId, versionId => $versionId, inputAgentVersion => $inputAgentVersion);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AgentApi->updateAgentVersion: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AgentApi()
agentId = 56 # Integer | ID of the agent (default to null)
versionId = 56 # Integer | ID of the agent version (default to null)
inputAgentVersion =  # array[InputAgentVersion] |  (optional)

try:
    # AgentVersion endpoint: Update an agent version
    api_response = api_instance.update_agent_version(agentId, versionId, inputAgentVersion=inputAgentVersion)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AgentApi->updateAgentVersion: %s\n" % e)
extern crate AgentApi;

pub fn main() {
    let agentId = 56; // Integer
    let versionId = 56; // Integer
    let inputAgentVersion = ; // array[InputAgentVersion]

    let mut context = AgentApi::Context::default();
    let result = client.updateAgentVersion(agentId, versionId, inputAgentVersion, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
agent_id*
Integer (int32)
ID of the agent
Required
version_id*
Integer (int32)
ID of the agent version
Required
Body parameters
Name Description
inputAgentVersion

Responses


Attempts

addAgentVersionAttempts

AgentVersionAttempts endpoint: Add an agent version attempt


/api/agents/{agent_id}/versions/{version_id}/attempts

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:3000/api/agents/{agent_id}/versions/{version_id}/attempts" \
 -d '{
  "duration" : "00:05:00",
  "max_score" : 28400,
  "first_score" : 24900,
  "count_attempts" : 20,
  "time_until_max_score" : "00:01:34",
  "time_until_first_score" : "00:00:20",
  "attempts_until_first_score" : 0,
  "attempts_until_max_score" : 5
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AttemptsApi;

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

public class AttemptsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        AttemptsApi apiInstance = new AttemptsApi();
        Integer agentId = 56; // Integer | ID of the agent
        Integer versionId = 56; // Integer | ID of the agent version
        InputAgentVersionAttempt inputAgentVersionAttempt = ; // InputAgentVersionAttempt | 

        try {
            array[AgentVersionAttempt] result = apiInstance.addAgentVersionAttempts(agentId, versionId, inputAgentVersionAttempt);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttemptsApi#addAgentVersionAttempts");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AttemptsApi;

public class AttemptsApiExample {
    public static void main(String[] args) {
        AttemptsApi apiInstance = new AttemptsApi();
        Integer agentId = 56; // Integer | ID of the agent
        Integer versionId = 56; // Integer | ID of the agent version
        InputAgentVersionAttempt inputAgentVersionAttempt = ; // InputAgentVersionAttempt | 

        try {
            array[AgentVersionAttempt] result = apiInstance.addAgentVersionAttempts(agentId, versionId, inputAgentVersionAttempt);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttemptsApi#addAgentVersionAttempts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
AttemptsApi *apiInstance = [[AttemptsApi alloc] init];
Integer *agentId = 56; // ID of the agent (default to null)
Integer *versionId = 56; // ID of the agent version (default to null)
InputAgentVersionAttempt *inputAgentVersionAttempt = ; //  (optional)

// AgentVersionAttempts endpoint: Add an agent version attempt
[apiInstance addAgentVersionAttemptsWith:agentId
    versionId:versionId
    inputAgentVersionAttempt:inputAgentVersionAttempt
              completionHandler: ^(array[AgentVersionAttempt] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var BamBirds = require('bam_birds');
var defaultClient = BamBirds.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new BamBirds.AttemptsApi()
var agentId = 56; // {Integer} ID of the agent
var versionId = 56; // {Integer} ID of the agent version
var opts = {
  'inputAgentVersionAttempt':  // {InputAgentVersionAttempt} 
};

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

namespace Example
{
    public class addAgentVersionAttemptsExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new AttemptsApi();
            var agentId = 56;  // Integer | ID of the agent (default to null)
            var versionId = 56;  // Integer | ID of the agent version (default to null)
            var inputAgentVersionAttempt = new InputAgentVersionAttempt(); // InputAgentVersionAttempt |  (optional) 

            try {
                // AgentVersionAttempts endpoint: Add an agent version attempt
                array[AgentVersionAttempt] result = apiInstance.addAgentVersionAttempts(agentId, versionId, inputAgentVersionAttempt);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AttemptsApi.addAgentVersionAttempts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AttemptsApi();
$agentId = 56; // Integer | ID of the agent
$versionId = 56; // Integer | ID of the agent version
$inputAgentVersionAttempt = ; // InputAgentVersionAttempt | 

try {
    $result = $api_instance->addAgentVersionAttempts($agentId, $versionId, $inputAgentVersionAttempt);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AttemptsApi->addAgentVersionAttempts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AttemptsApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AttemptsApi->new();
my $agentId = 56; # Integer | ID of the agent
my $versionId = 56; # Integer | ID of the agent version
my $inputAgentVersionAttempt = WWW::OPenAPIClient::Object::InputAgentVersionAttempt->new(); # InputAgentVersionAttempt | 

eval {
    my $result = $api_instance->addAgentVersionAttempts(agentId => $agentId, versionId => $versionId, inputAgentVersionAttempt => $inputAgentVersionAttempt);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AttemptsApi->addAgentVersionAttempts: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AttemptsApi()
agentId = 56 # Integer | ID of the agent (default to null)
versionId = 56 # Integer | ID of the agent version (default to null)
inputAgentVersionAttempt =  # InputAgentVersionAttempt |  (optional)

try:
    # AgentVersionAttempts endpoint: Add an agent version attempt
    api_response = api_instance.add_agent_version_attempts(agentId, versionId, inputAgentVersionAttempt=inputAgentVersionAttempt)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AttemptsApi->addAgentVersionAttempts: %s\n" % e)
extern crate AttemptsApi;

pub fn main() {
    let agentId = 56; // Integer
    let versionId = 56; // Integer
    let inputAgentVersionAttempt = ; // InputAgentVersionAttempt

    let mut context = AttemptsApi::Context::default();
    let result = client.addAgentVersionAttempts(agentId, versionId, inputAgentVersionAttempt, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
agent_id*
Integer (int32)
ID of the agent
Required
version_id*
Integer (int32)
ID of the agent version
Required
Body parameters
Name Description
inputAgentVersionAttempt

Responses


evaluationState

Evaluation endpoint: Get current evaluation states


/api/evaluation-state

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "http://localhost:3000/api/evaluation-state?agent.name=agentPeriodname_example&agent.id=56&agent_version.type=agentVersionPeriodtype_example&offset=56&limit=56&page=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AttemptsApi;

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

public class AttemptsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        AttemptsApi apiInstance = new AttemptsApi();
        String agentPeriodname = agentPeriodname_example; // String | Return only versions from this agent
        Integer agentPeriodid = 56; // Integer | Return only versions from this agent (by id)
        String agentVersionPeriodtype = agentVersionPeriodtype_example; // String | Return only versions of a specific type
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return
        Integer page = 56; // Integer | The page to return (takes precedence over offset)

        try {
            array[EvaluationState] result = apiInstance.evaluationState(agentPeriodname, agentPeriodid, agentVersionPeriodtype, offset, limit, page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttemptsApi#evaluationState");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AttemptsApi;

public class AttemptsApiExample {
    public static void main(String[] args) {
        AttemptsApi apiInstance = new AttemptsApi();
        String agentPeriodname = agentPeriodname_example; // String | Return only versions from this agent
        Integer agentPeriodid = 56; // Integer | Return only versions from this agent (by id)
        String agentVersionPeriodtype = agentVersionPeriodtype_example; // String | Return only versions of a specific type
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return
        Integer page = 56; // Integer | The page to return (takes precedence over offset)

        try {
            array[EvaluationState] result = apiInstance.evaluationState(agentPeriodname, agentPeriodid, agentVersionPeriodtype, offset, limit, page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttemptsApi#evaluationState");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
AttemptsApi *apiInstance = [[AttemptsApi alloc] init];
String *agentPeriodname = agentPeriodname_example; // Return only versions from this agent (optional) (default to null)
Integer *agentPeriodid = 56; // Return only versions from this agent (by id) (optional) (default to null)
String *agentVersionPeriodtype = agentVersionPeriodtype_example; // Return only versions of a specific type (optional) (default to null)
Integer *offset = 56; // The number of items to skip before starting to collect the result set (optional) (default to null)
Integer *limit = 56; // The numbers of items to return (optional) (default to null)
Integer *page = 56; // The page to return (takes precedence over offset) (optional) (default to null)

// Evaluation endpoint: Get current evaluation states
[apiInstance evaluationStateWith:agentPeriodname
    agentPeriodid:agentPeriodid
    agentVersionPeriodtype:agentVersionPeriodtype
    offset:offset
    limit:limit
    page:page
              completionHandler: ^(array[EvaluationState] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var BamBirds = require('bam_birds');
var defaultClient = BamBirds.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new BamBirds.AttemptsApi()
var opts = {
  'agentPeriodname': agentPeriodname_example, // {String} Return only versions from this agent
  'agentPeriodid': 56, // {Integer} Return only versions from this agent (by id)
  'agentVersionPeriodtype': agentVersionPeriodtype_example, // {String} Return only versions of a specific type
  'offset': 56, // {Integer} The number of items to skip before starting to collect the result set
  'limit': 56, // {Integer} The numbers of items to return
  'page': 56 // {Integer} The page to return (takes precedence over offset)
};

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

namespace Example
{
    public class evaluationStateExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new AttemptsApi();
            var agentPeriodname = agentPeriodname_example;  // String | Return only versions from this agent (optional)  (default to null)
            var agentPeriodid = 56;  // Integer | Return only versions from this agent (by id) (optional)  (default to null)
            var agentVersionPeriodtype = agentVersionPeriodtype_example;  // String | Return only versions of a specific type (optional)  (default to null)
            var offset = 56;  // Integer | The number of items to skip before starting to collect the result set (optional)  (default to null)
            var limit = 56;  // Integer | The numbers of items to return (optional)  (default to null)
            var page = 56;  // Integer | The page to return (takes precedence over offset) (optional)  (default to null)

            try {
                // Evaluation endpoint: Get current evaluation states
                array[EvaluationState] result = apiInstance.evaluationState(agentPeriodname, agentPeriodid, agentVersionPeriodtype, offset, limit, page);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AttemptsApi.evaluationState: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AttemptsApi();
$agentPeriodname = agentPeriodname_example; // String | Return only versions from this agent
$agentPeriodid = 56; // Integer | Return only versions from this agent (by id)
$agentVersionPeriodtype = agentVersionPeriodtype_example; // String | Return only versions of a specific type
$offset = 56; // Integer | The number of items to skip before starting to collect the result set
$limit = 56; // Integer | The numbers of items to return
$page = 56; // Integer | The page to return (takes precedence over offset)

try {
    $result = $api_instance->evaluationState($agentPeriodname, $agentPeriodid, $agentVersionPeriodtype, $offset, $limit, $page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AttemptsApi->evaluationState: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AttemptsApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AttemptsApi->new();
my $agentPeriodname = agentPeriodname_example; # String | Return only versions from this agent
my $agentPeriodid = 56; # Integer | Return only versions from this agent (by id)
my $agentVersionPeriodtype = agentVersionPeriodtype_example; # String | Return only versions of a specific type
my $offset = 56; # Integer | The number of items to skip before starting to collect the result set
my $limit = 56; # Integer | The numbers of items to return
my $page = 56; # Integer | The page to return (takes precedence over offset)

eval {
    my $result = $api_instance->evaluationState(agentPeriodname => $agentPeriodname, agentPeriodid => $agentPeriodid, agentVersionPeriodtype => $agentVersionPeriodtype, offset => $offset, limit => $limit, page => $page);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AttemptsApi->evaluationState: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AttemptsApi()
agentPeriodname = agentPeriodname_example # String | Return only versions from this agent (optional) (default to null)
agentPeriodid = 56 # Integer | Return only versions from this agent (by id) (optional) (default to null)
agentVersionPeriodtype = agentVersionPeriodtype_example # String | Return only versions of a specific type (optional) (default to null)
offset = 56 # Integer | The number of items to skip before starting to collect the result set (optional) (default to null)
limit = 56 # Integer | The numbers of items to return (optional) (default to null)
page = 56 # Integer | The page to return (takes precedence over offset) (optional) (default to null)

try:
    # Evaluation endpoint: Get current evaluation states
    api_response = api_instance.evaluation_state(agentPeriodname=agentPeriodname, agentPeriodid=agentPeriodid, agentVersionPeriodtype=agentVersionPeriodtype, offset=offset, limit=limit, page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AttemptsApi->evaluationState: %s\n" % e)
extern crate AttemptsApi;

pub fn main() {
    let agentPeriodname = agentPeriodname_example; // String
    let agentPeriodid = 56; // Integer
    let agentVersionPeriodtype = agentVersionPeriodtype_example; // String
    let offset = 56; // Integer
    let limit = 56; // Integer
    let page = 56; // Integer

    let mut context = AttemptsApi::Context::default();
    let result = client.evaluationState(agentPeriodname, agentPeriodid, agentVersionPeriodtype, offset, limit, page, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
agent.name
String
Return only versions from this agent
agent.id
Integer
Return only versions from this agent (by id)
agent_version.type
String
Return only versions of a specific type
offset
Integer
The number of items to skip before starting to collect the result set
limit
Integer
The numbers of items to return
page
Integer
The page to return (takes precedence over offset)

Responses

Name Type Format Description
xMinusnext String A link to the next page of responses


listAgentVersionAttempts

AgentVersionAttempts endpoint: Returns all attempts by the agent version


/api/agents/{agent_id}/versions/{version_id}/attempts

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "http://localhost:3000/api/agents/{agent_id}/versions/{version_id}/attempts?offset=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AttemptsApi;

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

public class AttemptsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        AttemptsApi apiInstance = new AttemptsApi();
        Integer agentId = 56; // Integer | ID of the agent
        Integer versionId = 56; // Integer | ID of the agent version
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return

        try {
            array[AgentVersionAttempt] result = apiInstance.listAgentVersionAttempts(agentId, versionId, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttemptsApi#listAgentVersionAttempts");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AttemptsApi;

public class AttemptsApiExample {
    public static void main(String[] args) {
        AttemptsApi apiInstance = new AttemptsApi();
        Integer agentId = 56; // Integer | ID of the agent
        Integer versionId = 56; // Integer | ID of the agent version
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return

        try {
            array[AgentVersionAttempt] result = apiInstance.listAgentVersionAttempts(agentId, versionId, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttemptsApi#listAgentVersionAttempts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
AttemptsApi *apiInstance = [[AttemptsApi alloc] init];
Integer *agentId = 56; // ID of the agent (default to null)
Integer *versionId = 56; // ID of the agent version (default to null)
Integer *offset = 56; // The number of items to skip before starting to collect the result set (optional) (default to null)
Integer *limit = 56; // The numbers of items to return (optional) (default to null)

// AgentVersionAttempts endpoint: Returns all attempts by the agent version
[apiInstance listAgentVersionAttemptsWith:agentId
    versionId:versionId
    offset:offset
    limit:limit
              completionHandler: ^(array[AgentVersionAttempt] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var BamBirds = require('bam_birds');
var defaultClient = BamBirds.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new BamBirds.AttemptsApi()
var agentId = 56; // {Integer} ID of the agent
var versionId = 56; // {Integer} ID of the agent version
var opts = {
  'offset': 56, // {Integer} The number of items to skip before starting to collect the result set
  'limit': 56 // {Integer} The numbers of items to return
};

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

namespace Example
{
    public class listAgentVersionAttemptsExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new AttemptsApi();
            var agentId = 56;  // Integer | ID of the agent (default to null)
            var versionId = 56;  // Integer | ID of the agent version (default to null)
            var offset = 56;  // Integer | The number of items to skip before starting to collect the result set (optional)  (default to null)
            var limit = 56;  // Integer | The numbers of items to return (optional)  (default to null)

            try {
                // AgentVersionAttempts endpoint: Returns all attempts by the agent version
                array[AgentVersionAttempt] result = apiInstance.listAgentVersionAttempts(agentId, versionId, offset, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AttemptsApi.listAgentVersionAttempts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AttemptsApi();
$agentId = 56; // Integer | ID of the agent
$versionId = 56; // Integer | ID of the agent version
$offset = 56; // Integer | The number of items to skip before starting to collect the result set
$limit = 56; // Integer | The numbers of items to return

try {
    $result = $api_instance->listAgentVersionAttempts($agentId, $versionId, $offset, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AttemptsApi->listAgentVersionAttempts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AttemptsApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AttemptsApi->new();
my $agentId = 56; # Integer | ID of the agent
my $versionId = 56; # Integer | ID of the agent version
my $offset = 56; # Integer | The number of items to skip before starting to collect the result set
my $limit = 56; # Integer | The numbers of items to return

eval {
    my $result = $api_instance->listAgentVersionAttempts(agentId => $agentId, versionId => $versionId, offset => $offset, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AttemptsApi->listAgentVersionAttempts: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AttemptsApi()
agentId = 56 # Integer | ID of the agent (default to null)
versionId = 56 # Integer | ID of the agent version (default to null)
offset = 56 # Integer | The number of items to skip before starting to collect the result set (optional) (default to null)
limit = 56 # Integer | The numbers of items to return (optional) (default to null)

try:
    # AgentVersionAttempts endpoint: Returns all attempts by the agent version
    api_response = api_instance.list_agent_version_attempts(agentId, versionId, offset=offset, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AttemptsApi->listAgentVersionAttempts: %s\n" % e)
extern crate AttemptsApi;

pub fn main() {
    let agentId = 56; // Integer
    let versionId = 56; // Integer
    let offset = 56; // Integer
    let limit = 56; // Integer

    let mut context = AttemptsApi::Context::default();
    let result = client.listAgentVersionAttempts(agentId, versionId, offset, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
agent_id*
Integer (int32)
ID of the agent
Required
version_id*
Integer (int32)
ID of the agent version
Required
Query parameters
Name Description
offset
Integer
The number of items to skip before starting to collect the result set
limit
Integer
The numbers of items to return

Responses


Difficulty

addDifficulty

Difficulty endpoint: Add a difficulty


/api/difficulties

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:3000/api/difficulties" \
 -d '{
  "slug" : "bluebird",
  "description" : "Use blue bird"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DifficultyApi;

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

public class DifficultyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        DifficultyApi apiInstance = new DifficultyApi();
        InputDifficulty inputDifficulty = ; // InputDifficulty | 

        try {
            Difficulty result = apiInstance.addDifficulty(inputDifficulty);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DifficultyApi#addDifficulty");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DifficultyApi;

public class DifficultyApiExample {
    public static void main(String[] args) {
        DifficultyApi apiInstance = new DifficultyApi();
        InputDifficulty inputDifficulty = ; // InputDifficulty | 

        try {
            Difficulty result = apiInstance.addDifficulty(inputDifficulty);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DifficultyApi#addDifficulty");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
DifficultyApi *apiInstance = [[DifficultyApi alloc] init];
InputDifficulty *inputDifficulty = ; //  (optional)

// Difficulty endpoint: Add a difficulty
[apiInstance addDifficultyWith:inputDifficulty
              completionHandler: ^(Difficulty output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var BamBirds = require('bam_birds');
var defaultClient = BamBirds.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new BamBirds.DifficultyApi()
var opts = {
  'inputDifficulty':  // {InputDifficulty} 
};

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

namespace Example
{
    public class addDifficultyExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DifficultyApi();
            var inputDifficulty = new InputDifficulty(); // InputDifficulty |  (optional) 

            try {
                // Difficulty endpoint: Add a difficulty
                Difficulty result = apiInstance.addDifficulty(inputDifficulty);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DifficultyApi.addDifficulty: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DifficultyApi();
$inputDifficulty = ; // InputDifficulty | 

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DifficultyApi->new();
my $inputDifficulty = WWW::OPenAPIClient::Object::InputDifficulty->new(); # InputDifficulty | 

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DifficultyApi()
inputDifficulty =  # InputDifficulty |  (optional)

try:
    # Difficulty endpoint: Add a difficulty
    api_response = api_instance.add_difficulty(inputDifficulty=inputDifficulty)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DifficultyApi->addDifficulty: %s\n" % e)
extern crate DifficultyApi;

pub fn main() {
    let inputDifficulty = ; // InputDifficulty

    let mut context = DifficultyApi::Context::default();
    let result = client.addDifficulty(inputDifficulty, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
inputDifficulty

Responses


deleteDifficulty

Difficulty endpoint: delete a difficulty


/api/difficulties/{id}

Usage and SDK Samples

curl -X DELETE \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "http://localhost:3000/api/difficulties/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DifficultyApi;

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

public class DifficultyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        DifficultyApi apiInstance = new DifficultyApi();
        Integer id = 56; // Integer | ID of the difficulty

        try {
            Difficulty result = apiInstance.deleteDifficulty(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DifficultyApi#deleteDifficulty");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DifficultyApi;

public class DifficultyApiExample {
    public static void main(String[] args) {
        DifficultyApi apiInstance = new DifficultyApi();
        Integer id = 56; // Integer | ID of the difficulty

        try {
            Difficulty result = apiInstance.deleteDifficulty(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DifficultyApi#deleteDifficulty");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
DifficultyApi *apiInstance = [[DifficultyApi alloc] init];
Integer *id = 56; // ID of the difficulty (default to null)

// Difficulty endpoint: delete a difficulty
[apiInstance deleteDifficultyWith:id
              completionHandler: ^(Difficulty output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var BamBirds = require('bam_birds');
var defaultClient = BamBirds.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new BamBirds.DifficultyApi()
var id = 56; // {Integer} ID of the difficulty

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

namespace Example
{
    public class deleteDifficultyExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DifficultyApi();
            var id = 56;  // Integer | ID of the difficulty (default to null)

            try {
                // Difficulty endpoint: delete a difficulty
                Difficulty result = apiInstance.deleteDifficulty(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DifficultyApi.deleteDifficulty: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DifficultyApi();
$id = 56; // Integer | ID of the difficulty

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DifficultyApi->new();
my $id = 56; # Integer | ID of the difficulty

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DifficultyApi()
id = 56 # Integer | ID of the difficulty (default to null)

try:
    # Difficulty endpoint: delete a difficulty
    api_response = api_instance.delete_difficulty(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DifficultyApi->deleteDifficulty: %s\n" % e)
extern crate DifficultyApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = DifficultyApi::Context::default();
    let result = client.deleteDifficulty(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
ID of the difficulty
Required

Responses


getDifficulty

Difficulty endpoint: Returns details about a difficulty


/api/difficulties/{id}

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "http://localhost:3000/api/difficulties/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DifficultyApi;

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

public class DifficultyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        DifficultyApi apiInstance = new DifficultyApi();
        Integer id = 56; // Integer | ID of the difficulty

        try {
            Difficulty result = apiInstance.getDifficulty(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DifficultyApi#getDifficulty");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DifficultyApi;

public class DifficultyApiExample {
    public static void main(String[] args) {
        DifficultyApi apiInstance = new DifficultyApi();
        Integer id = 56; // Integer | ID of the difficulty

        try {
            Difficulty result = apiInstance.getDifficulty(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DifficultyApi#getDifficulty");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
DifficultyApi *apiInstance = [[DifficultyApi alloc] init];
Integer *id = 56; // ID of the difficulty (default to null)

// Difficulty endpoint: Returns details about a difficulty
[apiInstance getDifficultyWith:id
              completionHandler: ^(Difficulty output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var BamBirds = require('bam_birds');
var defaultClient = BamBirds.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new BamBirds.DifficultyApi()
var id = 56; // {Integer} ID of the difficulty

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

namespace Example
{
    public class getDifficultyExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DifficultyApi();
            var id = 56;  // Integer | ID of the difficulty (default to null)

            try {
                // Difficulty endpoint: Returns details about a difficulty
                Difficulty result = apiInstance.getDifficulty(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DifficultyApi.getDifficulty: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DifficultyApi();
$id = 56; // Integer | ID of the difficulty

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DifficultyApi->new();
my $id = 56; # Integer | ID of the difficulty

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DifficultyApi()
id = 56 # Integer | ID of the difficulty (default to null)

try:
    # Difficulty endpoint: Returns details about a difficulty
    api_response = api_instance.get_difficulty(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DifficultyApi->getDifficulty: %s\n" % e)
extern crate DifficultyApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = DifficultyApi::Context::default();
    let result = client.getDifficulty(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
ID of the difficulty
Required

Responses


listDifficulties

Difficulty endpoint: Get all difficulties


/api/difficulties

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "http://localhost:3000/api/difficulties"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DifficultyApi;

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

public class DifficultyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        DifficultyApi apiInstance = new DifficultyApi();

        try {
            array[Difficulty] result = apiInstance.listDifficulties();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DifficultyApi#listDifficulties");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DifficultyApi;

public class DifficultyApiExample {
    public static void main(String[] args) {
        DifficultyApi apiInstance = new DifficultyApi();

        try {
            array[Difficulty] result = apiInstance.listDifficulties();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DifficultyApi#listDifficulties");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
DifficultyApi *apiInstance = [[DifficultyApi alloc] init];

// Difficulty endpoint: Get all difficulties
[apiInstance listDifficultiesWithCompletionHandler: 
              ^(array[Difficulty] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var BamBirds = require('bam_birds');
var defaultClient = BamBirds.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new BamBirds.DifficultyApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listDifficulties(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listDifficultiesExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DifficultyApi();

            try {
                // Difficulty endpoint: Get all difficulties
                array[Difficulty] result = apiInstance.listDifficulties();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DifficultyApi.listDifficulties: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DifficultyApi();

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DifficultyApi->new();

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DifficultyApi()

try:
    # Difficulty endpoint: Get all difficulties
    api_response = api_instance.list_difficulties()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DifficultyApi->listDifficulties: %s\n" % e)
extern crate DifficultyApi;

pub fn main() {

    let mut context = DifficultyApi::Context::default();
    let result = client.listDifficulties(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


listLevelDifficulties

Level endpoint: Returns all difficulties of the level


/api/levels/{id}/difficulties

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "http://localhost:3000/api/levels/{id}/difficulties"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DifficultyApi;

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

public class DifficultyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        DifficultyApi apiInstance = new DifficultyApi();
        Integer id = 56; // Integer | ID of the level

        try {
            array[DifficultyConnection] result = apiInstance.listLevelDifficulties(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DifficultyApi#listLevelDifficulties");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DifficultyApi;

public class DifficultyApiExample {
    public static void main(String[] args) {
        DifficultyApi apiInstance = new DifficultyApi();
        Integer id = 56; // Integer | ID of the level

        try {
            array[DifficultyConnection] result = apiInstance.listLevelDifficulties(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DifficultyApi#listLevelDifficulties");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
DifficultyApi *apiInstance = [[DifficultyApi alloc] init];
Integer *id = 56; // ID of the level (default to null)

// Level endpoint: Returns all difficulties of the level
[apiInstance listLevelDifficultiesWith:id
              completionHandler: ^(array[DifficultyConnection] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var BamBirds = require('bam_birds');
var defaultClient = BamBirds.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new BamBirds.DifficultyApi()
var id = 56; // {Integer} ID of the level

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

namespace Example
{
    public class listLevelDifficultiesExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DifficultyApi();
            var id = 56;  // Integer | ID of the level (default to null)

            try {
                // Level endpoint: Returns all difficulties of the level
                array[DifficultyConnection] result = apiInstance.listLevelDifficulties(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DifficultyApi.listLevelDifficulties: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DifficultyApi();
$id = 56; // Integer | ID of the level

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DifficultyApi->new();
my $id = 56; # Integer | ID of the level

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DifficultyApi()
id = 56 # Integer | ID of the level (default to null)

try:
    # Level endpoint: Returns all difficulties of the level
    api_response = api_instance.list_level_difficulties(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DifficultyApi->listLevelDifficulties: %s\n" % e)
extern crate DifficultyApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = DifficultyApi::Context::default();
    let result = client.listLevelDifficulties(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
ID of the level
Required

Responses


updateDifficulty

Difficulty endpoint: Update difficulty info


/api/difficulties/{id}

Usage and SDK Samples

curl -X PUT \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:3000/api/difficulties/{id}" \
 -d '{
  "slug" : "bluebird",
  "description" : "Use blue bird"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DifficultyApi;

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

public class DifficultyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        DifficultyApi apiInstance = new DifficultyApi();
        Integer id = 56; // Integer | ID of the difficulty
        InputDifficulty inputDifficulty = ; // InputDifficulty | 

        try {
            Difficulty result = apiInstance.updateDifficulty(id, inputDifficulty);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DifficultyApi#updateDifficulty");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DifficultyApi;

public class DifficultyApiExample {
    public static void main(String[] args) {
        DifficultyApi apiInstance = new DifficultyApi();
        Integer id = 56; // Integer | ID of the difficulty
        InputDifficulty inputDifficulty = ; // InputDifficulty | 

        try {
            Difficulty result = apiInstance.updateDifficulty(id, inputDifficulty);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DifficultyApi#updateDifficulty");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
DifficultyApi *apiInstance = [[DifficultyApi alloc] init];
Integer *id = 56; // ID of the difficulty (default to null)
InputDifficulty *inputDifficulty = ; //  (optional)

// Difficulty endpoint: Update difficulty info
[apiInstance updateDifficultyWith:id
    inputDifficulty:inputDifficulty
              completionHandler: ^(Difficulty output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var BamBirds = require('bam_birds');
var defaultClient = BamBirds.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new BamBirds.DifficultyApi()
var id = 56; // {Integer} ID of the difficulty
var opts = {
  'inputDifficulty':  // {InputDifficulty} 
};

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

namespace Example
{
    public class updateDifficultyExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DifficultyApi();
            var id = 56;  // Integer | ID of the difficulty (default to null)
            var inputDifficulty = new InputDifficulty(); // InputDifficulty |  (optional) 

            try {
                // Difficulty endpoint: Update difficulty info
                Difficulty result = apiInstance.updateDifficulty(id, inputDifficulty);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DifficultyApi.updateDifficulty: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DifficultyApi();
$id = 56; // Integer | ID of the difficulty
$inputDifficulty = ; // InputDifficulty | 

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DifficultyApi->new();
my $id = 56; # Integer | ID of the difficulty
my $inputDifficulty = WWW::OPenAPIClient::Object::InputDifficulty->new(); # InputDifficulty | 

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DifficultyApi()
id = 56 # Integer | ID of the difficulty (default to null)
inputDifficulty =  # InputDifficulty |  (optional)

try:
    # Difficulty endpoint: Update difficulty info
    api_response = api_instance.update_difficulty(id, inputDifficulty=inputDifficulty)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DifficultyApi->updateDifficulty: %s\n" % e)
extern crate DifficultyApi;

pub fn main() {
    let id = 56; // Integer
    let inputDifficulty = ; // InputDifficulty

    let mut context = DifficultyApi::Context::default();
    let result = client.updateDifficulty(id, inputDifficulty, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
ID of the difficulty
Required
Body parameters
Name Description
inputDifficulty

Responses


Evaluation

evaluationState

Evaluation endpoint: Get current evaluation states


/api/evaluation-state

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "http://localhost:3000/api/evaluation-state?agent.name=agentPeriodname_example&agent.id=56&agent_version.type=agentVersionPeriodtype_example&offset=56&limit=56&page=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EvaluationApi;

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

public class EvaluationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        EvaluationApi apiInstance = new EvaluationApi();
        String agentPeriodname = agentPeriodname_example; // String | Return only versions from this agent
        Integer agentPeriodid = 56; // Integer | Return only versions from this agent (by id)
        String agentVersionPeriodtype = agentVersionPeriodtype_example; // String | Return only versions of a specific type
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return
        Integer page = 56; // Integer | The page to return (takes precedence over offset)

        try {
            array[EvaluationState] result = apiInstance.evaluationState(agentPeriodname, agentPeriodid, agentVersionPeriodtype, offset, limit, page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EvaluationApi#evaluationState");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.EvaluationApi;

public class EvaluationApiExample {
    public static void main(String[] args) {
        EvaluationApi apiInstance = new EvaluationApi();
        String agentPeriodname = agentPeriodname_example; // String | Return only versions from this agent
        Integer agentPeriodid = 56; // Integer | Return only versions from this agent (by id)
        String agentVersionPeriodtype = agentVersionPeriodtype_example; // String | Return only versions of a specific type
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return
        Integer page = 56; // Integer | The page to return (takes precedence over offset)

        try {
            array[EvaluationState] result = apiInstance.evaluationState(agentPeriodname, agentPeriodid, agentVersionPeriodtype, offset, limit, page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EvaluationApi#evaluationState");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
EvaluationApi *apiInstance = [[EvaluationApi alloc] init];
String *agentPeriodname = agentPeriodname_example; // Return only versions from this agent (optional) (default to null)
Integer *agentPeriodid = 56; // Return only versions from this agent (by id) (optional) (default to null)
String *agentVersionPeriodtype = agentVersionPeriodtype_example; // Return only versions of a specific type (optional) (default to null)
Integer *offset = 56; // The number of items to skip before starting to collect the result set (optional) (default to null)
Integer *limit = 56; // The numbers of items to return (optional) (default to null)
Integer *page = 56; // The page to return (takes precedence over offset) (optional) (default to null)

// Evaluation endpoint: Get current evaluation states
[apiInstance evaluationStateWith:agentPeriodname
    agentPeriodid:agentPeriodid
    agentVersionPeriodtype:agentVersionPeriodtype
    offset:offset
    limit:limit
    page:page
              completionHandler: ^(array[EvaluationState] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var BamBirds = require('bam_birds');
var defaultClient = BamBirds.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new BamBirds.EvaluationApi()
var opts = {
  'agentPeriodname': agentPeriodname_example, // {String} Return only versions from this agent
  'agentPeriodid': 56, // {Integer} Return only versions from this agent (by id)
  'agentVersionPeriodtype': agentVersionPeriodtype_example, // {String} Return only versions of a specific type
  'offset': 56, // {Integer} The number of items to skip before starting to collect the result set
  'limit': 56, // {Integer} The numbers of items to return
  'page': 56 // {Integer} The page to return (takes precedence over offset)
};

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

namespace Example
{
    public class evaluationStateExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new EvaluationApi();
            var agentPeriodname = agentPeriodname_example;  // String | Return only versions from this agent (optional)  (default to null)
            var agentPeriodid = 56;  // Integer | Return only versions from this agent (by id) (optional)  (default to null)
            var agentVersionPeriodtype = agentVersionPeriodtype_example;  // String | Return only versions of a specific type (optional)  (default to null)
            var offset = 56;  // Integer | The number of items to skip before starting to collect the result set (optional)  (default to null)
            var limit = 56;  // Integer | The numbers of items to return (optional)  (default to null)
            var page = 56;  // Integer | The page to return (takes precedence over offset) (optional)  (default to null)

            try {
                // Evaluation endpoint: Get current evaluation states
                array[EvaluationState] result = apiInstance.evaluationState(agentPeriodname, agentPeriodid, agentVersionPeriodtype, offset, limit, page);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EvaluationApi.evaluationState: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EvaluationApi();
$agentPeriodname = agentPeriodname_example; // String | Return only versions from this agent
$agentPeriodid = 56; // Integer | Return only versions from this agent (by id)
$agentVersionPeriodtype = agentVersionPeriodtype_example; // String | Return only versions of a specific type
$offset = 56; // Integer | The number of items to skip before starting to collect the result set
$limit = 56; // Integer | The numbers of items to return
$page = 56; // Integer | The page to return (takes precedence over offset)

try {
    $result = $api_instance->evaluationState($agentPeriodname, $agentPeriodid, $agentVersionPeriodtype, $offset, $limit, $page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EvaluationApi->evaluationState: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EvaluationApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EvaluationApi->new();
my $agentPeriodname = agentPeriodname_example; # String | Return only versions from this agent
my $agentPeriodid = 56; # Integer | Return only versions from this agent (by id)
my $agentVersionPeriodtype = agentVersionPeriodtype_example; # String | Return only versions of a specific type
my $offset = 56; # Integer | The number of items to skip before starting to collect the result set
my $limit = 56; # Integer | The numbers of items to return
my $page = 56; # Integer | The page to return (takes precedence over offset)

eval {
    my $result = $api_instance->evaluationState(agentPeriodname => $agentPeriodname, agentPeriodid => $agentPeriodid, agentVersionPeriodtype => $agentVersionPeriodtype, offset => $offset, limit => $limit, page => $page);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EvaluationApi->evaluationState: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.EvaluationApi()
agentPeriodname = agentPeriodname_example # String | Return only versions from this agent (optional) (default to null)
agentPeriodid = 56 # Integer | Return only versions from this agent (by id) (optional) (default to null)
agentVersionPeriodtype = agentVersionPeriodtype_example # String | Return only versions of a specific type (optional) (default to null)
offset = 56 # Integer | The number of items to skip before starting to collect the result set (optional) (default to null)
limit = 56 # Integer | The numbers of items to return (optional) (default to null)
page = 56 # Integer | The page to return (takes precedence over offset) (optional) (default to null)

try:
    # Evaluation endpoint: Get current evaluation states
    api_response = api_instance.evaluation_state(agentPeriodname=agentPeriodname, agentPeriodid=agentPeriodid, agentVersionPeriodtype=agentVersionPeriodtype, offset=offset, limit=limit, page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EvaluationApi->evaluationState: %s\n" % e)
extern crate EvaluationApi;

pub fn main() {
    let agentPeriodname = agentPeriodname_example; // String
    let agentPeriodid = 56; // Integer
    let agentVersionPeriodtype = agentVersionPeriodtype_example; // String
    let offset = 56; // Integer
    let limit = 56; // Integer
    let page = 56; // Integer

    let mut context = EvaluationApi::Context::default();
    let result = client.evaluationState(agentPeriodname, agentPeriodid, agentVersionPeriodtype, offset, limit, page, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
agent.name
String
Return only versions from this agent
agent.id
Integer
Return only versions from this agent (by id)
agent_version.type
String
Return only versions of a specific type
offset
Integer
The number of items to skip before starting to collect the result set
limit
Integer
The numbers of items to return
page
Integer
The page to return (takes precedence over offset)

Responses

Name Type Format Description
xMinusnext String A link to the next page of responses


Level

addLevel

Level endpoint: Add level


/api/levels

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,multipart/form-data" \
 "http://localhost:3000/api/levels" \
 -d '{
  "sciencebirds_file" : "sciencebirds_file",
  "source" : "source",
  "high_score" : 0,
  "chrome_file" : "{}"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LevelApi;

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

public class LevelApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        LevelApi apiInstance = new LevelApi();
        InputLevel inputLevel = ; // InputLevel | 

        try {
            Level result = apiInstance.addLevel(inputLevel);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LevelApi#addLevel");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LevelApi;

public class LevelApiExample {
    public static void main(String[] args) {
        LevelApi apiInstance = new LevelApi();
        InputLevel inputLevel = ; // InputLevel | 

        try {
            Level result = apiInstance.addLevel(inputLevel);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LevelApi#addLevel");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
LevelApi *apiInstance = [[LevelApi alloc] init];
InputLevel *inputLevel = ; //  (optional)

// Level endpoint: Add level
[apiInstance addLevelWith:inputLevel
              completionHandler: ^(Level output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var BamBirds = require('bam_birds');
var defaultClient = BamBirds.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new BamBirds.LevelApi()
var opts = {
  'inputLevel':  // {InputLevel} 
};

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

namespace Example
{
    public class addLevelExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new LevelApi();
            var inputLevel = new InputLevel(); // InputLevel |  (optional) 

            try {
                // Level endpoint: Add level
                Level result = apiInstance.addLevel(inputLevel);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling LevelApi.addLevel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\LevelApi();
$inputLevel = ; // InputLevel | 

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::LevelApi->new();
my $inputLevel = WWW::OPenAPIClient::Object::InputLevel->new(); # InputLevel | 

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.LevelApi()
inputLevel =  # InputLevel |  (optional)

try:
    # Level endpoint: Add level
    api_response = api_instance.add_level(inputLevel=inputLevel)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LevelApi->addLevel: %s\n" % e)
extern crate LevelApi;

pub fn main() {
    let inputLevel = ; // InputLevel

    let mut context = LevelApi::Context::default();
    let result = client.addLevel(inputLevel, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
inputLevel

Responses


addLevelDifficulties

Level endpoint: Add level difficulties


/api/levels/{id}/difficulties

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:3000/api/levels/{id}/difficulties" \
 -d '{
  "difficulty_id" : 34,
  "exists" : true
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LevelApi;

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

public class LevelApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        LevelApi apiInstance = new LevelApi();
        Integer id = 56; // Integer | ID of the level
        array[InputDifficultyConnection] inputDifficultyConnection = ; // array[InputDifficultyConnection] | 

        try {
            array[DifficultyConnection] result = apiInstance.addLevelDifficulties(id, inputDifficultyConnection);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LevelApi#addLevelDifficulties");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LevelApi;

public class LevelApiExample {
    public static void main(String[] args) {
        LevelApi apiInstance = new LevelApi();
        Integer id = 56; // Integer | ID of the level
        array[InputDifficultyConnection] inputDifficultyConnection = ; // array[InputDifficultyConnection] | 

        try {
            array[DifficultyConnection] result = apiInstance.addLevelDifficulties(id, inputDifficultyConnection);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LevelApi#addLevelDifficulties");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
LevelApi *apiInstance = [[LevelApi alloc] init];
Integer *id = 56; // ID of the level (default to null)
array[InputDifficultyConnection] *inputDifficultyConnection = ; //  (optional)

// Level endpoint: Add level difficulties
[apiInstance addLevelDifficultiesWith:id
    inputDifficultyConnection:inputDifficultyConnection
              completionHandler: ^(array[DifficultyConnection] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var BamBirds = require('bam_birds');
var defaultClient = BamBirds.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new BamBirds.LevelApi()
var id = 56; // {Integer} ID of the level
var opts = {
  'inputDifficultyConnection':  // {array[InputDifficultyConnection]} 
};

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

namespace Example
{
    public class addLevelDifficultiesExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new LevelApi();
            var id = 56;  // Integer | ID of the level (default to null)
            var inputDifficultyConnection = new array[InputDifficultyConnection](); // array[InputDifficultyConnection] |  (optional) 

            try {
                // Level endpoint: Add level difficulties
                array[DifficultyConnection] result = apiInstance.addLevelDifficulties(id, inputDifficultyConnection);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling LevelApi.addLevelDifficulties: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\LevelApi();
$id = 56; // Integer | ID of the level
$inputDifficultyConnection = ; // array[InputDifficultyConnection] | 

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::LevelApi->new();
my $id = 56; # Integer | ID of the level
my $inputDifficultyConnection = [WWW::OPenAPIClient::Object::array[InputDifficultyConnection]->new()]; # array[InputDifficultyConnection] | 

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.LevelApi()
id = 56 # Integer | ID of the level (default to null)
inputDifficultyConnection =  # array[InputDifficultyConnection] |  (optional)

try:
    # Level endpoint: Add level difficulties
    api_response = api_instance.add_level_difficulties(id, inputDifficultyConnection=inputDifficultyConnection)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LevelApi->addLevelDifficulties: %s\n" % e)
extern crate LevelApi;

pub fn main() {
    let id = 56; // Integer
    let inputDifficultyConnection = ; // array[InputDifficultyConnection]

    let mut context = LevelApi::Context::default();
    let result = client.addLevelDifficulties(id, inputDifficultyConnection, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
ID of the level
Required
Body parameters
Name Description
inputDifficultyConnection

Responses


deleteLevel

Level endpoint: delete a level


/api/levels/{id}

Usage and SDK Samples

curl -X DELETE \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "http://localhost:3000/api/levels/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LevelApi;

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

public class LevelApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        LevelApi apiInstance = new LevelApi();
        Integer id = 56; // Integer | ID of the level

        try {
            Level result = apiInstance.deleteLevel(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LevelApi#deleteLevel");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LevelApi;

public class LevelApiExample {
    public static void main(String[] args) {
        LevelApi apiInstance = new LevelApi();
        Integer id = 56; // Integer | ID of the level

        try {
            Level result = apiInstance.deleteLevel(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LevelApi#deleteLevel");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
LevelApi *apiInstance = [[LevelApi alloc] init];
Integer *id = 56; // ID of the level (default to null)

// Level endpoint: delete a level
[apiInstance deleteLevelWith:id
              completionHandler: ^(Level output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var BamBirds = require('bam_birds');
var defaultClient = BamBirds.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new BamBirds.LevelApi()
var id = 56; // {Integer} ID of the level

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

namespace Example
{
    public class deleteLevelExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new LevelApi();
            var id = 56;  // Integer | ID of the level (default to null)

            try {
                // Level endpoint: delete a level
                Level result = apiInstance.deleteLevel(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling LevelApi.deleteLevel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\LevelApi();
$id = 56; // Integer | ID of the level

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::LevelApi->new();
my $id = 56; # Integer | ID of the level

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.LevelApi()
id = 56 # Integer | ID of the level (default to null)

try:
    # Level endpoint: delete a level
    api_response = api_instance.delete_level(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LevelApi->deleteLevel: %s\n" % e)
extern crate LevelApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = LevelApi::Context::default();
    let result = client.deleteLevel(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
ID of the level
Required

Responses


deleteLevelDifficulties

Level endpoint: delete level difficulties


/api/levels/{id}/difficulties

Usage and SDK Samples

curl -X DELETE \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:3000/api/levels/{id}/difficulties" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LevelApi;

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

public class LevelApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        LevelApi apiInstance = new LevelApi();
        Integer id = 56; // Integer | ID of the level
        array[Integer] integer = ; // array[Integer] | 

        try {
            array[DifficultyConnection] result = apiInstance.deleteLevelDifficulties(id, integer);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LevelApi#deleteLevelDifficulties");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LevelApi;

public class LevelApiExample {
    public static void main(String[] args) {
        LevelApi apiInstance = new LevelApi();
        Integer id = 56; // Integer | ID of the level
        array[Integer] integer = ; // array[Integer] | 

        try {
            array[DifficultyConnection] result = apiInstance.deleteLevelDifficulties(id, integer);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LevelApi#deleteLevelDifficulties");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
LevelApi *apiInstance = [[LevelApi alloc] init];
Integer *id = 56; // ID of the level (default to null)
array[Integer] *integer = ; //  (optional)

// Level endpoint: delete level difficulties
[apiInstance deleteLevelDifficultiesWith:id
    integer:integer
              completionHandler: ^(array[DifficultyConnection] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var BamBirds = require('bam_birds');
var defaultClient = BamBirds.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new BamBirds.LevelApi()
var id = 56; // {Integer} ID of the level
var opts = {
  'integer':  // {array[Integer]} 
};

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

namespace Example
{
    public class deleteLevelDifficultiesExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new LevelApi();
            var id = 56;  // Integer | ID of the level (default to null)
            var integer = new array[Integer](); // array[Integer] |  (optional) 

            try {
                // Level endpoint: delete level difficulties
                array[DifficultyConnection] result = apiInstance.deleteLevelDifficulties(id, integer);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling LevelApi.deleteLevelDifficulties: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\LevelApi();
$id = 56; // Integer | ID of the level
$integer = ; // array[Integer] | 

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::LevelApi->new();
my $id = 56; # Integer | ID of the level
my $integer = [WWW::OPenAPIClient::Object::array[Integer]->new()]; # array[Integer] | 

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.LevelApi()
id = 56 # Integer | ID of the level (default to null)
integer =  # array[Integer] |  (optional)

try:
    # Level endpoint: delete level difficulties
    api_response = api_instance.delete_level_difficulties(id, integer=integer)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LevelApi->deleteLevelDifficulties: %s\n" % e)
extern crate LevelApi;

pub fn main() {
    let id = 56; // Integer
    let integer = ; // array[Integer]

    let mut context = LevelApi::Context::default();
    let result = client.deleteLevelDifficulties(id, integer, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
ID of the level
Required
Body parameters
Name Description
integer

Responses


getLevel

Level endpoint: Returns details about a level


/api/levels/{id}

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "http://localhost:3000/api/levels/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LevelApi;

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

public class LevelApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        LevelApi apiInstance = new LevelApi();
        Integer id = 56; // Integer | ID of the level

        try {
            Level result = apiInstance.getLevel(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LevelApi#getLevel");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LevelApi;

public class LevelApiExample {
    public static void main(String[] args) {
        LevelApi apiInstance = new LevelApi();
        Integer id = 56; // Integer | ID of the level

        try {
            Level result = apiInstance.getLevel(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LevelApi#getLevel");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
LevelApi *apiInstance = [[LevelApi alloc] init];
Integer *id = 56; // ID of the level (default to null)

// Level endpoint: Returns details about a level
[apiInstance getLevelWith:id
              completionHandler: ^(Level output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var BamBirds = require('bam_birds');
var defaultClient = BamBirds.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new BamBirds.LevelApi()
var id = 56; // {Integer} ID of the level

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

namespace Example
{
    public class getLevelExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new LevelApi();
            var id = 56;  // Integer | ID of the level (default to null)

            try {
                // Level endpoint: Returns details about a level
                Level result = apiInstance.getLevel(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling LevelApi.getLevel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\LevelApi();
$id = 56; // Integer | ID of the level

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::LevelApi->new();
my $id = 56; # Integer | ID of the level

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.LevelApi()
id = 56 # Integer | ID of the level (default to null)

try:
    # Level endpoint: Returns details about a level
    api_response = api_instance.get_level(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LevelApi->getLevel: %s\n" % e)
extern crate LevelApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = LevelApi::Context::default();
    let result = client.getLevel(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
ID of the level
Required

Responses


listLevelDifficulties

Level endpoint: Returns all difficulties of the level


/api/levels/{id}/difficulties

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "http://localhost:3000/api/levels/{id}/difficulties"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LevelApi;

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

public class LevelApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        LevelApi apiInstance = new LevelApi();
        Integer id = 56; // Integer | ID of the level

        try {
            array[DifficultyConnection] result = apiInstance.listLevelDifficulties(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LevelApi#listLevelDifficulties");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LevelApi;

public class LevelApiExample {
    public static void main(String[] args) {
        LevelApi apiInstance = new LevelApi();
        Integer id = 56; // Integer | ID of the level

        try {
            array[DifficultyConnection] result = apiInstance.listLevelDifficulties(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LevelApi#listLevelDifficulties");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
LevelApi *apiInstance = [[LevelApi alloc] init];
Integer *id = 56; // ID of the level (default to null)

// Level endpoint: Returns all difficulties of the level
[apiInstance listLevelDifficultiesWith:id
              completionHandler: ^(array[DifficultyConnection] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var BamBirds = require('bam_birds');
var defaultClient = BamBirds.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new BamBirds.LevelApi()
var id = 56; // {Integer} ID of the level

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

namespace Example
{
    public class listLevelDifficultiesExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new LevelApi();
            var id = 56;  // Integer | ID of the level (default to null)

            try {
                // Level endpoint: Returns all difficulties of the level
                array[DifficultyConnection] result = apiInstance.listLevelDifficulties(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling LevelApi.listLevelDifficulties: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\LevelApi();
$id = 56; // Integer | ID of the level

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::LevelApi->new();
my $id = 56; # Integer | ID of the level

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.LevelApi()
id = 56 # Integer | ID of the level (default to null)

try:
    # Level endpoint: Returns all difficulties of the level
    api_response = api_instance.list_level_difficulties(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LevelApi->listLevelDifficulties: %s\n" % e)
extern crate LevelApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = LevelApi::Context::default();
    let result = client.listLevelDifficulties(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
ID of the level
Required

Responses


listLevels

Level endpoint: Get all levels


/api/levels

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "http://localhost:3000/api/levels?source=source_example&offset=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LevelApi;

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

public class LevelApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        LevelApi apiInstance = new LevelApi();
        String source = source_example; // String | Return levels that contain the specified value in the source attribute
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return

        try {
            array[Level] result = apiInstance.listLevels(source, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LevelApi#listLevels");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LevelApi;

public class LevelApiExample {
    public static void main(String[] args) {
        LevelApi apiInstance = new LevelApi();
        String source = source_example; // String | Return levels that contain the specified value in the source attribute
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return

        try {
            array[Level] result = apiInstance.listLevels(source, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LevelApi#listLevels");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
LevelApi *apiInstance = [[LevelApi alloc] init];
String *source = source_example; // Return levels that contain the specified value in the source attribute (optional) (default to null)
Integer *offset = 56; // The number of items to skip before starting to collect the result set (optional) (default to null)
Integer *limit = 56; // The numbers of items to return (optional) (default to null)

// Level endpoint: Get all levels
[apiInstance listLevelsWith:source
    offset:offset
    limit:limit
              completionHandler: ^(array[Level] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var BamBirds = require('bam_birds');
var defaultClient = BamBirds.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new BamBirds.LevelApi()
var opts = {
  'source': source_example, // {String} Return levels that contain the specified value in the source attribute
  'offset': 56, // {Integer} The number of items to skip before starting to collect the result set
  'limit': 56 // {Integer} The numbers of items to return
};

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

namespace Example
{
    public class listLevelsExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new LevelApi();
            var source = source_example;  // String | Return levels that contain the specified value in the source attribute (optional)  (default to null)
            var offset = 56;  // Integer | The number of items to skip before starting to collect the result set (optional)  (default to null)
            var limit = 56;  // Integer | The numbers of items to return (optional)  (default to null)

            try {
                // Level endpoint: Get all levels
                array[Level] result = apiInstance.listLevels(source, offset, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling LevelApi.listLevels: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\LevelApi();
$source = source_example; // String | Return levels that contain the specified value in the source attribute
$offset = 56; // Integer | The number of items to skip before starting to collect the result set
$limit = 56; // Integer | The numbers of items to return

try {
    $result = $api_instance->listLevels($source, $offset, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LevelApi->listLevels: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::LevelApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::LevelApi->new();
my $source = source_example; # String | Return levels that contain the specified value in the source attribute
my $offset = 56; # Integer | The number of items to skip before starting to collect the result set
my $limit = 56; # Integer | The numbers of items to return

eval {
    my $result = $api_instance->listLevels(source => $source, offset => $offset, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LevelApi->listLevels: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.LevelApi()
source = source_example # String | Return levels that contain the specified value in the source attribute (optional) (default to null)
offset = 56 # Integer | The number of items to skip before starting to collect the result set (optional) (default to null)
limit = 56 # Integer | The numbers of items to return (optional) (default to null)

try:
    # Level endpoint: Get all levels
    api_response = api_instance.list_levels(source=source, offset=offset, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LevelApi->listLevels: %s\n" % e)
extern crate LevelApi;

pub fn main() {
    let source = source_example; // String
    let offset = 56; // Integer
    let limit = 56; // Integer

    let mut context = LevelApi::Context::default();
    let result = client.listLevels(source, offset, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
source
String
Return levels that contain the specified value in the source attribute
offset
Integer
The number of items to skip before starting to collect the result set
limit
Integer
The numbers of items to return

Responses

Name Type Format Description
xMinusnext String A link to the next page of responses


updateLevel

Level endpoint: Update level info


/api/levels/{id}

Usage and SDK Samples

curl -X PUT \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:3000/api/levels/{id}" \
 -d '{
  "sciencebirds_file" : "sciencebirds_file",
  "source" : "source",
  "high_score" : 0,
  "chrome_file" : "{}"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LevelApi;

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

public class LevelApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        LevelApi apiInstance = new LevelApi();
        Integer id = 56; // Integer | ID of the level
        InputLevel inputLevel = ; // InputLevel | 

        try {
            Level result = apiInstance.updateLevel(id, inputLevel);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LevelApi#updateLevel");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LevelApi;

public class LevelApiExample {
    public static void main(String[] args) {
        LevelApi apiInstance = new LevelApi();
        Integer id = 56; // Integer | ID of the level
        InputLevel inputLevel = ; // InputLevel | 

        try {
            Level result = apiInstance.updateLevel(id, inputLevel);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LevelApi#updateLevel");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
LevelApi *apiInstance = [[LevelApi alloc] init];
Integer *id = 56; // ID of the level (default to null)
InputLevel *inputLevel = ; //  (optional)

// Level endpoint: Update level info
[apiInstance updateLevelWith:id
    inputLevel:inputLevel
              completionHandler: ^(Level output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var BamBirds = require('bam_birds');
var defaultClient = BamBirds.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new BamBirds.LevelApi()
var id = 56; // {Integer} ID of the level
var opts = {
  'inputLevel':  // {InputLevel} 
};

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

namespace Example
{
    public class updateLevelExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new LevelApi();
            var id = 56;  // Integer | ID of the level (default to null)
            var inputLevel = new InputLevel(); // InputLevel |  (optional) 

            try {
                // Level endpoint: Update level info
                Level result = apiInstance.updateLevel(id, inputLevel);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling LevelApi.updateLevel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\LevelApi();
$id = 56; // Integer | ID of the level
$inputLevel = ; // InputLevel | 

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::LevelApi->new();
my $id = 56; # Integer | ID of the level
my $inputLevel = WWW::OPenAPIClient::Object::InputLevel->new(); # InputLevel | 

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.LevelApi()
id = 56 # Integer | ID of the level (default to null)
inputLevel =  # InputLevel |  (optional)

try:
    # Level endpoint: Update level info
    api_response = api_instance.update_level(id, inputLevel=inputLevel)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LevelApi->updateLevel: %s\n" % e)
extern crate LevelApi;

pub fn main() {
    let id = 56; // Integer
    let inputLevel = ; // InputLevel

    let mut context = LevelApi::Context::default();
    let result = client.updateLevel(id, inputLevel, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
ID of the level
Required
Body parameters
Name Description
inputLevel

Responses


updateLevelDifficulties

Level endpoint: Update level difficulties


/api/levels/{id}/difficulties

Usage and SDK Samples

curl -X PUT \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:3000/api/levels/{id}/difficulties" \
 -d '{
  "difficulty_id" : 34,
  "exists" : true
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LevelApi;

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

public class LevelApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        LevelApi apiInstance = new LevelApi();
        Integer id = 56; // Integer | ID of the level
        array[InputDifficultyConnection] inputDifficultyConnection = ; // array[InputDifficultyConnection] | 

        try {
            array[DifficultyConnection] result = apiInstance.updateLevelDifficulties(id, inputDifficultyConnection);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LevelApi#updateLevelDifficulties");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LevelApi;

public class LevelApiExample {
    public static void main(String[] args) {
        LevelApi apiInstance = new LevelApi();
        Integer id = 56; // Integer | ID of the level
        array[InputDifficultyConnection] inputDifficultyConnection = ; // array[InputDifficultyConnection] | 

        try {
            array[DifficultyConnection] result = apiInstance.updateLevelDifficulties(id, inputDifficultyConnection);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LevelApi#updateLevelDifficulties");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
LevelApi *apiInstance = [[LevelApi alloc] init];
Integer *id = 56; // ID of the level (default to null)
array[InputDifficultyConnection] *inputDifficultyConnection = ; //  (optional)

// Level endpoint: Update level difficulties
[apiInstance updateLevelDifficultiesWith:id
    inputDifficultyConnection:inputDifficultyConnection
              completionHandler: ^(array[DifficultyConnection] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var BamBirds = require('bam_birds');
var defaultClient = BamBirds.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new BamBirds.LevelApi()
var id = 56; // {Integer} ID of the level
var opts = {
  'inputDifficultyConnection':  // {array[InputDifficultyConnection]} 
};

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

namespace Example
{
    public class updateLevelDifficultiesExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new LevelApi();
            var id = 56;  // Integer | ID of the level (default to null)
            var inputDifficultyConnection = new array[InputDifficultyConnection](); // array[InputDifficultyConnection] |  (optional) 

            try {
                // Level endpoint: Update level difficulties
                array[DifficultyConnection] result = apiInstance.updateLevelDifficulties(id, inputDifficultyConnection);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling LevelApi.updateLevelDifficulties: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\LevelApi();
$id = 56; // Integer | ID of the level
$inputDifficultyConnection = ; // array[InputDifficultyConnection] | 

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::LevelApi->new();
my $id = 56; # Integer | ID of the level
my $inputDifficultyConnection = [WWW::OPenAPIClient::Object::array[InputDifficultyConnection]->new()]; # array[InputDifficultyConnection] | 

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.LevelApi()
id = 56 # Integer | ID of the level (default to null)
inputDifficultyConnection =  # array[InputDifficultyConnection] |  (optional)

try:
    # Level endpoint: Update level difficulties
    api_response = api_instance.update_level_difficulties(id, inputDifficultyConnection=inputDifficultyConnection)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LevelApi->updateLevelDifficulties: %s\n" % e)
extern crate LevelApi;

pub fn main() {
    let id = 56; // Integer
    let inputDifficultyConnection = ; // array[InputDifficultyConnection]

    let mut context = LevelApi::Context::default();
    let result = client.updateLevelDifficulties(id, inputDifficultyConnection, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
ID of the level
Required
Body parameters
Name Description
inputDifficultyConnection

Responses


Security

getToken

Token endpoint: Return JWT token that is stored in cookies


/api/token

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "http://localhost:3000/api/token"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SecurityApi;

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

public class SecurityApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SecurityApi apiInstance = new SecurityApi();

        try {
            Token result = apiInstance.getToken();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#getToken");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SecurityApi;

public class SecurityApiExample {
    public static void main(String[] args) {
        SecurityApi apiInstance = new SecurityApi();

        try {
            Token result = apiInstance.getToken();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#getToken");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SecurityApi *apiInstance = [[SecurityApi alloc] init];

// Token endpoint: Return JWT token that is stored in cookies
[apiInstance getTokenWithCompletionHandler: 
              ^(Token output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var BamBirds = require('bam_birds');
var defaultClient = BamBirds.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new BamBirds.SecurityApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getToken(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getTokenExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SecurityApi();

            try {
                // Token endpoint: Return JWT token that is stored in cookies
                Token result = apiInstance.getToken();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SecurityApi.getToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SecurityApi();

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SecurityApi->new();

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SecurityApi()

try:
    # Token endpoint: Return JWT token that is stored in cookies
    api_response = api_instance.get_token()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SecurityApi->getToken: %s\n" % e)
extern crate SecurityApi;

pub fn main() {

    let mut context = SecurityApi::Context::default();
    let result = client.getToken(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


Version

addAgentVersion

AgentVersion endpoint: Add an agent version


/api/agents/{agent_id}/versions

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:3000/api/agents/{agent_id}/versions" \
 -d '{
  "type" : "submission",
  "tag" : "v19",
  "date" : "2020-08-01"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VersionApi;

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

public class VersionApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        VersionApi apiInstance = new VersionApi();
        Integer agentId = 56; // Integer | ID of the agent
        InputAgentVersion inputAgentVersion = ; // InputAgentVersion | 

        try {
            array[AgentVersion] result = apiInstance.addAgentVersion(agentId, inputAgentVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VersionApi#addAgentVersion");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VersionApi;

public class VersionApiExample {
    public static void main(String[] args) {
        VersionApi apiInstance = new VersionApi();
        Integer agentId = 56; // Integer | ID of the agent
        InputAgentVersion inputAgentVersion = ; // InputAgentVersion | 

        try {
            array[AgentVersion] result = apiInstance.addAgentVersion(agentId, inputAgentVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VersionApi#addAgentVersion");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
VersionApi *apiInstance = [[VersionApi alloc] init];
Integer *agentId = 56; // ID of the agent (default to null)
InputAgentVersion *inputAgentVersion = ; //  (optional)

// AgentVersion endpoint: Add an agent version
[apiInstance addAgentVersionWith:agentId
    inputAgentVersion:inputAgentVersion
              completionHandler: ^(array[AgentVersion] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var BamBirds = require('bam_birds');
var defaultClient = BamBirds.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new BamBirds.VersionApi()
var agentId = 56; // {Integer} ID of the agent
var opts = {
  'inputAgentVersion':  // {InputAgentVersion} 
};

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

namespace Example
{
    public class addAgentVersionExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new VersionApi();
            var agentId = 56;  // Integer | ID of the agent (default to null)
            var inputAgentVersion = new InputAgentVersion(); // InputAgentVersion |  (optional) 

            try {
                // AgentVersion endpoint: Add an agent version
                array[AgentVersion] result = apiInstance.addAgentVersion(agentId, inputAgentVersion);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VersionApi.addAgentVersion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VersionApi();
$agentId = 56; // Integer | ID of the agent
$inputAgentVersion = ; // InputAgentVersion | 

try {
    $result = $api_instance->addAgentVersion($agentId, $inputAgentVersion);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VersionApi->addAgentVersion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VersionApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VersionApi->new();
my $agentId = 56; # Integer | ID of the agent
my $inputAgentVersion = WWW::OPenAPIClient::Object::InputAgentVersion->new(); # InputAgentVersion | 

eval {
    my $result = $api_instance->addAgentVersion(agentId => $agentId, inputAgentVersion => $inputAgentVersion);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VersionApi->addAgentVersion: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.VersionApi()
agentId = 56 # Integer | ID of the agent (default to null)
inputAgentVersion =  # InputAgentVersion |  (optional)

try:
    # AgentVersion endpoint: Add an agent version
    api_response = api_instance.add_agent_version(agentId, inputAgentVersion=inputAgentVersion)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VersionApi->addAgentVersion: %s\n" % e)
extern crate VersionApi;

pub fn main() {
    let agentId = 56; // Integer
    let inputAgentVersion = ; // InputAgentVersion

    let mut context = VersionApi::Context::default();
    let result = client.addAgentVersion(agentId, inputAgentVersion, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
agent_id*
Integer (int32)
ID of the agent
Required
Body parameters
Name Description
inputAgentVersion

Responses


addAgentVersionAttempts

AgentVersionAttempts endpoint: Add an agent version attempt


/api/agents/{agent_id}/versions/{version_id}/attempts

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:3000/api/agents/{agent_id}/versions/{version_id}/attempts" \
 -d '{
  "duration" : "00:05:00",
  "max_score" : 28400,
  "first_score" : 24900,
  "count_attempts" : 20,
  "time_until_max_score" : "00:01:34",
  "time_until_first_score" : "00:00:20",
  "attempts_until_first_score" : 0,
  "attempts_until_max_score" : 5
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VersionApi;

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

public class VersionApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        VersionApi apiInstance = new VersionApi();
        Integer agentId = 56; // Integer | ID of the agent
        Integer versionId = 56; // Integer | ID of the agent version
        InputAgentVersionAttempt inputAgentVersionAttempt = ; // InputAgentVersionAttempt | 

        try {
            array[AgentVersionAttempt] result = apiInstance.addAgentVersionAttempts(agentId, versionId, inputAgentVersionAttempt);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VersionApi#addAgentVersionAttempts");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VersionApi;

public class VersionApiExample {
    public static void main(String[] args) {
        VersionApi apiInstance = new VersionApi();
        Integer agentId = 56; // Integer | ID of the agent
        Integer versionId = 56; // Integer | ID of the agent version
        InputAgentVersionAttempt inputAgentVersionAttempt = ; // InputAgentVersionAttempt | 

        try {
            array[AgentVersionAttempt] result = apiInstance.addAgentVersionAttempts(agentId, versionId, inputAgentVersionAttempt);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VersionApi#addAgentVersionAttempts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
VersionApi *apiInstance = [[VersionApi alloc] init];
Integer *agentId = 56; // ID of the agent (default to null)
Integer *versionId = 56; // ID of the agent version (default to null)
InputAgentVersionAttempt *inputAgentVersionAttempt = ; //  (optional)

// AgentVersionAttempts endpoint: Add an agent version attempt
[apiInstance addAgentVersionAttemptsWith:agentId
    versionId:versionId
    inputAgentVersionAttempt:inputAgentVersionAttempt
              completionHandler: ^(array[AgentVersionAttempt] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var BamBirds = require('bam_birds');
var defaultClient = BamBirds.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new BamBirds.VersionApi()
var agentId = 56; // {Integer} ID of the agent
var versionId = 56; // {Integer} ID of the agent version
var opts = {
  'inputAgentVersionAttempt':  // {InputAgentVersionAttempt} 
};

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

namespace Example
{
    public class addAgentVersionAttemptsExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new VersionApi();
            var agentId = 56;  // Integer | ID of the agent (default to null)
            var versionId = 56;  // Integer | ID of the agent version (default to null)
            var inputAgentVersionAttempt = new InputAgentVersionAttempt(); // InputAgentVersionAttempt |  (optional) 

            try {
                // AgentVersionAttempts endpoint: Add an agent version attempt
                array[AgentVersionAttempt] result = apiInstance.addAgentVersionAttempts(agentId, versionId, inputAgentVersionAttempt);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VersionApi.addAgentVersionAttempts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VersionApi();
$agentId = 56; // Integer | ID of the agent
$versionId = 56; // Integer | ID of the agent version
$inputAgentVersionAttempt = ; // InputAgentVersionAttempt | 

try {
    $result = $api_instance->addAgentVersionAttempts($agentId, $versionId, $inputAgentVersionAttempt);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VersionApi->addAgentVersionAttempts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VersionApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VersionApi->new();
my $agentId = 56; # Integer | ID of the agent
my $versionId = 56; # Integer | ID of the agent version
my $inputAgentVersionAttempt = WWW::OPenAPIClient::Object::InputAgentVersionAttempt->new(); # InputAgentVersionAttempt | 

eval {
    my $result = $api_instance->addAgentVersionAttempts(agentId => $agentId, versionId => $versionId, inputAgentVersionAttempt => $inputAgentVersionAttempt);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VersionApi->addAgentVersionAttempts: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.VersionApi()
agentId = 56 # Integer | ID of the agent (default to null)
versionId = 56 # Integer | ID of the agent version (default to null)
inputAgentVersionAttempt =  # InputAgentVersionAttempt |  (optional)

try:
    # AgentVersionAttempts endpoint: Add an agent version attempt
    api_response = api_instance.add_agent_version_attempts(agentId, versionId, inputAgentVersionAttempt=inputAgentVersionAttempt)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VersionApi->addAgentVersionAttempts: %s\n" % e)
extern crate VersionApi;

pub fn main() {
    let agentId = 56; // Integer
    let versionId = 56; // Integer
    let inputAgentVersionAttempt = ; // InputAgentVersionAttempt

    let mut context = VersionApi::Context::default();
    let result = client.addAgentVersionAttempts(agentId, versionId, inputAgentVersionAttempt, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
agent_id*
Integer (int32)
ID of the agent
Required
version_id*
Integer (int32)
ID of the agent version
Required
Body parameters
Name Description
inputAgentVersionAttempt

Responses


deleteAgentVersion

AgentVersion endpoint: delete an agent version


/api/agents/{agent_id}/versions/{version_id}

Usage and SDK Samples

curl -X DELETE \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:3000/api/agents/{agent_id}/versions/{version_id}" \
 -d '{
  "difficulty_id" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VersionApi;

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

public class VersionApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        VersionApi apiInstance = new VersionApi();
        Integer agentId = 56; // Integer | ID of the agent
        Integer versionId = 56; // Integer | ID of the agent version
        array[InlineObject] inlineObject = ; // array[InlineObject] | 

        try {
            AgentVersion result = apiInstance.deleteAgentVersion(agentId, versionId, inlineObject);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VersionApi#deleteAgentVersion");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VersionApi;

public class VersionApiExample {
    public static void main(String[] args) {
        VersionApi apiInstance = new VersionApi();
        Integer agentId = 56; // Integer | ID of the agent
        Integer versionId = 56; // Integer | ID of the agent version
        array[InlineObject] inlineObject = ; // array[InlineObject] | 

        try {
            AgentVersion result = apiInstance.deleteAgentVersion(agentId, versionId, inlineObject);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VersionApi#deleteAgentVersion");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
VersionApi *apiInstance = [[VersionApi alloc] init];
Integer *agentId = 56; // ID of the agent (default to null)
Integer *versionId = 56; // ID of the agent version (default to null)
array[InlineObject] *inlineObject = ; //  (optional)

// AgentVersion endpoint: delete an agent version
[apiInstance deleteAgentVersionWith:agentId
    versionId:versionId
    inlineObject:inlineObject
              completionHandler: ^(AgentVersion output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var BamBirds = require('bam_birds');
var defaultClient = BamBirds.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new BamBirds.VersionApi()
var agentId = 56; // {Integer} ID of the agent
var versionId = 56; // {Integer} ID of the agent version
var opts = {
  'inlineObject':  // {array[InlineObject]} 
};

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

namespace Example
{
    public class deleteAgentVersionExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new VersionApi();
            var agentId = 56;  // Integer | ID of the agent (default to null)
            var versionId = 56;  // Integer | ID of the agent version (default to null)
            var inlineObject = new array[InlineObject](); // array[InlineObject] |  (optional) 

            try {
                // AgentVersion endpoint: delete an agent version
                AgentVersion result = apiInstance.deleteAgentVersion(agentId, versionId, inlineObject);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VersionApi.deleteAgentVersion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VersionApi();
$agentId = 56; // Integer | ID of the agent
$versionId = 56; // Integer | ID of the agent version
$inlineObject = ; // array[InlineObject] | 

try {
    $result = $api_instance->deleteAgentVersion($agentId, $versionId, $inlineObject);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VersionApi->deleteAgentVersion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VersionApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VersionApi->new();
my $agentId = 56; # Integer | ID of the agent
my $versionId = 56; # Integer | ID of the agent version
my $inlineObject = [WWW::OPenAPIClient::Object::array[InlineObject]->new()]; # array[InlineObject] | 

eval {
    my $result = $api_instance->deleteAgentVersion(agentId => $agentId, versionId => $versionId, inlineObject => $inlineObject);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VersionApi->deleteAgentVersion: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.VersionApi()
agentId = 56 # Integer | ID of the agent (default to null)
versionId = 56 # Integer | ID of the agent version (default to null)
inlineObject =  # array[InlineObject] |  (optional)

try:
    # AgentVersion endpoint: delete an agent version
    api_response = api_instance.delete_agent_version(agentId, versionId, inlineObject=inlineObject)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VersionApi->deleteAgentVersion: %s\n" % e)
extern crate VersionApi;

pub fn main() {
    let agentId = 56; // Integer
    let versionId = 56; // Integer
    let inlineObject = ; // array[InlineObject]

    let mut context = VersionApi::Context::default();
    let result = client.deleteAgentVersion(agentId, versionId, inlineObject, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
agent_id*
Integer (int32)
ID of the agent
Required
version_id*
Integer (int32)
ID of the agent version
Required
Body parameters
Name Description
inlineObject

Responses


evaluationState

Evaluation endpoint: Get current evaluation states


/api/evaluation-state

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "http://localhost:3000/api/evaluation-state?agent.name=agentPeriodname_example&agent.id=56&agent_version.type=agentVersionPeriodtype_example&offset=56&limit=56&page=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VersionApi;

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

public class VersionApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        VersionApi apiInstance = new VersionApi();
        String agentPeriodname = agentPeriodname_example; // String | Return only versions from this agent
        Integer agentPeriodid = 56; // Integer | Return only versions from this agent (by id)
        String agentVersionPeriodtype = agentVersionPeriodtype_example; // String | Return only versions of a specific type
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return
        Integer page = 56; // Integer | The page to return (takes precedence over offset)

        try {
            array[EvaluationState] result = apiInstance.evaluationState(agentPeriodname, agentPeriodid, agentVersionPeriodtype, offset, limit, page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VersionApi#evaluationState");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VersionApi;

public class VersionApiExample {
    public static void main(String[] args) {
        VersionApi apiInstance = new VersionApi();
        String agentPeriodname = agentPeriodname_example; // String | Return only versions from this agent
        Integer agentPeriodid = 56; // Integer | Return only versions from this agent (by id)
        String agentVersionPeriodtype = agentVersionPeriodtype_example; // String | Return only versions of a specific type
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return
        Integer page = 56; // Integer | The page to return (takes precedence over offset)

        try {
            array[EvaluationState] result = apiInstance.evaluationState(agentPeriodname, agentPeriodid, agentVersionPeriodtype, offset, limit, page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VersionApi#evaluationState");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
VersionApi *apiInstance = [[VersionApi alloc] init];
String *agentPeriodname = agentPeriodname_example; // Return only versions from this agent (optional) (default to null)
Integer *agentPeriodid = 56; // Return only versions from this agent (by id) (optional) (default to null)
String *agentVersionPeriodtype = agentVersionPeriodtype_example; // Return only versions of a specific type (optional) (default to null)
Integer *offset = 56; // The number of items to skip before starting to collect the result set (optional) (default to null)
Integer *limit = 56; // The numbers of items to return (optional) (default to null)
Integer *page = 56; // The page to return (takes precedence over offset) (optional) (default to null)

// Evaluation endpoint: Get current evaluation states
[apiInstance evaluationStateWith:agentPeriodname
    agentPeriodid:agentPeriodid
    agentVersionPeriodtype:agentVersionPeriodtype
    offset:offset
    limit:limit
    page:page
              completionHandler: ^(array[EvaluationState] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var BamBirds = require('bam_birds');
var defaultClient = BamBirds.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new BamBirds.VersionApi()
var opts = {
  'agentPeriodname': agentPeriodname_example, // {String} Return only versions from this agent
  'agentPeriodid': 56, // {Integer} Return only versions from this agent (by id)
  'agentVersionPeriodtype': agentVersionPeriodtype_example, // {String} Return only versions of a specific type
  'offset': 56, // {Integer} The number of items to skip before starting to collect the result set
  'limit': 56, // {Integer} The numbers of items to return
  'page': 56 // {Integer} The page to return (takes precedence over offset)
};

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

namespace Example
{
    public class evaluationStateExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new VersionApi();
            var agentPeriodname = agentPeriodname_example;  // String | Return only versions from this agent (optional)  (default to null)
            var agentPeriodid = 56;  // Integer | Return only versions from this agent (by id) (optional)  (default to null)
            var agentVersionPeriodtype = agentVersionPeriodtype_example;  // String | Return only versions of a specific type (optional)  (default to null)
            var offset = 56;  // Integer | The number of items to skip before starting to collect the result set (optional)  (default to null)
            var limit = 56;  // Integer | The numbers of items to return (optional)  (default to null)
            var page = 56;  // Integer | The page to return (takes precedence over offset) (optional)  (default to null)

            try {
                // Evaluation endpoint: Get current evaluation states
                array[EvaluationState] result = apiInstance.evaluationState(agentPeriodname, agentPeriodid, agentVersionPeriodtype, offset, limit, page);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VersionApi.evaluationState: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VersionApi();
$agentPeriodname = agentPeriodname_example; // String | Return only versions from this agent
$agentPeriodid = 56; // Integer | Return only versions from this agent (by id)
$agentVersionPeriodtype = agentVersionPeriodtype_example; // String | Return only versions of a specific type
$offset = 56; // Integer | The number of items to skip before starting to collect the result set
$limit = 56; // Integer | The numbers of items to return
$page = 56; // Integer | The page to return (takes precedence over offset)

try {
    $result = $api_instance->evaluationState($agentPeriodname, $agentPeriodid, $agentVersionPeriodtype, $offset, $limit, $page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VersionApi->evaluationState: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VersionApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VersionApi->new();
my $agentPeriodname = agentPeriodname_example; # String | Return only versions from this agent
my $agentPeriodid = 56; # Integer | Return only versions from this agent (by id)
my $agentVersionPeriodtype = agentVersionPeriodtype_example; # String | Return only versions of a specific type
my $offset = 56; # Integer | The number of items to skip before starting to collect the result set
my $limit = 56; # Integer | The numbers of items to return
my $page = 56; # Integer | The page to return (takes precedence over offset)

eval {
    my $result = $api_instance->evaluationState(agentPeriodname => $agentPeriodname, agentPeriodid => $agentPeriodid, agentVersionPeriodtype => $agentVersionPeriodtype, offset => $offset, limit => $limit, page => $page);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VersionApi->evaluationState: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.VersionApi()
agentPeriodname = agentPeriodname_example # String | Return only versions from this agent (optional) (default to null)
agentPeriodid = 56 # Integer | Return only versions from this agent (by id) (optional) (default to null)
agentVersionPeriodtype = agentVersionPeriodtype_example # String | Return only versions of a specific type (optional) (default to null)
offset = 56 # Integer | The number of items to skip before starting to collect the result set (optional) (default to null)
limit = 56 # Integer | The numbers of items to return (optional) (default to null)
page = 56 # Integer | The page to return (takes precedence over offset) (optional) (default to null)

try:
    # Evaluation endpoint: Get current evaluation states
    api_response = api_instance.evaluation_state(agentPeriodname=agentPeriodname, agentPeriodid=agentPeriodid, agentVersionPeriodtype=agentVersionPeriodtype, offset=offset, limit=limit, page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VersionApi->evaluationState: %s\n" % e)
extern crate VersionApi;

pub fn main() {
    let agentPeriodname = agentPeriodname_example; // String
    let agentPeriodid = 56; // Integer
    let agentVersionPeriodtype = agentVersionPeriodtype_example; // String
    let offset = 56; // Integer
    let limit = 56; // Integer
    let page = 56; // Integer

    let mut context = VersionApi::Context::default();
    let result = client.evaluationState(agentPeriodname, agentPeriodid, agentVersionPeriodtype, offset, limit, page, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
agent.name
String
Return only versions from this agent
agent.id
Integer
Return only versions from this agent (by id)
agent_version.type
String
Return only versions of a specific type
offset
Integer
The number of items to skip before starting to collect the result set
limit
Integer
The numbers of items to return
page
Integer
The page to return (takes precedence over offset)

Responses

Name Type Format Description
xMinusnext String A link to the next page of responses


getAgentVersion

AgentVersion endpoint: Returns details about an agent version


/api/agents/{agent_id}/versions/{version_id}

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "http://localhost:3000/api/agents/{agent_id}/versions/{version_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VersionApi;

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

public class VersionApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        VersionApi apiInstance = new VersionApi();
        Integer agentId = 56; // Integer | ID of the agent
        Integer versionId = 56; // Integer | ID of the agent version

        try {
            AgentVersion result = apiInstance.getAgentVersion(agentId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VersionApi#getAgentVersion");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VersionApi;

public class VersionApiExample {
    public static void main(String[] args) {
        VersionApi apiInstance = new VersionApi();
        Integer agentId = 56; // Integer | ID of the agent
        Integer versionId = 56; // Integer | ID of the agent version

        try {
            AgentVersion result = apiInstance.getAgentVersion(agentId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VersionApi#getAgentVersion");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
VersionApi *apiInstance = [[VersionApi alloc] init];
Integer *agentId = 56; // ID of the agent (default to null)
Integer *versionId = 56; // ID of the agent version (default to null)

// AgentVersion endpoint: Returns details about an agent version
[apiInstance getAgentVersionWith:agentId
    versionId:versionId
              completionHandler: ^(AgentVersion output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var BamBirds = require('bam_birds');
var defaultClient = BamBirds.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new BamBirds.VersionApi()
var agentId = 56; // {Integer} ID of the agent
var versionId = 56; // {Integer} ID of the agent version

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

namespace Example
{
    public class getAgentVersionExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new VersionApi();
            var agentId = 56;  // Integer | ID of the agent (default to null)
            var versionId = 56;  // Integer | ID of the agent version (default to null)

            try {
                // AgentVersion endpoint: Returns details about an agent version
                AgentVersion result = apiInstance.getAgentVersion(agentId, versionId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VersionApi.getAgentVersion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VersionApi();
$agentId = 56; // Integer | ID of the agent
$versionId = 56; // Integer | ID of the agent version

try {
    $result = $api_instance->getAgentVersion($agentId, $versionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VersionApi->getAgentVersion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VersionApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VersionApi->new();
my $agentId = 56; # Integer | ID of the agent
my $versionId = 56; # Integer | ID of the agent version

eval {
    my $result = $api_instance->getAgentVersion(agentId => $agentId, versionId => $versionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VersionApi->getAgentVersion: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.VersionApi()
agentId = 56 # Integer | ID of the agent (default to null)
versionId = 56 # Integer | ID of the agent version (default to null)

try:
    # AgentVersion endpoint: Returns details about an agent version
    api_response = api_instance.get_agent_version(agentId, versionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VersionApi->getAgentVersion: %s\n" % e)
extern crate VersionApi;

pub fn main() {
    let agentId = 56; // Integer
    let versionId = 56; // Integer

    let mut context = VersionApi::Context::default();
    let result = client.getAgentVersion(agentId, versionId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
agent_id*
Integer (int32)
ID of the agent
Required
version_id*
Integer (int32)
ID of the agent version
Required

Responses


listAgentVersion

AgentVersion endpoint: Returns all versions of the agent


/api/agents/{agent_id}/versions

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "http://localhost:3000/api/agents/{agent_id}/versions"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VersionApi;

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

public class VersionApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        VersionApi apiInstance = new VersionApi();
        Integer agentId = 56; // Integer | ID of the agent

        try {
            array[AgentVersion] result = apiInstance.listAgentVersion(agentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VersionApi#listAgentVersion");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VersionApi;

public class VersionApiExample {
    public static void main(String[] args) {
        VersionApi apiInstance = new VersionApi();
        Integer agentId = 56; // Integer | ID of the agent

        try {
            array[AgentVersion] result = apiInstance.listAgentVersion(agentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VersionApi#listAgentVersion");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
VersionApi *apiInstance = [[VersionApi alloc] init];
Integer *agentId = 56; // ID of the agent (default to null)

// AgentVersion endpoint: Returns all versions of the agent
[apiInstance listAgentVersionWith:agentId
              completionHandler: ^(array[AgentVersion] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var BamBirds = require('bam_birds');
var defaultClient = BamBirds.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new BamBirds.VersionApi()
var agentId = 56; // {Integer} ID of the agent

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

namespace Example
{
    public class listAgentVersionExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new VersionApi();
            var agentId = 56;  // Integer | ID of the agent (default to null)

            try {
                // AgentVersion endpoint: Returns all versions of the agent
                array[AgentVersion] result = apiInstance.listAgentVersion(agentId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VersionApi.listAgentVersion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VersionApi();
$agentId = 56; // Integer | ID of the agent

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VersionApi->new();
my $agentId = 56; # Integer | ID of the agent

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.VersionApi()
agentId = 56 # Integer | ID of the agent (default to null)

try:
    # AgentVersion endpoint: Returns all versions of the agent
    api_response = api_instance.list_agent_version(agentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VersionApi->listAgentVersion: %s\n" % e)
extern crate VersionApi;

pub fn main() {
    let agentId = 56; // Integer

    let mut context = VersionApi::Context::default();
    let result = client.listAgentVersion(agentId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
agent_id*
Integer (int32)
ID of the agent
Required

Responses


listAgentVersionAttempts

AgentVersionAttempts endpoint: Returns all attempts by the agent version


/api/agents/{agent_id}/versions/{version_id}/attempts

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "http://localhost:3000/api/agents/{agent_id}/versions/{version_id}/attempts?offset=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VersionApi;

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

public class VersionApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        VersionApi apiInstance = new VersionApi();
        Integer agentId = 56; // Integer | ID of the agent
        Integer versionId = 56; // Integer | ID of the agent version
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return

        try {
            array[AgentVersionAttempt] result = apiInstance.listAgentVersionAttempts(agentId, versionId, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VersionApi#listAgentVersionAttempts");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VersionApi;

public class VersionApiExample {
    public static void main(String[] args) {
        VersionApi apiInstance = new VersionApi();
        Integer agentId = 56; // Integer | ID of the agent
        Integer versionId = 56; // Integer | ID of the agent version
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return

        try {
            array[AgentVersionAttempt] result = apiInstance.listAgentVersionAttempts(agentId, versionId, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VersionApi#listAgentVersionAttempts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
VersionApi *apiInstance = [[VersionApi alloc] init];
Integer *agentId = 56; // ID of the agent (default to null)
Integer *versionId = 56; // ID of the agent version (default to null)
Integer *offset = 56; // The number of items to skip before starting to collect the result set (optional) (default to null)
Integer *limit = 56; // The numbers of items to return (optional) (default to null)

// AgentVersionAttempts endpoint: Returns all attempts by the agent version
[apiInstance listAgentVersionAttemptsWith:agentId
    versionId:versionId
    offset:offset
    limit:limit
              completionHandler: ^(array[AgentVersionAttempt] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var BamBirds = require('bam_birds');
var defaultClient = BamBirds.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new BamBirds.VersionApi()
var agentId = 56; // {Integer} ID of the agent
var versionId = 56; // {Integer} ID of the agent version
var opts = {
  'offset': 56, // {Integer} The number of items to skip before starting to collect the result set
  'limit': 56 // {Integer} The numbers of items to return
};

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

namespace Example
{
    public class listAgentVersionAttemptsExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new VersionApi();
            var agentId = 56;  // Integer | ID of the agent (default to null)
            var versionId = 56;  // Integer | ID of the agent version (default to null)
            var offset = 56;  // Integer | The number of items to skip before starting to collect the result set (optional)  (default to null)
            var limit = 56;  // Integer | The numbers of items to return (optional)  (default to null)

            try {
                // AgentVersionAttempts endpoint: Returns all attempts by the agent version
                array[AgentVersionAttempt] result = apiInstance.listAgentVersionAttempts(agentId, versionId, offset, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VersionApi.listAgentVersionAttempts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VersionApi();
$agentId = 56; // Integer | ID of the agent
$versionId = 56; // Integer | ID of the agent version
$offset = 56; // Integer | The number of items to skip before starting to collect the result set
$limit = 56; // Integer | The numbers of items to return

try {
    $result = $api_instance->listAgentVersionAttempts($agentId, $versionId, $offset, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VersionApi->listAgentVersionAttempts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VersionApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VersionApi->new();
my $agentId = 56; # Integer | ID of the agent
my $versionId = 56; # Integer | ID of the agent version
my $offset = 56; # Integer | The number of items to skip before starting to collect the result set
my $limit = 56; # Integer | The numbers of items to return

eval {
    my $result = $api_instance->listAgentVersionAttempts(agentId => $agentId, versionId => $versionId, offset => $offset, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VersionApi->listAgentVersionAttempts: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.VersionApi()
agentId = 56 # Integer | ID of the agent (default to null)
versionId = 56 # Integer | ID of the agent version (default to null)
offset = 56 # Integer | The number of items to skip before starting to collect the result set (optional) (default to null)
limit = 56 # Integer | The numbers of items to return (optional) (default to null)

try:
    # AgentVersionAttempts endpoint: Returns all attempts by the agent version
    api_response = api_instance.list_agent_version_attempts(agentId, versionId, offset=offset, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VersionApi->listAgentVersionAttempts: %s\n" % e)
extern crate VersionApi;

pub fn main() {
    let agentId = 56; // Integer
    let versionId = 56; // Integer
    let offset = 56; // Integer
    let limit = 56; // Integer

    let mut context = VersionApi::Context::default();
    let result = client.listAgentVersionAttempts(agentId, versionId, offset, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
agent_id*
Integer (int32)
ID of the agent
Required
version_id*
Integer (int32)
ID of the agent version
Required
Query parameters
Name Description
offset
Integer
The number of items to skip before starting to collect the result set
limit
Integer
The numbers of items to return

Responses


updateAgentVersion

AgentVersion endpoint: Update an agent version


/api/agents/{agent_id}/versions/{version_id}

Usage and SDK Samples

curl -X PUT \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:3000/api/agents/{agent_id}/versions/{version_id}" \
 -d '{
  "type" : "submission",
  "tag" : "v19",
  "date" : "2020-08-01"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VersionApi;

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

public class VersionApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        VersionApi apiInstance = new VersionApi();
        Integer agentId = 56; // Integer | ID of the agent
        Integer versionId = 56; // Integer | ID of the agent version
        array[InputAgentVersion] inputAgentVersion = ; // array[InputAgentVersion] | 

        try {
            AgentVersion result = apiInstance.updateAgentVersion(agentId, versionId, inputAgentVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VersionApi#updateAgentVersion");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VersionApi;

public class VersionApiExample {
    public static void main(String[] args) {
        VersionApi apiInstance = new VersionApi();
        Integer agentId = 56; // Integer | ID of the agent
        Integer versionId = 56; // Integer | ID of the agent version
        array[InputAgentVersion] inputAgentVersion = ; // array[InputAgentVersion] | 

        try {
            AgentVersion result = apiInstance.updateAgentVersion(agentId, versionId, inputAgentVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VersionApi#updateAgentVersion");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
VersionApi *apiInstance = [[VersionApi alloc] init];
Integer *agentId = 56; // ID of the agent (default to null)
Integer *versionId = 56; // ID of the agent version (default to null)
array[InputAgentVersion] *inputAgentVersion = ; //  (optional)

// AgentVersion endpoint: Update an agent version
[apiInstance updateAgentVersionWith:agentId
    versionId:versionId
    inputAgentVersion:inputAgentVersion
              completionHandler: ^(AgentVersion output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var BamBirds = require('bam_birds');
var defaultClient = BamBirds.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new BamBirds.VersionApi()
var agentId = 56; // {Integer} ID of the agent
var versionId = 56; // {Integer} ID of the agent version
var opts = {
  'inputAgentVersion':  // {array[InputAgentVersion]} 
};

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

namespace Example
{
    public class updateAgentVersionExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new VersionApi();
            var agentId = 56;  // Integer | ID of the agent (default to null)
            var versionId = 56;  // Integer | ID of the agent version (default to null)
            var inputAgentVersion = new array[InputAgentVersion](); // array[InputAgentVersion] |  (optional) 

            try {
                // AgentVersion endpoint: Update an agent version
                AgentVersion result = apiInstance.updateAgentVersion(agentId, versionId, inputAgentVersion);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VersionApi.updateAgentVersion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VersionApi();
$agentId = 56; // Integer | ID of the agent
$versionId = 56; // Integer | ID of the agent version
$inputAgentVersion = ; // array[InputAgentVersion] | 

try {
    $result = $api_instance->updateAgentVersion($agentId, $versionId, $inputAgentVersion);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VersionApi->updateAgentVersion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VersionApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VersionApi->new();
my $agentId = 56; # Integer | ID of the agent
my $versionId = 56; # Integer | ID of the agent version
my $inputAgentVersion = [WWW::OPenAPIClient::Object::array[InputAgentVersion]->new()]; # array[InputAgentVersion] | 

eval {
    my $result = $api_instance->updateAgentVersion(agentId => $agentId, versionId => $versionId, inputAgentVersion => $inputAgentVersion);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VersionApi->updateAgentVersion: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.VersionApi()
agentId = 56 # Integer | ID of the agent (default to null)
versionId = 56 # Integer | ID of the agent version (default to null)
inputAgentVersion =  # array[InputAgentVersion] |  (optional)

try:
    # AgentVersion endpoint: Update an agent version
    api_response = api_instance.update_agent_version(agentId, versionId, inputAgentVersion=inputAgentVersion)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VersionApi->updateAgentVersion: %s\n" % e)
extern crate VersionApi;

pub fn main() {
    let agentId = 56; // Integer
    let versionId = 56; // Integer
    let inputAgentVersion = ; // array[InputAgentVersion]

    let mut context = VersionApi::Context::default();
    let result = client.updateAgentVersion(agentId, versionId, inputAgentVersion, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
agent_id*
Integer (int32)
ID of the agent
Required
version_id*
Integer (int32)
ID of the agent version
Required
Body parameters
Name Description
inputAgentVersion

Responses