GuardAI Platform API

Benchmark

addBenchmark

Add a benchmark to an organization.


/api/v1/benchmarks

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: application/json,application/xml" \
 "http://localhost:8082/api/v1/benchmarks?organizationId=789" \
 -d '{
  "settings" : {
    "projects" : [ {
      "id" : 2,
      "enabled" : true
    }, {
      "id" : 2,
      "enabled" : true
    } ],
    "tests" : [ {
      "datasetSetting" : {
        "selectionType" : "COUNT",
        "endIdx" : 7,
        "indexes" : [ 1, 1 ],
        "startIdx" : 6,
        "batchSize" : 4,
        "shuffle" : true,
        "workers" : 7,
        "fraction" : 1.2315135,
        "numItems" : 1
      },
      "name" : "name",
      "id" : 9,
      "defenses" : [ {
        "defenseParameters" : "defenseParameters",
        "name" : "name",
        "testId" : 5,
        "filters" : [ {
          "paper_link" : "paper_link",
          "codebase_name" : "codebase_name",
          "name" : "name",
          "id" : 1,
          "type" : "type",
          "parameters" : "parameters",
          "enabled" : true,
          "tasks" : [ "tasks", "tasks" ],
          "group" : [ "group", "group" ]
        }, {
          "paper_link" : "paper_link",
          "codebase_name" : "codebase_name",
          "name" : "name",
          "id" : 1,
          "type" : "type",
          "parameters" : "parameters",
          "enabled" : true,
          "tasks" : [ "tasks", "tasks" ],
          "group" : [ "group", "group" ]
        } ],
        "id" : 4
      }, {
        "defenseParameters" : "defenseParameters",
        "name" : "name",
        "testId" : 5,
        "filters" : [ {
          "paper_link" : "paper_link",
          "codebase_name" : "codebase_name",
          "name" : "name",
          "id" : 1,
          "type" : "type",
          "parameters" : "parameters",
          "enabled" : true,
          "tasks" : [ "tasks", "tasks" ],
          "group" : [ "group", "group" ]
        }, {
          "paper_link" : "paper_link",
          "codebase_name" : "codebase_name",
          "name" : "name",
          "id" : 1,
          "type" : "type",
          "parameters" : "parameters",
          "enabled" : true,
          "tasks" : [ "tasks", "tasks" ],
          "group" : [ "group", "group" ]
        } ],
        "id" : 4
      } ],
      "status" : "CANCELLED"
    }, {
      "datasetSetting" : {
        "selectionType" : "COUNT",
        "endIdx" : 7,
        "indexes" : [ 1, 1 ],
        "startIdx" : 6,
        "batchSize" : 4,
        "shuffle" : true,
        "workers" : 7,
        "fraction" : 1.2315135,
        "numItems" : 1
      },
      "name" : "name",
      "id" : 9,
      "defenses" : [ {
        "defenseParameters" : "defenseParameters",
        "name" : "name",
        "testId" : 5,
        "filters" : [ {
          "paper_link" : "paper_link",
          "codebase_name" : "codebase_name",
          "name" : "name",
          "id" : 1,
          "type" : "type",
          "parameters" : "parameters",
          "enabled" : true,
          "tasks" : [ "tasks", "tasks" ],
          "group" : [ "group", "group" ]
        }, {
          "paper_link" : "paper_link",
          "codebase_name" : "codebase_name",
          "name" : "name",
          "id" : 1,
          "type" : "type",
          "parameters" : "parameters",
          "enabled" : true,
          "tasks" : [ "tasks", "tasks" ],
          "group" : [ "group", "group" ]
        } ],
        "id" : 4
      }, {
        "defenseParameters" : "defenseParameters",
        "name" : "name",
        "testId" : 5,
        "filters" : [ {
          "paper_link" : "paper_link",
          "codebase_name" : "codebase_name",
          "name" : "name",
          "id" : 1,
          "type" : "type",
          "parameters" : "parameters",
          "enabled" : true,
          "tasks" : [ "tasks", "tasks" ],
          "group" : [ "group", "group" ]
        }, {
          "paper_link" : "paper_link",
          "codebase_name" : "codebase_name",
          "name" : "name",
          "id" : 1,
          "type" : "type",
          "parameters" : "parameters",
          "enabled" : true,
          "tasks" : [ "tasks", "tasks" ],
          "group" : [ "group", "group" ]
        } ],
        "id" : 4
      } ],
      "status" : "CANCELLED"
    } ],
    "tasks" : [ "tasks", "tasks" ]
  },
  "name" : "name"
}' \
 -d '<BenchmarkRequest>
  <name>aeiou</name>
</BenchmarkRequest>'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BenchmarkApi;

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

public class BenchmarkApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        BenchmarkApi apiInstance = new BenchmarkApi();
        Long organizationId = 789; // Long | The organization ID.
        BenchmarkRequest benchmarkRequest = ; // BenchmarkRequest | 

        try {
            BenchmarkResponse result = apiInstance.addBenchmark(organizationId, benchmarkRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BenchmarkApi#addBenchmark");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.BenchmarkApi;

public class BenchmarkApiExample {
    public static void main(String[] args) {
        BenchmarkApi apiInstance = new BenchmarkApi();
        Long organizationId = 789; // Long | The organization ID.
        BenchmarkRequest benchmarkRequest = ; // BenchmarkRequest | 

        try {
            BenchmarkResponse result = apiInstance.addBenchmark(organizationId, benchmarkRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BenchmarkApi#addBenchmark");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
BenchmarkApi *apiInstance = [[BenchmarkApi alloc] init];
Long *organizationId = 789; // The organization ID. (default to null)
BenchmarkRequest *benchmarkRequest = ; // 

// Add a benchmark to an organization.
[apiInstance addBenchmarkWith:organizationId
    benchmarkRequest:benchmarkRequest
              completionHandler: ^(BenchmarkResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.BenchmarkApi()
var organizationId = 789; // {Long} The organization ID.
var benchmarkRequest = ; // {BenchmarkRequest} 

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

namespace Example
{
    public class addBenchmarkExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new BenchmarkApi();
            var organizationId = 789;  // Long | The organization ID. (default to null)
            var benchmarkRequest = new BenchmarkRequest(); // BenchmarkRequest | 

            try {
                // Add a benchmark to an organization.
                BenchmarkResponse result = apiInstance.addBenchmark(organizationId, benchmarkRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BenchmarkApi.addBenchmark: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BenchmarkApi();
$organizationId = 789; // Long | The organization ID.
$benchmarkRequest = ; // BenchmarkRequest | 

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BenchmarkApi->new();
my $organizationId = 789; # Long | The organization ID.
my $benchmarkRequest = WWW::OPenAPIClient::Object::BenchmarkRequest->new(); # BenchmarkRequest | 

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

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

# Create an instance of the API class
api_instance = openapi_client.BenchmarkApi()
organizationId = 789 # Long | The organization ID. (default to null)
benchmarkRequest =  # BenchmarkRequest | 

try:
    # Add a benchmark to an organization.
    api_response = api_instance.add_benchmark(organizationId, benchmarkRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BenchmarkApi->addBenchmark: %s\n" % e)
extern crate BenchmarkApi;

pub fn main() {
    let organizationId = 789; // Long
    let benchmarkRequest = ; // BenchmarkRequest

    let mut context = BenchmarkApi::Context::default();
    let result = client.addBenchmark(organizationId, benchmarkRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
benchmarkRequest *

benchmarkRequest

Query parameters
Name Description
organizationId*
Long (int64)
The organization ID.
Required

Responses


addBenchmarkTest

Add new test.


/api/v1/benchmarks/{id}/addtest

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/benchmarks/{id}/addtest?name=name_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BenchmarkApi;

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

public class BenchmarkApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        BenchmarkApi apiInstance = new BenchmarkApi();
        Long id = 789; // Long | The benchmark ID.
        String name = name_example; // String | name

        try {
            BenchmarkResponse result = apiInstance.addBenchmarkTest(id, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BenchmarkApi#addBenchmarkTest");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.BenchmarkApi;

public class BenchmarkApiExample {
    public static void main(String[] args) {
        BenchmarkApi apiInstance = new BenchmarkApi();
        Long id = 789; // Long | The benchmark ID.
        String name = name_example; // String | name

        try {
            BenchmarkResponse result = apiInstance.addBenchmarkTest(id, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BenchmarkApi#addBenchmarkTest");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
BenchmarkApi *apiInstance = [[BenchmarkApi alloc] init];
Long *id = 789; // The benchmark ID. (default to null)
String *name = name_example; // name (default to null)

// Add new test.
[apiInstance addBenchmarkTestWith:id
    name:name
              completionHandler: ^(BenchmarkResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.BenchmarkApi()
var id = 789; // {Long} The benchmark ID.
var name = name_example; // {String} name

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

namespace Example
{
    public class addBenchmarkTestExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new BenchmarkApi();
            var id = 789;  // Long | The benchmark ID. (default to null)
            var name = name_example;  // String | name (default to null)

            try {
                // Add new test.
                BenchmarkResponse result = apiInstance.addBenchmarkTest(id, name);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BenchmarkApi.addBenchmarkTest: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BenchmarkApi();
$id = 789; // Long | The benchmark ID.
$name = name_example; // String | name

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BenchmarkApi->new();
my $id = 789; # Long | The benchmark ID.
my $name = name_example; # String | name

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

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

# Create an instance of the API class
api_instance = openapi_client.BenchmarkApi()
id = 789 # Long | The benchmark ID. (default to null)
name = name_example # String | name (default to null)

try:
    # Add new test.
    api_response = api_instance.add_benchmark_test(id, name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BenchmarkApi->addBenchmarkTest: %s\n" % e)
extern crate BenchmarkApi;

pub fn main() {
    let id = 789; // Long
    let name = name_example; // String

    let mut context = BenchmarkApi::Context::default();
    let result = client.addBenchmarkTest(id, name, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The benchmark ID.
Required
Query parameters
Name Description
name*
String
name
Required

Responses


addBenchmarkTestDefense

Add defense to benchmark test.


/api/v1/benchmarks/{id}/{testId}/defense

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: application/json,application/xml" \
 "http://localhost:8082/api/v1/benchmarks/{id}/{testId}/defense" \
 -d '{
  "name" : "name",
  "parameters" : "parameters"
}' \
 -d '<DefenseRequest>
  <name>aeiou</name>
  <parameters>aeiou</parameters>
</DefenseRequest>'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BenchmarkApi;

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

public class BenchmarkApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        BenchmarkApi apiInstance = new BenchmarkApi();
        Long id = 789; // Long | The benchmark ID.
        Integer testId = 56; // Integer | The test ID.
        DefenseRequest defense = ; // DefenseRequest | 

        try {
            BenchmarkTest result = apiInstance.addBenchmarkTestDefense(id, testId, defense);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BenchmarkApi#addBenchmarkTestDefense");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.BenchmarkApi;

public class BenchmarkApiExample {
    public static void main(String[] args) {
        BenchmarkApi apiInstance = new BenchmarkApi();
        Long id = 789; // Long | The benchmark ID.
        Integer testId = 56; // Integer | The test ID.
        DefenseRequest defense = ; // DefenseRequest | 

        try {
            BenchmarkTest result = apiInstance.addBenchmarkTestDefense(id, testId, defense);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BenchmarkApi#addBenchmarkTestDefense");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
BenchmarkApi *apiInstance = [[BenchmarkApi alloc] init];
Long *id = 789; // The benchmark ID. (default to null)
Integer *testId = 56; // The test ID. (default to null)
DefenseRequest *defense = ; // 

// Add defense to benchmark test.
[apiInstance addBenchmarkTestDefenseWith:id
    testId:testId
    defense:defense
              completionHandler: ^(BenchmarkTest output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.BenchmarkApi()
var id = 789; // {Long} The benchmark ID.
var testId = 56; // {Integer} The test ID.
var defense = ; // {DefenseRequest} 

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

namespace Example
{
    public class addBenchmarkTestDefenseExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new BenchmarkApi();
            var id = 789;  // Long | The benchmark ID. (default to null)
            var testId = 56;  // Integer | The test ID. (default to null)
            var defense = new DefenseRequest(); // DefenseRequest | 

            try {
                // Add defense to benchmark test.
                BenchmarkTest result = apiInstance.addBenchmarkTestDefense(id, testId, defense);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BenchmarkApi.addBenchmarkTestDefense: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BenchmarkApi();
$id = 789; // Long | The benchmark ID.
$testId = 56; // Integer | The test ID.
$defense = ; // DefenseRequest | 

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BenchmarkApi->new();
my $id = 789; # Long | The benchmark ID.
my $testId = 56; # Integer | The test ID.
my $defense = WWW::OPenAPIClient::Object::DefenseRequest->new(); # DefenseRequest | 

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

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

# Create an instance of the API class
api_instance = openapi_client.BenchmarkApi()
id = 789 # Long | The benchmark ID. (default to null)
testId = 56 # Integer | The test ID. (default to null)
defense =  # DefenseRequest | 

try:
    # Add defense to benchmark test.
    api_response = api_instance.add_benchmark_test_defense(id, testId, defense)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BenchmarkApi->addBenchmarkTestDefense: %s\n" % e)
extern crate BenchmarkApi;

pub fn main() {
    let id = 789; // Long
    let testId = 56; // Integer
    let defense = ; // DefenseRequest

    let mut context = BenchmarkApi::Context::default();
    let result = client.addBenchmarkTestDefense(id, testId, defense, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The benchmark ID.
Required
testId*
Integer (int32)
The test ID.
Required
Body parameters
Name Description
defense *

The defense.

Responses


addBenchmarkTestFilter

Add filter to benchmark test.


/api/v1/benchmarks/{id}/{testId}/filter

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: application/json,application/xml" \
 "http://localhost:8082/api/v1/benchmarks/{id}/{testId}/filter" \
 -d '{
  "name" : "name",
  "type" : "adversarial_attacks",
  "parameters" : "parameters",
  "enabled" : true
}' \
 -d '<FilterRequest>
  <enabled>true</enabled>
  <name>aeiou</name>
  <parameters>aeiou</parameters>
  <type>aeiou</type>
</FilterRequest>'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BenchmarkApi;

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

public class BenchmarkApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        BenchmarkApi apiInstance = new BenchmarkApi();
        Long id = 789; // Long | The benchmark ID.
        Integer testId = 56; // Integer | The test ID.
        FilterRequest filterRequest = ; // FilterRequest | 

        try {
            BenchmarkTest result = apiInstance.addBenchmarkTestFilter(id, testId, filterRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BenchmarkApi#addBenchmarkTestFilter");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.BenchmarkApi;

public class BenchmarkApiExample {
    public static void main(String[] args) {
        BenchmarkApi apiInstance = new BenchmarkApi();
        Long id = 789; // Long | The benchmark ID.
        Integer testId = 56; // Integer | The test ID.
        FilterRequest filterRequest = ; // FilterRequest | 

        try {
            BenchmarkTest result = apiInstance.addBenchmarkTestFilter(id, testId, filterRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BenchmarkApi#addBenchmarkTestFilter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
BenchmarkApi *apiInstance = [[BenchmarkApi alloc] init];
Long *id = 789; // The benchmark ID. (default to null)
Integer *testId = 56; // The test ID. (default to null)
FilterRequest *filterRequest = ; // 

// Add filter to benchmark test.
[apiInstance addBenchmarkTestFilterWith:id
    testId:testId
    filterRequest:filterRequest
              completionHandler: ^(BenchmarkTest output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.BenchmarkApi()
var id = 789; // {Long} The benchmark ID.
var testId = 56; // {Integer} The test ID.
var filterRequest = ; // {FilterRequest} 

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

namespace Example
{
    public class addBenchmarkTestFilterExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new BenchmarkApi();
            var id = 789;  // Long | The benchmark ID. (default to null)
            var testId = 56;  // Integer | The test ID. (default to null)
            var filterRequest = new FilterRequest(); // FilterRequest | 

            try {
                // Add filter to benchmark test.
                BenchmarkTest result = apiInstance.addBenchmarkTestFilter(id, testId, filterRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BenchmarkApi.addBenchmarkTestFilter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BenchmarkApi();
$id = 789; // Long | The benchmark ID.
$testId = 56; // Integer | The test ID.
$filterRequest = ; // FilterRequest | 

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BenchmarkApi->new();
my $id = 789; # Long | The benchmark ID.
my $testId = 56; # Integer | The test ID.
my $filterRequest = WWW::OPenAPIClient::Object::FilterRequest->new(); # FilterRequest | 

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

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

# Create an instance of the API class
api_instance = openapi_client.BenchmarkApi()
id = 789 # Long | The benchmark ID. (default to null)
testId = 56 # Integer | The test ID. (default to null)
filterRequest =  # FilterRequest | 

try:
    # Add filter to benchmark test.
    api_response = api_instance.add_benchmark_test_filter(id, testId, filterRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BenchmarkApi->addBenchmarkTestFilter: %s\n" % e)
extern crate BenchmarkApi;

pub fn main() {
    let id = 789; // Long
    let testId = 56; // Integer
    let filterRequest = ; // FilterRequest

    let mut context = BenchmarkApi::Context::default();
    let result = client.addBenchmarkTestFilter(id, testId, filterRequest, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The benchmark ID.
Required
testId*
Integer (int32)
The test ID.
Required
Body parameters
Name Description
filterRequest *

filterRequest

Responses


deleteBenchmark

Delete a benchmark.


/api/v1/benchmarks/{id}

Usage and SDK Samples

curl -X DELETE \
-H "Authorization: [[apiKey]]" \
 "http://localhost:8082/api/v1/benchmarks/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BenchmarkApi;

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

public class BenchmarkApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        BenchmarkApi apiInstance = new BenchmarkApi();
        Long id = 789; // Long | The benchmark ID.

        try {
            apiInstance.deleteBenchmark(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling BenchmarkApi#deleteBenchmark");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.BenchmarkApi;

public class BenchmarkApiExample {
    public static void main(String[] args) {
        BenchmarkApi apiInstance = new BenchmarkApi();
        Long id = 789; // Long | The benchmark ID.

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

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
BenchmarkApi *apiInstance = [[BenchmarkApi alloc] init];
Long *id = 789; // The benchmark ID. (default to null)

// Delete a benchmark.
[apiInstance deleteBenchmarkWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.BenchmarkApi()
var id = 789; // {Long} The benchmark ID.

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

namespace Example
{
    public class deleteBenchmarkExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new BenchmarkApi();
            var id = 789;  // Long | The benchmark ID. (default to null)

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

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BenchmarkApi();
$id = 789; // Long | The benchmark ID.

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BenchmarkApi->new();
my $id = 789; # Long | The benchmark ID.

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

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

# Create an instance of the API class
api_instance = openapi_client.BenchmarkApi()
id = 789 # Long | The benchmark ID. (default to null)

try:
    # Delete a benchmark.
    api_instance.delete_benchmark(id)
except ApiException as e:
    print("Exception when calling BenchmarkApi->deleteBenchmark: %s\n" % e)
extern crate BenchmarkApi;

pub fn main() {
    let id = 789; // Long

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The benchmark ID.
Required

Responses


deleteBenchmarkTest

Delete a benchmark test.


/api/v1/benchmarks/{id}/{testId}

Usage and SDK Samples

curl -X DELETE \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/benchmarks/{id}/{testId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BenchmarkApi;

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

public class BenchmarkApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        BenchmarkApi apiInstance = new BenchmarkApi();
        Long id = 789; // Long | The benchmark ID.
        Integer testId = 56; // Integer | The test ID.

        try {
            BenchmarkResponse result = apiInstance.deleteBenchmarkTest(id, testId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BenchmarkApi#deleteBenchmarkTest");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.BenchmarkApi;

public class BenchmarkApiExample {
    public static void main(String[] args) {
        BenchmarkApi apiInstance = new BenchmarkApi();
        Long id = 789; // Long | The benchmark ID.
        Integer testId = 56; // Integer | The test ID.

        try {
            BenchmarkResponse result = apiInstance.deleteBenchmarkTest(id, testId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BenchmarkApi#deleteBenchmarkTest");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
BenchmarkApi *apiInstance = [[BenchmarkApi alloc] init];
Long *id = 789; // The benchmark ID. (default to null)
Integer *testId = 56; // The test ID. (default to null)

// Delete a benchmark test.
[apiInstance deleteBenchmarkTestWith:id
    testId:testId
              completionHandler: ^(BenchmarkResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.BenchmarkApi()
var id = 789; // {Long} The benchmark ID.
var testId = 56; // {Integer} The test ID.

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

namespace Example
{
    public class deleteBenchmarkTestExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new BenchmarkApi();
            var id = 789;  // Long | The benchmark ID. (default to null)
            var testId = 56;  // Integer | The test ID. (default to null)

            try {
                // Delete a benchmark test.
                BenchmarkResponse result = apiInstance.deleteBenchmarkTest(id, testId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BenchmarkApi.deleteBenchmarkTest: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BenchmarkApi();
$id = 789; // Long | The benchmark ID.
$testId = 56; // Integer | The test ID.

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BenchmarkApi->new();
my $id = 789; # Long | The benchmark ID.
my $testId = 56; # Integer | The test ID.

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

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

# Create an instance of the API class
api_instance = openapi_client.BenchmarkApi()
id = 789 # Long | The benchmark ID. (default to null)
testId = 56 # Integer | The test ID. (default to null)

try:
    # Delete a benchmark test.
    api_response = api_instance.delete_benchmark_test(id, testId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BenchmarkApi->deleteBenchmarkTest: %s\n" % e)
extern crate BenchmarkApi;

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

    let mut context = BenchmarkApi::Context::default();
    let result = client.deleteBenchmarkTest(id, testId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The benchmark ID.
Required
testId*
Integer (int32)
The test ID.
Required

Responses


getBenchmark

Get a benchmark.


/api/v1/benchmarks/{id}

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/benchmarks/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BenchmarkApi;

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

public class BenchmarkApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        BenchmarkApi apiInstance = new BenchmarkApi();
        Long id = 789; // Long | The benchmark ID.

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

public class BenchmarkApiExample {
    public static void main(String[] args) {
        BenchmarkApi apiInstance = new BenchmarkApi();
        Long id = 789; // Long | The benchmark ID.

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

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
BenchmarkApi *apiInstance = [[BenchmarkApi alloc] init];
Long *id = 789; // The benchmark ID. (default to null)

// Get a benchmark.
[apiInstance getBenchmarkWith:id
              completionHandler: ^(BenchmarkResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.BenchmarkApi()
var id = 789; // {Long} The benchmark ID.

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

namespace Example
{
    public class getBenchmarkExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new BenchmarkApi();
            var id = 789;  // Long | The benchmark ID. (default to null)

            try {
                // Get a benchmark.
                BenchmarkResponse result = apiInstance.getBenchmark(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BenchmarkApi.getBenchmark: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BenchmarkApi();
$id = 789; // Long | The benchmark ID.

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BenchmarkApi->new();
my $id = 789; # Long | The benchmark ID.

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

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

# Create an instance of the API class
api_instance = openapi_client.BenchmarkApi()
id = 789 # Long | The benchmark ID. (default to null)

try:
    # Get a benchmark.
    api_response = api_instance.get_benchmark(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BenchmarkApi->getBenchmark: %s\n" % e)
extern crate BenchmarkApi;

pub fn main() {
    let id = 789; // Long

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The benchmark ID.
Required

Responses


getBenchmarkTestStatus

Get benchmark test status.


/api/v1/benchmarks/{id}/{testId}/status

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/benchmarks/{id}/{testId}/status"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BenchmarkApi;

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

public class BenchmarkApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        BenchmarkApi apiInstance = new BenchmarkApi();
        Long id = 789; // Long | The benchmark ID.
        Integer testId = 56; // Integer | The test ID.

        try {
            BenchmarkTestStatusResponse result = apiInstance.getBenchmarkTestStatus(id, testId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BenchmarkApi#getBenchmarkTestStatus");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.BenchmarkApi;

public class BenchmarkApiExample {
    public static void main(String[] args) {
        BenchmarkApi apiInstance = new BenchmarkApi();
        Long id = 789; // Long | The benchmark ID.
        Integer testId = 56; // Integer | The test ID.

        try {
            BenchmarkTestStatusResponse result = apiInstance.getBenchmarkTestStatus(id, testId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BenchmarkApi#getBenchmarkTestStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
BenchmarkApi *apiInstance = [[BenchmarkApi alloc] init];
Long *id = 789; // The benchmark ID. (default to null)
Integer *testId = 56; // The test ID. (default to null)

// Get benchmark test status.
[apiInstance getBenchmarkTestStatusWith:id
    testId:testId
              completionHandler: ^(BenchmarkTestStatusResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.BenchmarkApi()
var id = 789; // {Long} The benchmark ID.
var testId = 56; // {Integer} The test ID.

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

namespace Example
{
    public class getBenchmarkTestStatusExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new BenchmarkApi();
            var id = 789;  // Long | The benchmark ID. (default to null)
            var testId = 56;  // Integer | The test ID. (default to null)

            try {
                // Get benchmark test status.
                BenchmarkTestStatusResponse result = apiInstance.getBenchmarkTestStatus(id, testId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BenchmarkApi.getBenchmarkTestStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BenchmarkApi();
$id = 789; // Long | The benchmark ID.
$testId = 56; // Integer | The test ID.

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BenchmarkApi->new();
my $id = 789; # Long | The benchmark ID.
my $testId = 56; # Integer | The test ID.

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

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

# Create an instance of the API class
api_instance = openapi_client.BenchmarkApi()
id = 789 # Long | The benchmark ID. (default to null)
testId = 56 # Integer | The test ID. (default to null)

try:
    # Get benchmark test status.
    api_response = api_instance.get_benchmark_test_status(id, testId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BenchmarkApi->getBenchmarkTestStatus: %s\n" % e)
extern crate BenchmarkApi;

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

    let mut context = BenchmarkApi::Context::default();
    let result = client.getBenchmarkTestStatus(id, testId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The benchmark ID.
Required
testId*
Integer (int32)
The test ID.
Required

Responses


getBenchmarks

Get list of benchmarks.


/api/v1/benchmarks

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/benchmarks"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BenchmarkApi;

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

public class BenchmarkApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

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

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

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

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

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


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

// Get list of benchmarks.
[apiInstance getBenchmarksWithCompletionHandler: 
              ^(array[BenchmarkResponse] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

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

namespace Example
{
    public class getBenchmarksExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

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

            try {
                // Get list of benchmarks.
                array[BenchmarkResponse] result = apiInstance.getBenchmarks();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BenchmarkApi.getBenchmarks: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

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

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

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

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

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

try:
    # Get list of benchmarks.
    api_response = api_instance.get_benchmarks()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BenchmarkApi->getBenchmarks: %s\n" % e)
extern crate BenchmarkApi;

pub fn main() {

    let mut context = BenchmarkApi::Context::default();
    let result = client.getBenchmarks(&context).wait();

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

Scopes

Parameters

Responses


removeBenchmarkFilter

Remove filter from benchmark test.


/api/v1/benchmarks/{id}/{testId}/{filterId}

Usage and SDK Samples

curl -X DELETE \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/benchmarks/{id}/{testId}/{filterId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BenchmarkApi;

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

public class BenchmarkApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        BenchmarkApi apiInstance = new BenchmarkApi();
        Long filterId = 789; // Long | The filter ID.
        Long id = 789; // Long | The benchmark ID.
        Integer testId = 56; // Integer | The test ID.

        try {
            BenchmarkTest result = apiInstance.removeBenchmarkFilter(filterId, id, testId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BenchmarkApi#removeBenchmarkFilter");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.BenchmarkApi;

public class BenchmarkApiExample {
    public static void main(String[] args) {
        BenchmarkApi apiInstance = new BenchmarkApi();
        Long filterId = 789; // Long | The filter ID.
        Long id = 789; // Long | The benchmark ID.
        Integer testId = 56; // Integer | The test ID.

        try {
            BenchmarkTest result = apiInstance.removeBenchmarkFilter(filterId, id, testId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BenchmarkApi#removeBenchmarkFilter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
BenchmarkApi *apiInstance = [[BenchmarkApi alloc] init];
Long *filterId = 789; // The filter ID. (default to null)
Long *id = 789; // The benchmark ID. (default to null)
Integer *testId = 56; // The test ID. (default to null)

// Remove filter from benchmark test.
[apiInstance removeBenchmarkFilterWith:filterId
    id:id
    testId:testId
              completionHandler: ^(BenchmarkTest output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.BenchmarkApi()
var filterId = 789; // {Long} The filter ID.
var id = 789; // {Long} The benchmark ID.
var testId = 56; // {Integer} The test ID.

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

namespace Example
{
    public class removeBenchmarkFilterExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new BenchmarkApi();
            var filterId = 789;  // Long | The filter ID. (default to null)
            var id = 789;  // Long | The benchmark ID. (default to null)
            var testId = 56;  // Integer | The test ID. (default to null)

            try {
                // Remove filter from benchmark test.
                BenchmarkTest result = apiInstance.removeBenchmarkFilter(filterId, id, testId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BenchmarkApi.removeBenchmarkFilter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BenchmarkApi();
$filterId = 789; // Long | The filter ID.
$id = 789; // Long | The benchmark ID.
$testId = 56; // Integer | The test ID.

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BenchmarkApi->new();
my $filterId = 789; # Long | The filter ID.
my $id = 789; # Long | The benchmark ID.
my $testId = 56; # Integer | The test ID.

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

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

# Create an instance of the API class
api_instance = openapi_client.BenchmarkApi()
filterId = 789 # Long | The filter ID. (default to null)
id = 789 # Long | The benchmark ID. (default to null)
testId = 56 # Integer | The test ID. (default to null)

try:
    # Remove filter from benchmark test.
    api_response = api_instance.remove_benchmark_filter(filterId, id, testId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BenchmarkApi->removeBenchmarkFilter: %s\n" % e)
extern crate BenchmarkApi;

pub fn main() {
    let filterId = 789; // Long
    let id = 789; // Long
    let testId = 56; // Integer

    let mut context = BenchmarkApi::Context::default();
    let result = client.removeBenchmarkFilter(filterId, id, testId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
filterId*
Long (int64)
The filter ID.
Required
id*
Long (int64)
The benchmark ID.
Required
testId*
Integer (int32)
The test ID.
Required

Responses


removeBenchmarkTestDefense

Remove defense from benchmark test.


/api/v1/benchmarks/{id}/{testId}/defense/{defenseId}

Usage and SDK Samples

curl -X DELETE \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/benchmarks/{id}/{testId}/defense/{defenseId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BenchmarkApi;

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

public class BenchmarkApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        BenchmarkApi apiInstance = new BenchmarkApi();
        Long defenseId = 789; // Long | The defense ID.
        Long id = 789; // Long | The benchmark ID.
        Integer testId = 56; // Integer | The test ID.

        try {
            BenchmarkTest result = apiInstance.removeBenchmarkTestDefense(defenseId, id, testId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BenchmarkApi#removeBenchmarkTestDefense");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.BenchmarkApi;

public class BenchmarkApiExample {
    public static void main(String[] args) {
        BenchmarkApi apiInstance = new BenchmarkApi();
        Long defenseId = 789; // Long | The defense ID.
        Long id = 789; // Long | The benchmark ID.
        Integer testId = 56; // Integer | The test ID.

        try {
            BenchmarkTest result = apiInstance.removeBenchmarkTestDefense(defenseId, id, testId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BenchmarkApi#removeBenchmarkTestDefense");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
BenchmarkApi *apiInstance = [[BenchmarkApi alloc] init];
Long *defenseId = 789; // The defense ID. (default to null)
Long *id = 789; // The benchmark ID. (default to null)
Integer *testId = 56; // The test ID. (default to null)

// Remove defense from benchmark test.
[apiInstance removeBenchmarkTestDefenseWith:defenseId
    id:id
    testId:testId
              completionHandler: ^(BenchmarkTest output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.BenchmarkApi()
var defenseId = 789; // {Long} The defense ID.
var id = 789; // {Long} The benchmark ID.
var testId = 56; // {Integer} The test ID.

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

namespace Example
{
    public class removeBenchmarkTestDefenseExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new BenchmarkApi();
            var defenseId = 789;  // Long | The defense ID. (default to null)
            var id = 789;  // Long | The benchmark ID. (default to null)
            var testId = 56;  // Integer | The test ID. (default to null)

            try {
                // Remove defense from benchmark test.
                BenchmarkTest result = apiInstance.removeBenchmarkTestDefense(defenseId, id, testId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BenchmarkApi.removeBenchmarkTestDefense: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BenchmarkApi();
$defenseId = 789; // Long | The defense ID.
$id = 789; // Long | The benchmark ID.
$testId = 56; // Integer | The test ID.

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BenchmarkApi->new();
my $defenseId = 789; # Long | The defense ID.
my $id = 789; # Long | The benchmark ID.
my $testId = 56; # Integer | The test ID.

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

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

# Create an instance of the API class
api_instance = openapi_client.BenchmarkApi()
defenseId = 789 # Long | The defense ID. (default to null)
id = 789 # Long | The benchmark ID. (default to null)
testId = 56 # Integer | The test ID. (default to null)

try:
    # Remove defense from benchmark test.
    api_response = api_instance.remove_benchmark_test_defense(defenseId, id, testId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BenchmarkApi->removeBenchmarkTestDefense: %s\n" % e)
extern crate BenchmarkApi;

pub fn main() {
    let defenseId = 789; // Long
    let id = 789; // Long
    let testId = 56; // Integer

    let mut context = BenchmarkApi::Context::default();
    let result = client.removeBenchmarkTestDefense(defenseId, id, testId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
defenseId*
Long (int64)
The defense ID.
Required
id*
Long (int64)
The benchmark ID.
Required
testId*
Integer (int32)
The test ID.
Required

Responses


startBenchmarkTest

Start a benchmark test.


/api/v1/benchmarks/{id}/{testId}/start

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 "http://localhost:8082/api/v1/benchmarks/{id}/{testId}/start"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BenchmarkApi;

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

public class BenchmarkApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        BenchmarkApi apiInstance = new BenchmarkApi();
        Long id = 789; // Long | The benchmark ID.
        Integer testId = 56; // Integer | The test ID.

        try {
            apiInstance.startBenchmarkTest(id, testId);
        } catch (ApiException e) {
            System.err.println("Exception when calling BenchmarkApi#startBenchmarkTest");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.BenchmarkApi;

public class BenchmarkApiExample {
    public static void main(String[] args) {
        BenchmarkApi apiInstance = new BenchmarkApi();
        Long id = 789; // Long | The benchmark ID.
        Integer testId = 56; // Integer | The test ID.

        try {
            apiInstance.startBenchmarkTest(id, testId);
        } catch (ApiException e) {
            System.err.println("Exception when calling BenchmarkApi#startBenchmarkTest");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
BenchmarkApi *apiInstance = [[BenchmarkApi alloc] init];
Long *id = 789; // The benchmark ID. (default to null)
Integer *testId = 56; // The test ID. (default to null)

// Start a benchmark test.
[apiInstance startBenchmarkTestWith:id
    testId:testId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.BenchmarkApi()
var id = 789; // {Long} The benchmark ID.
var testId = 56; // {Integer} The test ID.

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

namespace Example
{
    public class startBenchmarkTestExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new BenchmarkApi();
            var id = 789;  // Long | The benchmark ID. (default to null)
            var testId = 56;  // Integer | The test ID. (default to null)

            try {
                // Start a benchmark test.
                apiInstance.startBenchmarkTest(id, testId);
            } catch (Exception e) {
                Debug.Print("Exception when calling BenchmarkApi.startBenchmarkTest: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BenchmarkApi();
$id = 789; // Long | The benchmark ID.
$testId = 56; // Integer | The test ID.

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BenchmarkApi->new();
my $id = 789; # Long | The benchmark ID.
my $testId = 56; # Integer | The test ID.

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

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

# Create an instance of the API class
api_instance = openapi_client.BenchmarkApi()
id = 789 # Long | The benchmark ID. (default to null)
testId = 56 # Integer | The test ID. (default to null)

try:
    # Start a benchmark test.
    api_instance.start_benchmark_test(id, testId)
except ApiException as e:
    print("Exception when calling BenchmarkApi->startBenchmarkTest: %s\n" % e)
extern crate BenchmarkApi;

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

    let mut context = BenchmarkApi::Context::default();
    let result = client.startBenchmarkTest(id, testId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The benchmark ID.
Required
testId*
Integer (int32)
The test ID.
Required

Responses


stopBenchmarkTest

Stop a benchmark test.


/api/v1/benchmarks/{id}/{testId}/stop

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 "http://localhost:8082/api/v1/benchmarks/{id}/{testId}/stop"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BenchmarkApi;

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

public class BenchmarkApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        BenchmarkApi apiInstance = new BenchmarkApi();
        Long id = 789; // Long | The benchmark ID.
        Integer testId = 56; // Integer | The test ID.

        try {
            apiInstance.stopBenchmarkTest(id, testId);
        } catch (ApiException e) {
            System.err.println("Exception when calling BenchmarkApi#stopBenchmarkTest");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.BenchmarkApi;

public class BenchmarkApiExample {
    public static void main(String[] args) {
        BenchmarkApi apiInstance = new BenchmarkApi();
        Long id = 789; // Long | The benchmark ID.
        Integer testId = 56; // Integer | The test ID.

        try {
            apiInstance.stopBenchmarkTest(id, testId);
        } catch (ApiException e) {
            System.err.println("Exception when calling BenchmarkApi#stopBenchmarkTest");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
BenchmarkApi *apiInstance = [[BenchmarkApi alloc] init];
Long *id = 789; // The benchmark ID. (default to null)
Integer *testId = 56; // The test ID. (default to null)

// Stop a benchmark test.
[apiInstance stopBenchmarkTestWith:id
    testId:testId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.BenchmarkApi()
var id = 789; // {Long} The benchmark ID.
var testId = 56; // {Integer} The test ID.

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

namespace Example
{
    public class stopBenchmarkTestExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new BenchmarkApi();
            var id = 789;  // Long | The benchmark ID. (default to null)
            var testId = 56;  // Integer | The test ID. (default to null)

            try {
                // Stop a benchmark test.
                apiInstance.stopBenchmarkTest(id, testId);
            } catch (Exception e) {
                Debug.Print("Exception when calling BenchmarkApi.stopBenchmarkTest: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BenchmarkApi();
$id = 789; // Long | The benchmark ID.
$testId = 56; // Integer | The test ID.

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BenchmarkApi->new();
my $id = 789; # Long | The benchmark ID.
my $testId = 56; # Integer | The test ID.

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

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

# Create an instance of the API class
api_instance = openapi_client.BenchmarkApi()
id = 789 # Long | The benchmark ID. (default to null)
testId = 56 # Integer | The test ID. (default to null)

try:
    # Stop a benchmark test.
    api_instance.stop_benchmark_test(id, testId)
except ApiException as e:
    print("Exception when calling BenchmarkApi->stopBenchmarkTest: %s\n" % e)
extern crate BenchmarkApi;

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

    let mut context = BenchmarkApi::Context::default();
    let result = client.stopBenchmarkTest(id, testId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The benchmark ID.
Required
testId*
Integer (int32)
The test ID.
Required

Responses


updateBenchmark

Update benchmark.


/api/v1/benchmarks/{id}

Usage and SDK Samples

curl -X PUT \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: application/json,application/xml" \
 "http://localhost:8082/api/v1/benchmarks/{id}" \
 -d '{
  "settings" : {
    "projects" : [ {
      "id" : 2,
      "enabled" : true
    }, {
      "id" : 2,
      "enabled" : true
    } ],
    "tests" : [ {
      "datasetSetting" : {
        "selectionType" : "COUNT",
        "endIdx" : 7,
        "indexes" : [ 1, 1 ],
        "startIdx" : 6,
        "batchSize" : 4,
        "shuffle" : true,
        "workers" : 7,
        "fraction" : 1.2315135,
        "numItems" : 1
      },
      "name" : "name",
      "id" : 9,
      "defenses" : [ {
        "defenseParameters" : "defenseParameters",
        "name" : "name",
        "testId" : 5,
        "filters" : [ {
          "paper_link" : "paper_link",
          "codebase_name" : "codebase_name",
          "name" : "name",
          "id" : 1,
          "type" : "type",
          "parameters" : "parameters",
          "enabled" : true,
          "tasks" : [ "tasks", "tasks" ],
          "group" : [ "group", "group" ]
        }, {
          "paper_link" : "paper_link",
          "codebase_name" : "codebase_name",
          "name" : "name",
          "id" : 1,
          "type" : "type",
          "parameters" : "parameters",
          "enabled" : true,
          "tasks" : [ "tasks", "tasks" ],
          "group" : [ "group", "group" ]
        } ],
        "id" : 4
      }, {
        "defenseParameters" : "defenseParameters",
        "name" : "name",
        "testId" : 5,
        "filters" : [ {
          "paper_link" : "paper_link",
          "codebase_name" : "codebase_name",
          "name" : "name",
          "id" : 1,
          "type" : "type",
          "parameters" : "parameters",
          "enabled" : true,
          "tasks" : [ "tasks", "tasks" ],
          "group" : [ "group", "group" ]
        }, {
          "paper_link" : "paper_link",
          "codebase_name" : "codebase_name",
          "name" : "name",
          "id" : 1,
          "type" : "type",
          "parameters" : "parameters",
          "enabled" : true,
          "tasks" : [ "tasks", "tasks" ],
          "group" : [ "group", "group" ]
        } ],
        "id" : 4
      } ],
      "status" : "CANCELLED"
    }, {
      "datasetSetting" : {
        "selectionType" : "COUNT",
        "endIdx" : 7,
        "indexes" : [ 1, 1 ],
        "startIdx" : 6,
        "batchSize" : 4,
        "shuffle" : true,
        "workers" : 7,
        "fraction" : 1.2315135,
        "numItems" : 1
      },
      "name" : "name",
      "id" : 9,
      "defenses" : [ {
        "defenseParameters" : "defenseParameters",
        "name" : "name",
        "testId" : 5,
        "filters" : [ {
          "paper_link" : "paper_link",
          "codebase_name" : "codebase_name",
          "name" : "name",
          "id" : 1,
          "type" : "type",
          "parameters" : "parameters",
          "enabled" : true,
          "tasks" : [ "tasks", "tasks" ],
          "group" : [ "group", "group" ]
        }, {
          "paper_link" : "paper_link",
          "codebase_name" : "codebase_name",
          "name" : "name",
          "id" : 1,
          "type" : "type",
          "parameters" : "parameters",
          "enabled" : true,
          "tasks" : [ "tasks", "tasks" ],
          "group" : [ "group", "group" ]
        } ],
        "id" : 4
      }, {
        "defenseParameters" : "defenseParameters",
        "name" : "name",
        "testId" : 5,
        "filters" : [ {
          "paper_link" : "paper_link",
          "codebase_name" : "codebase_name",
          "name" : "name",
          "id" : 1,
          "type" : "type",
          "parameters" : "parameters",
          "enabled" : true,
          "tasks" : [ "tasks", "tasks" ],
          "group" : [ "group", "group" ]
        }, {
          "paper_link" : "paper_link",
          "codebase_name" : "codebase_name",
          "name" : "name",
          "id" : 1,
          "type" : "type",
          "parameters" : "parameters",
          "enabled" : true,
          "tasks" : [ "tasks", "tasks" ],
          "group" : [ "group", "group" ]
        } ],
        "id" : 4
      } ],
      "status" : "CANCELLED"
    } ],
    "tasks" : [ "tasks", "tasks" ]
  },
  "name" : "name"
}' \
 -d '<BenchmarkRequest>
  <name>aeiou</name>
</BenchmarkRequest>'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BenchmarkApi;

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

public class BenchmarkApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        BenchmarkApi apiInstance = new BenchmarkApi();
        Long id = 789; // Long | The benchmark ID.
        BenchmarkRequest benchmarkRequest = ; // BenchmarkRequest | 

        try {
            BenchmarkResponse result = apiInstance.updateBenchmark(id, benchmarkRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BenchmarkApi#updateBenchmark");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.BenchmarkApi;

public class BenchmarkApiExample {
    public static void main(String[] args) {
        BenchmarkApi apiInstance = new BenchmarkApi();
        Long id = 789; // Long | The benchmark ID.
        BenchmarkRequest benchmarkRequest = ; // BenchmarkRequest | 

        try {
            BenchmarkResponse result = apiInstance.updateBenchmark(id, benchmarkRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BenchmarkApi#updateBenchmark");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
BenchmarkApi *apiInstance = [[BenchmarkApi alloc] init];
Long *id = 789; // The benchmark ID. (default to null)
BenchmarkRequest *benchmarkRequest = ; // 

// Update benchmark.
[apiInstance updateBenchmarkWith:id
    benchmarkRequest:benchmarkRequest
              completionHandler: ^(BenchmarkResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.BenchmarkApi()
var id = 789; // {Long} The benchmark ID.
var benchmarkRequest = ; // {BenchmarkRequest} 

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

namespace Example
{
    public class updateBenchmarkExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new BenchmarkApi();
            var id = 789;  // Long | The benchmark ID. (default to null)
            var benchmarkRequest = new BenchmarkRequest(); // BenchmarkRequest | 

            try {
                // Update benchmark.
                BenchmarkResponse result = apiInstance.updateBenchmark(id, benchmarkRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BenchmarkApi.updateBenchmark: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BenchmarkApi();
$id = 789; // Long | The benchmark ID.
$benchmarkRequest = ; // BenchmarkRequest | 

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BenchmarkApi->new();
my $id = 789; # Long | The benchmark ID.
my $benchmarkRequest = WWW::OPenAPIClient::Object::BenchmarkRequest->new(); # BenchmarkRequest | 

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

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

# Create an instance of the API class
api_instance = openapi_client.BenchmarkApi()
id = 789 # Long | The benchmark ID. (default to null)
benchmarkRequest =  # BenchmarkRequest | 

try:
    # Update benchmark.
    api_response = api_instance.update_benchmark(id, benchmarkRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BenchmarkApi->updateBenchmark: %s\n" % e)
extern crate BenchmarkApi;

pub fn main() {
    let id = 789; // Long
    let benchmarkRequest = ; // BenchmarkRequest

    let mut context = BenchmarkApi::Context::default();
    let result = client.updateBenchmark(id, benchmarkRequest, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The benchmark ID.
Required
Body parameters
Name Description
benchmarkRequest *

benchmarkRequest

Responses


updateBenchmarkTest

Update test.


/api/v1/benchmarks/{id}/{testId}

Usage and SDK Samples

curl -X PUT \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: application/json,application/xml" \
 "http://localhost:8082/api/v1/benchmarks/{id}/{testId}" \
 -d '{
  "defense" : {
    "defenseParameters" : "defenseParameters",
    "name" : "name",
    "testId" : 5,
    "filters" : [ {
      "paper_link" : "paper_link",
      "codebase_name" : "codebase_name",
      "name" : "name",
      "id" : 1,
      "type" : "type",
      "parameters" : "parameters",
      "enabled" : true,
      "tasks" : [ "tasks", "tasks" ],
      "group" : [ "group", "group" ]
    }, {
      "paper_link" : "paper_link",
      "codebase_name" : "codebase_name",
      "name" : "name",
      "id" : 1,
      "type" : "type",
      "parameters" : "parameters",
      "enabled" : true,
      "tasks" : [ "tasks", "tasks" ],
      "group" : [ "group", "group" ]
    } ],
    "id" : 4
  },
  "name" : "name"
}' \
 -d '<BenchmarkTestRequest>
  <name>aeiou</name>
</BenchmarkTestRequest>'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BenchmarkApi;

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

public class BenchmarkApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        BenchmarkApi apiInstance = new BenchmarkApi();
        Long id = 789; // Long | The benchmark ID.
        Integer testId = 56; // Integer | The test ID.
        BenchmarkTestRequest testRequest = ; // BenchmarkTestRequest | 

        try {
            BenchmarkTest result = apiInstance.updateBenchmarkTest(id, testId, testRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BenchmarkApi#updateBenchmarkTest");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.BenchmarkApi;

public class BenchmarkApiExample {
    public static void main(String[] args) {
        BenchmarkApi apiInstance = new BenchmarkApi();
        Long id = 789; // Long | The benchmark ID.
        Integer testId = 56; // Integer | The test ID.
        BenchmarkTestRequest testRequest = ; // BenchmarkTestRequest | 

        try {
            BenchmarkTest result = apiInstance.updateBenchmarkTest(id, testId, testRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BenchmarkApi#updateBenchmarkTest");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
BenchmarkApi *apiInstance = [[BenchmarkApi alloc] init];
Long *id = 789; // The benchmark ID. (default to null)
Integer *testId = 56; // The test ID. (default to null)
BenchmarkTestRequest *testRequest = ; // 

// Update test.
[apiInstance updateBenchmarkTestWith:id
    testId:testId
    testRequest:testRequest
              completionHandler: ^(BenchmarkTest output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.BenchmarkApi()
var id = 789; // {Long} The benchmark ID.
var testId = 56; // {Integer} The test ID.
var testRequest = ; // {BenchmarkTestRequest} 

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

namespace Example
{
    public class updateBenchmarkTestExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new BenchmarkApi();
            var id = 789;  // Long | The benchmark ID. (default to null)
            var testId = 56;  // Integer | The test ID. (default to null)
            var testRequest = new BenchmarkTestRequest(); // BenchmarkTestRequest | 

            try {
                // Update test.
                BenchmarkTest result = apiInstance.updateBenchmarkTest(id, testId, testRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BenchmarkApi.updateBenchmarkTest: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BenchmarkApi();
$id = 789; // Long | The benchmark ID.
$testId = 56; // Integer | The test ID.
$testRequest = ; // BenchmarkTestRequest | 

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BenchmarkApi->new();
my $id = 789; # Long | The benchmark ID.
my $testId = 56; # Integer | The test ID.
my $testRequest = WWW::OPenAPIClient::Object::BenchmarkTestRequest->new(); # BenchmarkTestRequest | 

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

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

# Create an instance of the API class
api_instance = openapi_client.BenchmarkApi()
id = 789 # Long | The benchmark ID. (default to null)
testId = 56 # Integer | The test ID. (default to null)
testRequest =  # BenchmarkTestRequest | 

try:
    # Update test.
    api_response = api_instance.update_benchmark_test(id, testId, testRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BenchmarkApi->updateBenchmarkTest: %s\n" % e)
extern crate BenchmarkApi;

pub fn main() {
    let id = 789; // Long
    let testId = 56; // Integer
    let testRequest = ; // BenchmarkTestRequest

    let mut context = BenchmarkApi::Context::default();
    let result = client.updateBenchmarkTest(id, testId, testRequest, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The benchmark ID.
Required
testId*
Integer (int32)
The test ID.
Required
Body parameters
Name Description
testRequest *

The test update request.

Responses


Datasets

copyDataset

Make a copy of a custom dataset. To copy to a different organization, extra permissions are required.


/api/v1/datasets/{id}/copy

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/datasets/{id}/copy?orgId=789"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DatasetsApi;

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

public class DatasetsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DatasetsApi apiInstance = new DatasetsApi();
        Long id = 789; // Long | The dataset ID.
        Long orgId = 789; // Long | Optional organization ID to copy to.

        try {
            DataSet result = apiInstance.copyDataset(id, orgId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasetsApi#copyDataset");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DatasetsApi;

public class DatasetsApiExample {
    public static void main(String[] args) {
        DatasetsApi apiInstance = new DatasetsApi();
        Long id = 789; // Long | The dataset ID.
        Long orgId = 789; // Long | Optional organization ID to copy to.

        try {
            DataSet result = apiInstance.copyDataset(id, orgId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasetsApi#copyDataset");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
DatasetsApi *apiInstance = [[DatasetsApi alloc] init];
Long *id = 789; // The dataset ID. (default to null)
Long *orgId = 789; // Optional organization ID to copy to. (optional) (default to null)

// Make a copy of a custom dataset. To copy to a different organization, extra permissions are required.
[apiInstance copyDatasetWith:id
    orgId:orgId
              completionHandler: ^(DataSet output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.DatasetsApi()
var id = 789; // {Long} The dataset ID.
var opts = {
  'orgId': 789 // {Long} Optional organization ID to copy to.
};

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

namespace Example
{
    public class copyDatasetExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DatasetsApi();
            var id = 789;  // Long | The dataset ID. (default to null)
            var orgId = 789;  // Long | Optional organization ID to copy to. (optional)  (default to null)

            try {
                // Make a copy of a custom dataset. To copy to a different organization, extra permissions are required.
                DataSet result = apiInstance.copyDataset(id, orgId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DatasetsApi.copyDataset: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DatasetsApi();
$id = 789; // Long | The dataset ID.
$orgId = 789; // Long | Optional organization ID to copy to.

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DatasetsApi->new();
my $id = 789; # Long | The dataset ID.
my $orgId = 789; # Long | Optional organization ID to copy to.

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

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

# Create an instance of the API class
api_instance = openapi_client.DatasetsApi()
id = 789 # Long | The dataset ID. (default to null)
orgId = 789 # Long | Optional organization ID to copy to. (optional) (default to null)

try:
    # Make a copy of a custom dataset. To copy to a different organization, extra permissions are required.
    api_response = api_instance.copy_dataset(id, orgId=orgId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->copyDataset: %s\n" % e)
extern crate DatasetsApi;

pub fn main() {
    let id = 789; // Long
    let orgId = 789; // Long

    let mut context = DatasetsApi::Context::default();
    let result = client.copyDataset(id, orgId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The dataset ID.
Required
Query parameters
Name Description
orgId
Long (int64)
Optional organization ID to copy to.

Responses


deleteCustomDataset

Delete dataset.


/api/v1/datasets/{id}/{orgId}

Usage and SDK Samples

curl -X DELETE \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/datasets/{id}/{orgId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DatasetsApi;

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

public class DatasetsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DatasetsApi apiInstance = new DatasetsApi();
        Long id = 789; // Long | The dataset ID.
        Long orgId = 789; // Long | The organization ID.

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

public class DatasetsApiExample {
    public static void main(String[] args) {
        DatasetsApi apiInstance = new DatasetsApi();
        Long id = 789; // Long | The dataset ID.
        Long orgId = 789; // Long | The organization ID.

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

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
DatasetsApi *apiInstance = [[DatasetsApi alloc] init];
Long *id = 789; // The dataset ID. (default to null)
Long *orgId = 789; // The organization ID. (default to null)

// Delete dataset.
[apiInstance deleteCustomDatasetWith:id
    orgId:orgId
              completionHandler: ^(array[DataSet] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.DatasetsApi()
var id = 789; // {Long} The dataset ID.
var orgId = 789; // {Long} The organization ID.

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

namespace Example
{
    public class deleteCustomDatasetExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DatasetsApi();
            var id = 789;  // Long | The dataset ID. (default to null)
            var orgId = 789;  // Long | The organization ID. (default to null)

            try {
                // Delete dataset.
                array[DataSet] result = apiInstance.deleteCustomDataset(id, orgId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DatasetsApi.deleteCustomDataset: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DatasetsApi();
$id = 789; // Long | The dataset ID.
$orgId = 789; // Long | The organization ID.

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DatasetsApi->new();
my $id = 789; # Long | The dataset ID.
my $orgId = 789; # Long | The organization ID.

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

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

# Create an instance of the API class
api_instance = openapi_client.DatasetsApi()
id = 789 # Long | The dataset ID. (default to null)
orgId = 789 # Long | The organization ID. (default to null)

try:
    # Delete dataset.
    api_response = api_instance.delete_custom_dataset(id, orgId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->deleteCustomDataset: %s\n" % e)
extern crate DatasetsApi;

pub fn main() {
    let id = 789; // Long
    let orgId = 789; // Long

    let mut context = DatasetsApi::Context::default();
    let result = client.deleteCustomDataset(id, orgId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The dataset ID.
Required
orgId*
Long (int64)
The organization ID.
Required

Responses


downloadDataset

Download dataset data.


/api/v1/datasets/{id}/{orgId}/data

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/datasets/{id}/{orgId}/data"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DatasetsApi;

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

public class DatasetsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DatasetsApi apiInstance = new DatasetsApi();
        Long id = 789; // Long | The dataset ID.
        Long orgId = 789; // Long | The organization ID.

        try {
            File result = apiInstance.downloadDataset(id, orgId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasetsApi#downloadDataset");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DatasetsApi;

public class DatasetsApiExample {
    public static void main(String[] args) {
        DatasetsApi apiInstance = new DatasetsApi();
        Long id = 789; // Long | The dataset ID.
        Long orgId = 789; // Long | The organization ID.

        try {
            File result = apiInstance.downloadDataset(id, orgId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasetsApi#downloadDataset");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
DatasetsApi *apiInstance = [[DatasetsApi alloc] init];
Long *id = 789; // The dataset ID. (default to null)
Long *orgId = 789; // The organization ID. (default to null)

// Download dataset data.
[apiInstance downloadDatasetWith:id
    orgId:orgId
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.DatasetsApi()
var id = 789; // {Long} The dataset ID.
var orgId = 789; // {Long} The organization ID.

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

namespace Example
{
    public class downloadDatasetExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DatasetsApi();
            var id = 789;  // Long | The dataset ID. (default to null)
            var orgId = 789;  // Long | The organization ID. (default to null)

            try {
                // Download dataset data.
                File result = apiInstance.downloadDataset(id, orgId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DatasetsApi.downloadDataset: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DatasetsApi();
$id = 789; // Long | The dataset ID.
$orgId = 789; // Long | The organization ID.

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DatasetsApi->new();
my $id = 789; # Long | The dataset ID.
my $orgId = 789; # Long | The organization ID.

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

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

# Create an instance of the API class
api_instance = openapi_client.DatasetsApi()
id = 789 # Long | The dataset ID. (default to null)
orgId = 789 # Long | The organization ID. (default to null)

try:
    # Download dataset data.
    api_response = api_instance.download_dataset(id, orgId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->downloadDataset: %s\n" % e)
extern crate DatasetsApi;

pub fn main() {
    let id = 789; // Long
    let orgId = 789; // Long

    let mut context = DatasetsApi::Context::default();
    let result = client.downloadDataset(id, orgId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The dataset ID.
Required
orgId*
Long (int64)
The organization ID.
Required

Responses


getDataset

Get dataset.


/api/v1/datasets/{id}/{orgId}

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/datasets/{id}/{orgId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DatasetsApi;

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

public class DatasetsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DatasetsApi apiInstance = new DatasetsApi();
        Long id = 789; // Long | The dataset ID.
        Long orgId = 789; // Long | The organization ID.

        try {
            DataSet result = apiInstance.getDataset(id, orgId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasetsApi#getDataset");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DatasetsApi;

public class DatasetsApiExample {
    public static void main(String[] args) {
        DatasetsApi apiInstance = new DatasetsApi();
        Long id = 789; // Long | The dataset ID.
        Long orgId = 789; // Long | The organization ID.

        try {
            DataSet result = apiInstance.getDataset(id, orgId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasetsApi#getDataset");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
DatasetsApi *apiInstance = [[DatasetsApi alloc] init];
Long *id = 789; // The dataset ID. (default to null)
Long *orgId = 789; // The organization ID. (default to null)

// Get dataset.
[apiInstance getDatasetWith:id
    orgId:orgId
              completionHandler: ^(DataSet output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.DatasetsApi()
var id = 789; // {Long} The dataset ID.
var orgId = 789; // {Long} The organization ID.

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

namespace Example
{
    public class getDatasetExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DatasetsApi();
            var id = 789;  // Long | The dataset ID. (default to null)
            var orgId = 789;  // Long | The organization ID. (default to null)

            try {
                // Get dataset.
                DataSet result = apiInstance.getDataset(id, orgId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DatasetsApi.getDataset: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DatasetsApi();
$id = 789; // Long | The dataset ID.
$orgId = 789; // Long | The organization ID.

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DatasetsApi->new();
my $id = 789; # Long | The dataset ID.
my $orgId = 789; # Long | The organization ID.

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

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

# Create an instance of the API class
api_instance = openapi_client.DatasetsApi()
id = 789 # Long | The dataset ID. (default to null)
orgId = 789 # Long | The organization ID. (default to null)

try:
    # Get dataset.
    api_response = api_instance.get_dataset(id, orgId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->getDataset: %s\n" % e)
extern crate DatasetsApi;

pub fn main() {
    let id = 789; // Long
    let orgId = 789; // Long

    let mut context = DatasetsApi::Context::default();
    let result = client.getDataset(id, orgId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The dataset ID.
Required
orgId*
Long (int64)
The organization ID.
Required

Responses


getDatasetClasses

Retrieve dataset classes (coco dataset supported).


/api/v1/datasets/{id}/{orgId}/classes

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/datasets/{id}/{orgId}/classes"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DatasetsApi;

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

public class DatasetsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DatasetsApi apiInstance = new DatasetsApi();
        Long id = 789; // Long | The dataset ID.
        Long orgId = 789; // Long | The organization ID.

        try {
            array['String'] result = apiInstance.getDatasetClasses(id, orgId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasetsApi#getDatasetClasses");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DatasetsApi;

public class DatasetsApiExample {
    public static void main(String[] args) {
        DatasetsApi apiInstance = new DatasetsApi();
        Long id = 789; // Long | The dataset ID.
        Long orgId = 789; // Long | The organization ID.

        try {
            array['String'] result = apiInstance.getDatasetClasses(id, orgId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasetsApi#getDatasetClasses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
DatasetsApi *apiInstance = [[DatasetsApi alloc] init];
Long *id = 789; // The dataset ID. (default to null)
Long *orgId = 789; // The organization ID. (default to null)

// Retrieve dataset classes (coco dataset supported).
[apiInstance getDatasetClassesWith:id
    orgId:orgId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.DatasetsApi()
var id = 789; // {Long} The dataset ID.
var orgId = 789; // {Long} The organization ID.

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

namespace Example
{
    public class getDatasetClassesExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DatasetsApi();
            var id = 789;  // Long | The dataset ID. (default to null)
            var orgId = 789;  // Long | The organization ID. (default to null)

            try {
                // Retrieve dataset classes (coco dataset supported).
                array['String'] result = apiInstance.getDatasetClasses(id, orgId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DatasetsApi.getDatasetClasses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DatasetsApi();
$id = 789; // Long | The dataset ID.
$orgId = 789; // Long | The organization ID.

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DatasetsApi->new();
my $id = 789; # Long | The dataset ID.
my $orgId = 789; # Long | The organization ID.

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

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

# Create an instance of the API class
api_instance = openapi_client.DatasetsApi()
id = 789 # Long | The dataset ID. (default to null)
orgId = 789 # Long | The organization ID. (default to null)

try:
    # Retrieve dataset classes (coco dataset supported).
    api_response = api_instance.get_dataset_classes(id, orgId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->getDatasetClasses: %s\n" % e)
extern crate DatasetsApi;

pub fn main() {
    let id = 789; // Long
    let orgId = 789; // Long

    let mut context = DatasetsApi::Context::default();
    let result = client.getDatasetClasses(id, orgId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The dataset ID.
Required
orgId*
Long (int64)
The organization ID.
Required

Responses


getDatasetItem

Get an item from the dataset.


/api/v1/datasets/{id}/{idx}/item

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/datasets/{id}/{idx}/item"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DatasetsApi;

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

public class DatasetsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DatasetsApi apiInstance = new DatasetsApi();
        Long id = 789; // Long | The dataset ID.
        Long idx = 789; // Long | The item index.

        try {
            File result = apiInstance.getDatasetItem(id, idx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasetsApi#getDatasetItem");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DatasetsApi;

public class DatasetsApiExample {
    public static void main(String[] args) {
        DatasetsApi apiInstance = new DatasetsApi();
        Long id = 789; // Long | The dataset ID.
        Long idx = 789; // Long | The item index.

        try {
            File result = apiInstance.getDatasetItem(id, idx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasetsApi#getDatasetItem");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
DatasetsApi *apiInstance = [[DatasetsApi alloc] init];
Long *id = 789; // The dataset ID. (default to null)
Long *idx = 789; // The item index. (default to null)

// Get an item from the dataset.
[apiInstance getDatasetItemWith:id
    idx:idx
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.DatasetsApi()
var id = 789; // {Long} The dataset ID.
var idx = 789; // {Long} The item index.

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

namespace Example
{
    public class getDatasetItemExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DatasetsApi();
            var id = 789;  // Long | The dataset ID. (default to null)
            var idx = 789;  // Long | The item index. (default to null)

            try {
                // Get an item from the dataset.
                File result = apiInstance.getDatasetItem(id, idx);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DatasetsApi.getDatasetItem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DatasetsApi();
$id = 789; // Long | The dataset ID.
$idx = 789; // Long | The item index.

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DatasetsApi->new();
my $id = 789; # Long | The dataset ID.
my $idx = 789; # Long | The item index.

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

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

# Create an instance of the API class
api_instance = openapi_client.DatasetsApi()
id = 789 # Long | The dataset ID. (default to null)
idx = 789 # Long | The item index. (default to null)

try:
    # Get an item from the dataset.
    api_response = api_instance.get_dataset_item(id, idx)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->getDatasetItem: %s\n" % e)
extern crate DatasetsApi;

pub fn main() {
    let id = 789; // Long
    let idx = 789; // Long

    let mut context = DatasetsApi::Context::default();
    let result = client.getDatasetItem(id, idx, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The dataset ID.
Required
idx*
Long (int64)
The item index.
Required

Responses


getDatasetTarget

Get a target from the dataset.


/api/v1/datasets/{id}/{idx}/target

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/datasets/{id}/{idx}/target"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DatasetsApi;

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

public class DatasetsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DatasetsApi apiInstance = new DatasetsApi();
        Long id = 789; // Long | The dataset ID.
        Long idx = 789; // Long | The item index.

        try {
            DatasetTarget result = apiInstance.getDatasetTarget(id, idx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasetsApi#getDatasetTarget");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DatasetsApi;

public class DatasetsApiExample {
    public static void main(String[] args) {
        DatasetsApi apiInstance = new DatasetsApi();
        Long id = 789; // Long | The dataset ID.
        Long idx = 789; // Long | The item index.

        try {
            DatasetTarget result = apiInstance.getDatasetTarget(id, idx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasetsApi#getDatasetTarget");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
DatasetsApi *apiInstance = [[DatasetsApi alloc] init];
Long *id = 789; // The dataset ID. (default to null)
Long *idx = 789; // The item index. (default to null)

// Get a target from the dataset.
[apiInstance getDatasetTargetWith:id
    idx:idx
              completionHandler: ^(DatasetTarget output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.DatasetsApi()
var id = 789; // {Long} The dataset ID.
var idx = 789; // {Long} The item index.

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

namespace Example
{
    public class getDatasetTargetExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DatasetsApi();
            var id = 789;  // Long | The dataset ID. (default to null)
            var idx = 789;  // Long | The item index. (default to null)

            try {
                // Get a target from the dataset.
                DatasetTarget result = apiInstance.getDatasetTarget(id, idx);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DatasetsApi.getDatasetTarget: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DatasetsApi();
$id = 789; // Long | The dataset ID.
$idx = 789; // Long | The item index.

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DatasetsApi->new();
my $id = 789; # Long | The dataset ID.
my $idx = 789; # Long | The item index.

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

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

# Create an instance of the API class
api_instance = openapi_client.DatasetsApi()
id = 789 # Long | The dataset ID. (default to null)
idx = 789 # Long | The item index. (default to null)

try:
    # Get a target from the dataset.
    api_response = api_instance.get_dataset_target(id, idx)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->getDatasetTarget: %s\n" % e)
extern crate DatasetsApi;

pub fn main() {
    let id = 789; // Long
    let idx = 789; // Long

    let mut context = DatasetsApi::Context::default();
    let result = client.getDatasetTarget(id, idx, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The dataset ID.
Required
idx*
Long (int64)
The item index.
Required

Responses


getDatasets

Get the datasets defined for this organization.


/api/v1/datasets/{orgId}

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/datasets/{orgId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DatasetsApi;

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

public class DatasetsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DatasetsApi apiInstance = new DatasetsApi();
        Long orgId = 789; // Long | The organization ID.

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

public class DatasetsApiExample {
    public static void main(String[] args) {
        DatasetsApi apiInstance = new DatasetsApi();
        Long orgId = 789; // Long | The organization ID.

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

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
DatasetsApi *apiInstance = [[DatasetsApi alloc] init];
Long *orgId = 789; // The organization ID. (default to null)

// Get the datasets defined for this organization.
[apiInstance getDatasetsWith:orgId
              completionHandler: ^(array[DataSet] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.DatasetsApi()
var orgId = 789; // {Long} The organization ID.

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

namespace Example
{
    public class getDatasetsExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DatasetsApi();
            var orgId = 789;  // Long | The organization ID. (default to null)

            try {
                // Get the datasets defined for this organization.
                array[DataSet] result = apiInstance.getDatasets(orgId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DatasetsApi.getDatasets: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DatasetsApi();
$orgId = 789; // Long | The organization ID.

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DatasetsApi->new();
my $orgId = 789; # Long | The organization ID.

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

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

# Create an instance of the API class
api_instance = openapi_client.DatasetsApi()
orgId = 789 # Long | The organization ID. (default to null)

try:
    # Get the datasets defined for this organization.
    api_response = api_instance.get_datasets(orgId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->getDatasets: %s\n" % e)
extern crate DatasetsApi;

pub fn main() {
    let orgId = 789; // Long

    let mut context = DatasetsApi::Context::default();
    let result = client.getDatasets(orgId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
orgId*
Long (int64)
The organization ID.
Required

Responses


updateCustomDataset

Update dataset.


/api/v1/datasets/{id}/{orgId}

Usage and SDK Samples

curl -X PUT \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: application/json,application/xml" \
 "http://localhost:8082/api/v1/datasets/{id}/{orgId}" \
 -d '{
  "settings" : {
    "params" : "{}"
  },
  "format" : "format",
  "name" : "name",
  "transforms" : [ {
    "name" : "name",
    "id" : 1,
    "params" : "{}"
  }, {
    "name" : "name",
    "id" : 1,
    "params" : "{}"
  } ],
  "description" : "description"
}' \
 -d '<DatasetRequest>
  <description>aeiou</description>
  <format>aeiou</format>
  <name>aeiou</name>
</DatasetRequest>'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DatasetsApi;

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

public class DatasetsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DatasetsApi apiInstance = new DatasetsApi();
        Long id = 789; // Long | The dataset ID.
        Long orgId = 789; // Long | The organization ID.
        DatasetRequest datasetRequest = ; // DatasetRequest | 

        try {
            array[DataSet] result = apiInstance.updateCustomDataset(id, orgId, datasetRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasetsApi#updateCustomDataset");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DatasetsApi;

public class DatasetsApiExample {
    public static void main(String[] args) {
        DatasetsApi apiInstance = new DatasetsApi();
        Long id = 789; // Long | The dataset ID.
        Long orgId = 789; // Long | The organization ID.
        DatasetRequest datasetRequest = ; // DatasetRequest | 

        try {
            array[DataSet] result = apiInstance.updateCustomDataset(id, orgId, datasetRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasetsApi#updateCustomDataset");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
DatasetsApi *apiInstance = [[DatasetsApi alloc] init];
Long *id = 789; // The dataset ID. (default to null)
Long *orgId = 789; // The organization ID. (default to null)
DatasetRequest *datasetRequest = ; // 

// Update dataset.
[apiInstance updateCustomDatasetWith:id
    orgId:orgId
    datasetRequest:datasetRequest
              completionHandler: ^(array[DataSet] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.DatasetsApi()
var id = 789; // {Long} The dataset ID.
var orgId = 789; // {Long} The organization ID.
var datasetRequest = ; // {DatasetRequest} 

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

namespace Example
{
    public class updateCustomDatasetExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DatasetsApi();
            var id = 789;  // Long | The dataset ID. (default to null)
            var orgId = 789;  // Long | The organization ID. (default to null)
            var datasetRequest = new DatasetRequest(); // DatasetRequest | 

            try {
                // Update dataset.
                array[DataSet] result = apiInstance.updateCustomDataset(id, orgId, datasetRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DatasetsApi.updateCustomDataset: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DatasetsApi();
$id = 789; // Long | The dataset ID.
$orgId = 789; // Long | The organization ID.
$datasetRequest = ; // DatasetRequest | 

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DatasetsApi->new();
my $id = 789; # Long | The dataset ID.
my $orgId = 789; # Long | The organization ID.
my $datasetRequest = WWW::OPenAPIClient::Object::DatasetRequest->new(); # DatasetRequest | 

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

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

# Create an instance of the API class
api_instance = openapi_client.DatasetsApi()
id = 789 # Long | The dataset ID. (default to null)
orgId = 789 # Long | The organization ID. (default to null)
datasetRequest =  # DatasetRequest | 

try:
    # Update dataset.
    api_response = api_instance.update_custom_dataset(id, orgId, datasetRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->updateCustomDataset: %s\n" % e)
extern crate DatasetsApi;

pub fn main() {
    let id = 789; // Long
    let orgId = 789; // Long
    let datasetRequest = ; // DatasetRequest

    let mut context = DatasetsApi::Context::default();
    let result = client.updateCustomDataset(id, orgId, datasetRequest, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The dataset ID.
Required
orgId*
Long (int64)
The organization ID.
Required
Body parameters
Name Description
datasetRequest *

The dataset update request.

Responses


uploadDataset

Upload dataset.


/api/v1/datasets/{orgId}

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: multipart/form-data" \
 "http://localhost:8082/api/v1/datasets/{orgId}?description=description_example&format=format_example&name=name_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DatasetsApi;

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

public class DatasetsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DatasetsApi apiInstance = new DatasetsApi();
        String description = description_example; // String | description
        String format = format_example; // String | format
        String name = name_example; // String | name
        Long orgId = 789; // Long | The organization ID.
        File file = BINARY_DATA_HERE; // File | 

        try {
            array[DataSet] result = apiInstance.uploadDataset(description, format, name, orgId, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasetsApi#uploadDataset");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DatasetsApi;

public class DatasetsApiExample {
    public static void main(String[] args) {
        DatasetsApi apiInstance = new DatasetsApi();
        String description = description_example; // String | description
        String format = format_example; // String | format
        String name = name_example; // String | name
        Long orgId = 789; // Long | The organization ID.
        File file = BINARY_DATA_HERE; // File | 

        try {
            array[DataSet] result = apiInstance.uploadDataset(description, format, name, orgId, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasetsApi#uploadDataset");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
DatasetsApi *apiInstance = [[DatasetsApi alloc] init];
String *description = description_example; // description (default to null)
String *format = format_example; // format (default to null)
String *name = name_example; // name (default to null)
Long *orgId = 789; // The organization ID. (default to null)
File *file = BINARY_DATA_HERE; //  (optional) (default to null)

// Upload dataset.
[apiInstance uploadDatasetWith:description
    format:format
    name:name
    orgId:orgId
    file:file
              completionHandler: ^(array[DataSet] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.DatasetsApi()
var description = description_example; // {String} description
var format = format_example; // {String} format
var name = name_example; // {String} name
var orgId = 789; // {Long} The organization ID.
var opts = {
  'file': BINARY_DATA_HERE // {File} 
};

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

namespace Example
{
    public class uploadDatasetExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DatasetsApi();
            var description = description_example;  // String | description (default to null)
            var format = format_example;  // String | format (default to null)
            var name = name_example;  // String | name (default to null)
            var orgId = 789;  // Long | The organization ID. (default to null)
            var file = BINARY_DATA_HERE;  // File |  (optional)  (default to null)

            try {
                // Upload dataset.
                array[DataSet] result = apiInstance.uploadDataset(description, format, name, orgId, file);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DatasetsApi.uploadDataset: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DatasetsApi();
$description = description_example; // String | description
$format = format_example; // String | format
$name = name_example; // String | name
$orgId = 789; // Long | The organization ID.
$file = BINARY_DATA_HERE; // File | 

try {
    $result = $api_instance->uploadDataset($description, $format, $name, $orgId, $file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DatasetsApi->uploadDataset: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DatasetsApi;

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DatasetsApi->new();
my $description = description_example; # String | description
my $format = format_example; # String | format
my $name = name_example; # String | name
my $orgId = 789; # Long | The organization ID.
my $file = BINARY_DATA_HERE; # File | 

eval {
    my $result = $api_instance->uploadDataset(description => $description, format => $format, name => $name, orgId => $orgId, file => $file);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DatasetsApi->uploadDataset: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

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

# Create an instance of the API class
api_instance = openapi_client.DatasetsApi()
description = description_example # String | description (default to null)
format = format_example # String | format (default to null)
name = name_example # String | name (default to null)
orgId = 789 # Long | The organization ID. (default to null)
file = BINARY_DATA_HERE # File |  (optional) (default to null)

try:
    # Upload dataset.
    api_response = api_instance.upload_dataset(description, format, name, orgId, file=file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->uploadDataset: %s\n" % e)
extern crate DatasetsApi;

pub fn main() {
    let description = description_example; // String
    let format = format_example; // String
    let name = name_example; // String
    let orgId = 789; // Long
    let file = BINARY_DATA_HERE; // File

    let mut context = DatasetsApi::Context::default();
    let result = client.uploadDataset(description, format, name, orgId, file, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
orgId*
Long (int64)
The organization ID.
Required
Form parameters
Name Description
file
File (binary)
Query parameters
Name Description
description*
String
description
Required
format*
String
format
Required
name*
String
name
Required

Responses


uploadDatasetFile

Upload a file to the dataset and return a reference.


/api/v1/datasets/{id}/file

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: multipart/form-data" \
 "http://localhost:8082/api/v1/datasets/{id}/file?orgId=789&type=type_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DatasetsApi;

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

public class DatasetsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DatasetsApi apiInstance = new DatasetsApi();
        Long id = 789; // Long | The dataset ID.
        String type = type_example; // String | Upload type - i.e. 'transform' for transform parameters
        Long orgId = 789; // Long | The organization ID.
        File file = BINARY_DATA_HERE; // File | 

        try {
            'String' result = apiInstance.uploadDatasetFile(id, type, orgId, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasetsApi#uploadDatasetFile");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DatasetsApi;

public class DatasetsApiExample {
    public static void main(String[] args) {
        DatasetsApi apiInstance = new DatasetsApi();
        Long id = 789; // Long | The dataset ID.
        String type = type_example; // String | Upload type - i.e. 'transform' for transform parameters
        Long orgId = 789; // Long | The organization ID.
        File file = BINARY_DATA_HERE; // File | 

        try {
            'String' result = apiInstance.uploadDatasetFile(id, type, orgId, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasetsApi#uploadDatasetFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
DatasetsApi *apiInstance = [[DatasetsApi alloc] init];
Long *id = 789; // The dataset ID. (default to null)
String *type = type_example; // Upload type - i.e. 'transform' for transform parameters (default to null)
Long *orgId = 789; // The organization ID. (optional) (default to null)
File *file = BINARY_DATA_HERE; //  (optional) (default to null)

// Upload a file to the dataset and return a reference.
[apiInstance uploadDatasetFileWith:id
    type:type
    orgId:orgId
    file:file
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.DatasetsApi()
var id = 789; // {Long} The dataset ID.
var type = type_example; // {String} Upload type - i.e. 'transform' for transform parameters
var opts = {
  'orgId': 789, // {Long} The organization ID.
  'file': BINARY_DATA_HERE // {File} 
};

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

namespace Example
{
    public class uploadDatasetFileExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DatasetsApi();
            var id = 789;  // Long | The dataset ID. (default to null)
            var type = type_example;  // String | Upload type - i.e. 'transform' for transform parameters (default to null)
            var orgId = 789;  // Long | The organization ID. (optional)  (default to null)
            var file = BINARY_DATA_HERE;  // File |  (optional)  (default to null)

            try {
                // Upload a file to the dataset and return a reference.
                'String' result = apiInstance.uploadDatasetFile(id, type, orgId, file);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DatasetsApi.uploadDatasetFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DatasetsApi();
$id = 789; // Long | The dataset ID.
$type = type_example; // String | Upload type - i.e. 'transform' for transform parameters
$orgId = 789; // Long | The organization ID.
$file = BINARY_DATA_HERE; // File | 

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DatasetsApi->new();
my $id = 789; # Long | The dataset ID.
my $type = type_example; # String | Upload type - i.e. 'transform' for transform parameters
my $orgId = 789; # Long | The organization ID.
my $file = BINARY_DATA_HERE; # File | 

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

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

# Create an instance of the API class
api_instance = openapi_client.DatasetsApi()
id = 789 # Long | The dataset ID. (default to null)
type = type_example # String | Upload type - i.e. 'transform' for transform parameters (default to null)
orgId = 789 # Long | The organization ID. (optional) (default to null)
file = BINARY_DATA_HERE # File |  (optional) (default to null)

try:
    # Upload a file to the dataset and return a reference.
    api_response = api_instance.upload_dataset_file(id, type, orgId=orgId, file=file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->uploadDatasetFile: %s\n" % e)
extern crate DatasetsApi;

pub fn main() {
    let id = 789; // Long
    let type = type_example; // String
    let orgId = 789; // Long
    let file = BINARY_DATA_HERE; // File

    let mut context = DatasetsApi::Context::default();
    let result = client.uploadDatasetFile(id, type, orgId, file, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The dataset ID.
Required
Form parameters
Name Description
file
File (binary)
Query parameters
Name Description
orgId
Long (int64)
The organization ID.
type*
String
Upload type - i.e. 'transform' for transform parameters
Required

Responses


Defenses

getDefense

Get a defense.


/api/v1/defenses/{id}

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/defenses/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefensesApi;

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

public class DefensesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefensesApi apiInstance = new DefensesApi();
        Long id = 789; // Long | id

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

public class DefensesApiExample {
    public static void main(String[] args) {
        DefensesApi apiInstance = new DefensesApi();
        Long id = 789; // Long | id

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

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
DefensesApi *apiInstance = [[DefensesApi alloc] init];
Long *id = 789; // id (default to null)

// Get a defense.
[apiInstance getDefenseWith:id
              completionHandler: ^(DefenseResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.DefensesApi()
var id = 789; // {Long} id

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

namespace Example
{
    public class getDefenseExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefensesApi();
            var id = 789;  // Long | id (default to null)

            try {
                // Get a defense.
                DefenseResponse result = apiInstance.getDefense(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefensesApi.getDefense: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefensesApi();
$id = 789; // Long | id

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefensesApi->new();
my $id = 789; # Long | id

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

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

# Create an instance of the API class
api_instance = openapi_client.DefensesApi()
id = 789 # Long | id (default to null)

try:
    # Get a defense.
    api_response = api_instance.get_defense(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefensesApi->getDefense: %s\n" % e)
extern crate DefensesApi;

pub fn main() {
    let id = 789; // Long

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
id
Required

Responses


updateDefense

Update defense.


/api/v1/defenses/{id}

Usage and SDK Samples

curl -X PUT \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: application/json,application/xml" \
 "http://localhost:8082/api/v1/defenses/{id}" \
 -d '{
  "name" : "name",
  "parameters" : "parameters"
}' \
 -d '<DefenseRequest>
  <name>aeiou</name>
  <parameters>aeiou</parameters>
</DefenseRequest>'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefensesApi;

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

public class DefensesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefensesApi apiInstance = new DefensesApi();
        Long id = 789; // Long | id
        DefenseRequest request = ; // DefenseRequest | 

        try {
            DefenseResponse result = apiInstance.updateDefense(id, request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefensesApi#updateDefense");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefensesApi;

public class DefensesApiExample {
    public static void main(String[] args) {
        DefensesApi apiInstance = new DefensesApi();
        Long id = 789; // Long | id
        DefenseRequest request = ; // DefenseRequest | 

        try {
            DefenseResponse result = apiInstance.updateDefense(id, request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefensesApi#updateDefense");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
DefensesApi *apiInstance = [[DefensesApi alloc] init];
Long *id = 789; // id (default to null)
DefenseRequest *request = ; // 

// Update defense.
[apiInstance updateDefenseWith:id
    request:request
              completionHandler: ^(DefenseResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.DefensesApi()
var id = 789; // {Long} id
var request = ; // {DefenseRequest} 

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

namespace Example
{
    public class updateDefenseExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefensesApi();
            var id = 789;  // Long | id (default to null)
            var request = new DefenseRequest(); // DefenseRequest | 

            try {
                // Update defense.
                DefenseResponse result = apiInstance.updateDefense(id, request);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefensesApi.updateDefense: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefensesApi();
$id = 789; // Long | id
$request = ; // DefenseRequest | 

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefensesApi->new();
my $id = 789; # Long | id
my $request = WWW::OPenAPIClient::Object::DefenseRequest->new(); # DefenseRequest | 

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

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

# Create an instance of the API class
api_instance = openapi_client.DefensesApi()
id = 789 # Long | id (default to null)
request =  # DefenseRequest | 

try:
    # Update defense.
    api_response = api_instance.update_defense(id, request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefensesApi->updateDefense: %s\n" % e)
extern crate DefensesApi;

pub fn main() {
    let id = 789; // Long
    let request = ; // DefenseRequest

    let mut context = DefensesApi::Context::default();
    let result = client.updateDefense(id, request, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
id
Required
Body parameters
Name Description
request *

request

Responses


Keys

createKey

Create API key.


/api/v1/keys

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/keys"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KeysApi;

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

public class KeysApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

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

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

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

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

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


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

// Create API key.
[apiInstance createKeyWithCompletionHandler: 
              ^(APIKeyResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

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

namespace Example
{
    public class createKeyExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

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

            try {
                // Create API key.
                APIKeyResponse result = apiInstance.createKey();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KeysApi.createKey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

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

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

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

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

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

try:
    # Create API key.
    api_response = api_instance.create_key()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KeysApi->createKey: %s\n" % e)
extern crate KeysApi;

pub fn main() {

    let mut context = KeysApi::Context::default();
    let result = client.createKey(&context).wait();

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

Scopes

Parameters

Responses


deleteKey

Delete a key.


/api/v1/keys/{id}

Usage and SDK Samples

curl -X DELETE \
-H "Authorization: [[apiKey]]" \
 "http://localhost:8082/api/v1/keys/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KeysApi;

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

public class KeysApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        KeysApi apiInstance = new KeysApi();
        Long id = 789; // Long | id

        try {
            apiInstance.deleteKey(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling KeysApi#deleteKey");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.KeysApi;

public class KeysApiExample {
    public static void main(String[] args) {
        KeysApi apiInstance = new KeysApi();
        Long id = 789; // Long | id

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

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
KeysApi *apiInstance = [[KeysApi alloc] init];
Long *id = 789; // id (default to null)

// Delete a key.
[apiInstance deleteKeyWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.KeysApi()
var id = 789; // {Long} id

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

namespace Example
{
    public class deleteKeyExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new KeysApi();
            var id = 789;  // Long | id (default to null)

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

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KeysApi();
$id = 789; // Long | id

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KeysApi->new();
my $id = 789; # Long | id

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

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

# Create an instance of the API class
api_instance = openapi_client.KeysApi()
id = 789 # Long | id (default to null)

try:
    # Delete a key.
    api_instance.delete_key(id)
except ApiException as e:
    print("Exception when calling KeysApi->deleteKey: %s\n" % e)
extern crate KeysApi;

pub fn main() {
    let id = 789; // Long

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
id
Required

Responses


getKey

Get a key.


/api/v1/keys/{id}

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/keys/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KeysApi;

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

public class KeysApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        KeysApi apiInstance = new KeysApi();
        Long id = 789; // Long | id

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

public class KeysApiExample {
    public static void main(String[] args) {
        KeysApi apiInstance = new KeysApi();
        Long id = 789; // Long | id

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

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
KeysApi *apiInstance = [[KeysApi alloc] init];
Long *id = 789; // id (default to null)

// Get a key.
[apiInstance getKeyWith:id
              completionHandler: ^(APIKeyResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.KeysApi()
var id = 789; // {Long} id

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

namespace Example
{
    public class getKeyExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new KeysApi();
            var id = 789;  // Long | id (default to null)

            try {
                // Get a key.
                APIKeyResponse result = apiInstance.getKey(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KeysApi.getKey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KeysApi();
$id = 789; // Long | id

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KeysApi->new();
my $id = 789; # Long | id

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

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

# Create an instance of the API class
api_instance = openapi_client.KeysApi()
id = 789 # Long | id (default to null)

try:
    # Get a key.
    api_response = api_instance.get_key(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KeysApi->getKey: %s\n" % e)
extern crate KeysApi;

pub fn main() {
    let id = 789; // Long

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
id
Required

Responses


getKeys

Get all of a user's keys.


/api/v1/keys

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/keys"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KeysApi;

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

public class KeysApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

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

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

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

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

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


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

// Get all of a user's keys.
[apiInstance getKeysWithCompletionHandler: 
              ^(array[APIKeyResponse] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

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

namespace Example
{
    public class getKeysExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

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

            try {
                // Get all of a user's keys.
                array[APIKeyResponse] result = apiInstance.getKeys();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KeysApi.getKeys: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

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

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

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

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

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

try:
    # Get all of a user's keys.
    api_response = api_instance.get_keys()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KeysApi->getKeys: %s\n" % e)
extern crate KeysApi;

pub fn main() {

    let mut context = KeysApi::Context::default();
    let result = client.getKeys(&context).wait();

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

Scopes

Parameters

Responses


Login

getAuthUser

Get the currently OAuth2 authenticated user platform token.


/api/v1/login/token

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/login/token"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LoginApi;

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

public class LoginApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

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

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

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

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

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


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

// Get the currently OAuth2 authenticated user platform token.
[apiInstance getAuthUserWithCompletionHandler: 
              ^(AuthorizedUserResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

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

namespace Example
{
    public class getAuthUserExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

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

            try {
                // Get the currently OAuth2 authenticated user platform token.
                AuthorizedUserResponse result = apiInstance.getAuthUser();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling LoginApi.getAuthUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

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

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

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

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

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

try:
    # Get the currently OAuth2 authenticated user platform token.
    api_response = api_instance.get_auth_user()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LoginApi->getAuthUser: %s\n" % e)
extern crate LoginApi;

pub fn main() {

    let mut context = LoginApi::Context::default();
    let result = client.getAuthUser(&context).wait();

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

Scopes

Parameters

Responses


getOAuthClients

Get the list of supported OAuth clients.


/api/v1/login/sso

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/login/sso"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LoginApi;

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

public class LoginApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

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

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

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

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

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


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

// Get the list of supported OAuth clients.
[apiInstance getOAuthClientsWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

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

namespace Example
{
    public class getOAuthClientsExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

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

            try {
                // Get the list of supported OAuth clients.
                array['String'] result = apiInstance.getOAuthClients();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling LoginApi.getOAuthClients: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

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

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

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

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

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

try:
    # Get the list of supported OAuth clients.
    api_response = api_instance.get_o_auth_clients()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LoginApi->getOAuthClients: %s\n" % e)
extern crate LoginApi;

pub fn main() {

    let mut context = LoginApi::Context::default();
    let result = client.getOAuthClients(&context).wait();

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

Scopes

Parameters

Responses


login

Retrieve an access token using API keys.


/api/v1/login

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: application/json,application/xml" \
 "http://localhost:8082/api/v1/login" \
 -d '{
  "apiKey" : "apiKey",
  "apiKeyId" : "apiKeyId"
}' \
 -d '<LoginRequest>
  <apiKey>aeiou</apiKey>
  <apiKeyId>aeiou</apiKeyId>
</LoginRequest>'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LoginApi;

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

public class LoginApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        LoginApi apiInstance = new LoginApi();
        LoginRequest request = ; // LoginRequest | 

        try {
            AuthorizedUserResponse result = apiInstance.login(request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoginApi#login");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LoginApi;

public class LoginApiExample {
    public static void main(String[] args) {
        LoginApi apiInstance = new LoginApi();
        LoginRequest request = ; // LoginRequest | 

        try {
            AuthorizedUserResponse result = apiInstance.login(request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoginApi#login");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


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

// Retrieve an access token using API keys.
[apiInstance loginWith:request
              completionHandler: ^(AuthorizedUserResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.LoginApi()
var request = ; // {LoginRequest} 

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

namespace Example
{
    public class loginExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new LoginApi();
            var request = new LoginRequest(); // LoginRequest | 

            try {
                // Retrieve an access token using API keys.
                AuthorizedUserResponse result = apiInstance.login(request);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling LoginApi.login: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\LoginApi();
$request = ; // LoginRequest | 

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::LoginApi->new();
my $request = WWW::OPenAPIClient::Object::LoginRequest->new(); # LoginRequest | 

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

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

# Create an instance of the API class
api_instance = openapi_client.LoginApi()
request =  # LoginRequest | 

try:
    # Retrieve an access token using API keys.
    api_response = api_instance.login(request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LoginApi->login: %s\n" % e)
extern crate LoginApi;

pub fn main() {
    let request = ; // LoginRequest

    let mut context = LoginApi::Context::default();
    let result = client.login(request, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
request *

request

Responses


Metrics

addMetric

Add a metric to an organization.


/api/v1/metrics

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/metrics?id=789&name=name_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MetricsApi;

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

public class MetricsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        MetricsApi apiInstance = new MetricsApi();
        Long id = 789; // Long | The organization ID.
        String name = name_example; // String | The metric name.

        try {
            MetricDefinition result = apiInstance.addMetric(id, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MetricsApi#addMetric");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MetricsApi;

public class MetricsApiExample {
    public static void main(String[] args) {
        MetricsApi apiInstance = new MetricsApi();
        Long id = 789; // Long | The organization ID.
        String name = name_example; // String | The metric name.

        try {
            MetricDefinition result = apiInstance.addMetric(id, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MetricsApi#addMetric");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
MetricsApi *apiInstance = [[MetricsApi alloc] init];
Long *id = 789; // The organization ID. (default to null)
String *name = name_example; // The metric name. (default to null)

// Add a metric to an organization.
[apiInstance addMetricWith:id
    name:name
              completionHandler: ^(MetricDefinition output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.MetricsApi()
var id = 789; // {Long} The organization ID.
var name = name_example; // {String} The metric name.

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

namespace Example
{
    public class addMetricExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new MetricsApi();
            var id = 789;  // Long | The organization ID. (default to null)
            var name = name_example;  // String | The metric name. (default to null)

            try {
                // Add a metric to an organization.
                MetricDefinition result = apiInstance.addMetric(id, name);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MetricsApi.addMetric: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MetricsApi();
$id = 789; // Long | The organization ID.
$name = name_example; // String | The metric name.

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MetricsApi->new();
my $id = 789; # Long | The organization ID.
my $name = name_example; # String | The metric name.

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

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

# Create an instance of the API class
api_instance = openapi_client.MetricsApi()
id = 789 # Long | The organization ID. (default to null)
name = name_example # String | The metric name. (default to null)

try:
    # Add a metric to an organization.
    api_response = api_instance.add_metric(id, name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MetricsApi->addMetric: %s\n" % e)
extern crate MetricsApi;

pub fn main() {
    let id = 789; // Long
    let name = name_example; // String

    let mut context = MetricsApi::Context::default();
    let result = client.addMetric(id, name, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
id*
Long (int64)
The organization ID.
Required
name*
String
The metric name.
Required

Responses


deleteMetric

Delete a metric by ID.


/api/v1/metrics/{id}

Usage and SDK Samples

curl -X DELETE \
-H "Authorization: [[apiKey]]" \
 "http://localhost:8082/api/v1/metrics/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MetricsApi;

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

public class MetricsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        MetricsApi apiInstance = new MetricsApi();
        String id = id_example; // String | The metric ID.

        try {
            apiInstance.deleteMetric(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling MetricsApi#deleteMetric");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MetricsApi;

public class MetricsApiExample {
    public static void main(String[] args) {
        MetricsApi apiInstance = new MetricsApi();
        String id = id_example; // String | The metric ID.

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

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
MetricsApi *apiInstance = [[MetricsApi alloc] init];
String *id = id_example; // The metric ID. (default to null)

// Delete a metric by ID.
[apiInstance deleteMetricWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.MetricsApi()
var id = id_example; // {String} The metric ID.

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

namespace Example
{
    public class deleteMetricExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new MetricsApi();
            var id = id_example;  // String | The metric ID. (default to null)

            try {
                // Delete a metric by ID.
                apiInstance.deleteMetric(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling MetricsApi.deleteMetric: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MetricsApi();
$id = id_example; // String | The metric ID.

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MetricsApi->new();
my $id = id_example; # String | The metric ID.

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

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

# Create an instance of the API class
api_instance = openapi_client.MetricsApi()
id = id_example # String | The metric ID. (default to null)

try:
    # Delete a metric by ID.
    api_instance.delete_metric(id)
except ApiException as e:
    print("Exception when calling MetricsApi->deleteMetric: %s\n" % e)
extern crate MetricsApi;

pub fn main() {
    let id = id_example; // String

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

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

Scopes

Parameters

Path parameters
Name Description
id*
String
The metric ID.
Required

Responses


downloadMetricFile

Download metric file.


/api/v1/metrics/{id}/data

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/metrics/{id}/data"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MetricsApi;

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

public class MetricsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        MetricsApi apiInstance = new MetricsApi();
        String id = id_example; // String | The metric ID.

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

public class MetricsApiExample {
    public static void main(String[] args) {
        MetricsApi apiInstance = new MetricsApi();
        String id = id_example; // String | The metric ID.

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

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
MetricsApi *apiInstance = [[MetricsApi alloc] init];
String *id = id_example; // The metric ID. (default to null)

// Download metric file.
[apiInstance downloadMetricFileWith:id
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.MetricsApi()
var id = id_example; // {String} The metric ID.

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

namespace Example
{
    public class downloadMetricFileExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new MetricsApi();
            var id = id_example;  // String | The metric ID. (default to null)

            try {
                // Download metric file.
                File result = apiInstance.downloadMetricFile(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MetricsApi.downloadMetricFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MetricsApi();
$id = id_example; // String | The metric ID.

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MetricsApi->new();
my $id = id_example; # String | The metric ID.

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

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

# Create an instance of the API class
api_instance = openapi_client.MetricsApi()
id = id_example # String | The metric ID. (default to null)

try:
    # Download metric file.
    api_response = api_instance.download_metric_file(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MetricsApi->downloadMetricFile: %s\n" % e)
extern crate MetricsApi;

pub fn main() {
    let id = id_example; // String

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

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

Scopes

Parameters

Path parameters
Name Description
id*
String
The metric ID.
Required

Responses


getMetric

Get a metric by ID.


/api/v1/metrics/{id}

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/metrics/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MetricsApi;

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

public class MetricsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        MetricsApi apiInstance = new MetricsApi();
        String id = id_example; // String | The metric ID.

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

public class MetricsApiExample {
    public static void main(String[] args) {
        MetricsApi apiInstance = new MetricsApi();
        String id = id_example; // String | The metric ID.

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

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
MetricsApi *apiInstance = [[MetricsApi alloc] init];
String *id = id_example; // The metric ID. (default to null)

// Get a metric by ID.
[apiInstance getMetricWith:id
              completionHandler: ^(MetricDefinition output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.MetricsApi()
var id = id_example; // {String} The metric ID.

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

namespace Example
{
    public class getMetricExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new MetricsApi();
            var id = id_example;  // String | The metric ID. (default to null)

            try {
                // Get a metric by ID.
                MetricDefinition result = apiInstance.getMetric(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MetricsApi.getMetric: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MetricsApi();
$id = id_example; // String | The metric ID.

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MetricsApi->new();
my $id = id_example; # String | The metric ID.

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

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

# Create an instance of the API class
api_instance = openapi_client.MetricsApi()
id = id_example # String | The metric ID. (default to null)

try:
    # Get a metric by ID.
    api_response = api_instance.get_metric(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MetricsApi->getMetric: %s\n" % e)
extern crate MetricsApi;

pub fn main() {
    let id = id_example; // String

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

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

Scopes

Parameters

Path parameters
Name Description
id*
String
The metric ID.
Required

Responses


getMetrics

Get the custom metrics available for this user.


/api/v1/metrics

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/metrics"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MetricsApi;

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

public class MetricsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

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

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

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

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

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


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

// Get the custom metrics available for this user.
[apiInstance getMetricsWithCompletionHandler: 
              ^(array[MetricDefinition] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

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

namespace Example
{
    public class getMetricsExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

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

            try {
                // Get the custom metrics available for this user.
                array[MetricDefinition] result = apiInstance.getMetrics();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MetricsApi.getMetrics: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

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

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

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

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

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

try:
    # Get the custom metrics available for this user.
    api_response = api_instance.get_metrics()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MetricsApi->getMetrics: %s\n" % e)
extern crate MetricsApi;

pub fn main() {

    let mut context = MetricsApi::Context::default();
    let result = client.getMetrics(&context).wait();

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

Scopes

Parameters

Responses


updateMetric

Update metric by ID.


/api/v1/metrics/{id}

Usage and SDK Samples

curl -X PUT \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: application/json,application/xml" \
 "http://localhost:8082/api/v1/metrics/{id}" \
 -d '{
  "uid" : "uid",
  "codebase_name" : "codebase_name",
  "metric_type" : "metric_type",
  "name" : "name",
  "description" : "description",
  "params" : [ "{}", "{}" ],
  "enabled" : true,
  "tasks" : [ "tasks", "tasks" ]
}' \
 -d '<MetricDefinition>
  <codebase_name>aeiou</codebase_name>
  <description>aeiou</description>
  <enabled>true</enabled>
  <metric_type>aeiou</metric_type>
  <name>aeiou</name>
  <params>UNDEFINED_EXAMPLE_VALUE</params>
  <tasks>aeiou</tasks>
  <uid>aeiou</uid>
</MetricDefinition>'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MetricsApi;

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

public class MetricsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        MetricsApi apiInstance = new MetricsApi();
        String id = id_example; // String | The metric ID.
        MetricDefinition metric = ; // MetricDefinition | 

        try {
            MetricDefinition result = apiInstance.updateMetric(id, metric);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MetricsApi#updateMetric");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MetricsApi;

public class MetricsApiExample {
    public static void main(String[] args) {
        MetricsApi apiInstance = new MetricsApi();
        String id = id_example; // String | The metric ID.
        MetricDefinition metric = ; // MetricDefinition | 

        try {
            MetricDefinition result = apiInstance.updateMetric(id, metric);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MetricsApi#updateMetric");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
MetricsApi *apiInstance = [[MetricsApi alloc] init];
String *id = id_example; // The metric ID. (default to null)
MetricDefinition *metric = ; // 

// Update metric by ID.
[apiInstance updateMetricWith:id
    metric:metric
              completionHandler: ^(MetricDefinition output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.MetricsApi()
var id = id_example; // {String} The metric ID.
var metric = ; // {MetricDefinition} 

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

namespace Example
{
    public class updateMetricExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new MetricsApi();
            var id = id_example;  // String | The metric ID. (default to null)
            var metric = new MetricDefinition(); // MetricDefinition | 

            try {
                // Update metric by ID.
                MetricDefinition result = apiInstance.updateMetric(id, metric);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MetricsApi.updateMetric: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MetricsApi();
$id = id_example; // String | The metric ID.
$metric = ; // MetricDefinition | 

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MetricsApi->new();
my $id = id_example; # String | The metric ID.
my $metric = WWW::OPenAPIClient::Object::MetricDefinition->new(); # MetricDefinition | 

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

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

# Create an instance of the API class
api_instance = openapi_client.MetricsApi()
id = id_example # String | The metric ID. (default to null)
metric =  # MetricDefinition | 

try:
    # Update metric by ID.
    api_response = api_instance.update_metric(id, metric)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MetricsApi->updateMetric: %s\n" % e)
extern crate MetricsApi;

pub fn main() {
    let id = id_example; // String
    let metric = ; // MetricDefinition

    let mut context = MetricsApi::Context::default();
    let result = client.updateMetric(id, metric, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
String
The metric ID.
Required
Body parameters
Name Description
metric *

The metric update request.

Responses


uploadMetricFile

Upload the metric implementation.


/api/v1/metrics/{id}

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: multipart/form-data" \
 "http://localhost:8082/api/v1/metrics/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MetricsApi;

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

public class MetricsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        MetricsApi apiInstance = new MetricsApi();
        String id = id_example; // String | The metric ID.
        File file = BINARY_DATA_HERE; // File | 

        try {
            MetricDefinition result = apiInstance.uploadMetricFile(id, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MetricsApi#uploadMetricFile");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MetricsApi;

public class MetricsApiExample {
    public static void main(String[] args) {
        MetricsApi apiInstance = new MetricsApi();
        String id = id_example; // String | The metric ID.
        File file = BINARY_DATA_HERE; // File | 

        try {
            MetricDefinition result = apiInstance.uploadMetricFile(id, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MetricsApi#uploadMetricFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
MetricsApi *apiInstance = [[MetricsApi alloc] init];
String *id = id_example; // The metric ID. (default to null)
File *file = BINARY_DATA_HERE; //  (optional) (default to null)

// Upload the metric implementation.
[apiInstance uploadMetricFileWith:id
    file:file
              completionHandler: ^(MetricDefinition output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.MetricsApi()
var id = id_example; // {String} The metric ID.
var opts = {
  'file': BINARY_DATA_HERE // {File} 
};

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

namespace Example
{
    public class uploadMetricFileExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new MetricsApi();
            var id = id_example;  // String | The metric ID. (default to null)
            var file = BINARY_DATA_HERE;  // File |  (optional)  (default to null)

            try {
                // Upload the metric implementation.
                MetricDefinition result = apiInstance.uploadMetricFile(id, file);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MetricsApi.uploadMetricFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MetricsApi();
$id = id_example; // String | The metric ID.
$file = BINARY_DATA_HERE; // File | 

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MetricsApi->new();
my $id = id_example; # String | The metric ID.
my $file = BINARY_DATA_HERE; # File | 

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

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

# Create an instance of the API class
api_instance = openapi_client.MetricsApi()
id = id_example # String | The metric ID. (default to null)
file = BINARY_DATA_HERE # File |  (optional) (default to null)

try:
    # Upload the metric implementation.
    api_response = api_instance.upload_metric_file(id, file=file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MetricsApi->uploadMetricFile: %s\n" % e)
extern crate MetricsApi;

pub fn main() {
    let id = id_example; // String
    let file = BINARY_DATA_HERE; // File

    let mut context = MetricsApi::Context::default();
    let result = client.uploadMetricFile(id, file, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
String
The metric ID.
Required
Form parameters
Name Description
file
File (binary)

Responses


Model

addModel

Add a model to an organization.


/api/v1/models

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/models?id=789&name=name_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModelApi;

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

public class ModelApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ModelApi apiInstance = new ModelApi();
        Long id = 789; // Long | The organization ID.
        String name = name_example; // String | The model name.

        try {
            ModelResponse result = apiInstance.addModel(id, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModelApi#addModel");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModelApi;

public class ModelApiExample {
    public static void main(String[] args) {
        ModelApi apiInstance = new ModelApi();
        Long id = 789; // Long | The organization ID.
        String name = name_example; // String | The model name.

        try {
            ModelResponse result = apiInstance.addModel(id, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModelApi#addModel");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
ModelApi *apiInstance = [[ModelApi alloc] init];
Long *id = 789; // The organization ID. (default to null)
String *name = name_example; // The model name. (default to null)

// Add a model to an organization.
[apiInstance addModelWith:id
    name:name
              completionHandler: ^(ModelResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.ModelApi()
var id = 789; // {Long} The organization ID.
var name = name_example; // {String} The model name.

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

namespace Example
{
    public class addModelExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ModelApi();
            var id = 789;  // Long | The organization ID. (default to null)
            var name = name_example;  // String | The model name. (default to null)

            try {
                // Add a model to an organization.
                ModelResponse result = apiInstance.addModel(id, name);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModelApi.addModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModelApi();
$id = 789; // Long | The organization ID.
$name = name_example; // String | The model name.

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModelApi->new();
my $id = 789; # Long | The organization ID.
my $name = name_example; # String | The model name.

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

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

# Create an instance of the API class
api_instance = openapi_client.ModelApi()
id = 789 # Long | The organization ID. (default to null)
name = name_example # String | The model name. (default to null)

try:
    # Add a model to an organization.
    api_response = api_instance.add_model(id, name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModelApi->addModel: %s\n" % e)
extern crate ModelApi;

pub fn main() {
    let id = 789; // Long
    let name = name_example; // String

    let mut context = ModelApi::Context::default();
    let result = client.addModel(id, name, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
id*
Long (int64)
The organization ID.
Required
name*
String
The model name.
Required

Responses


copyModel

Make a copy of a model. To copy to a different organization, extra permissions are required.


/api/v1/models/{id}/copy

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/models/{id}/copy?orgId=789"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModelApi;

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

public class ModelApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ModelApi apiInstance = new ModelApi();
        Long id = 789; // Long | The model ID.
        Long orgId = 789; // Long | Optional destination organization ID to copy to.

        try {
            ModelResponse result = apiInstance.copyModel(id, orgId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModelApi#copyModel");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModelApi;

public class ModelApiExample {
    public static void main(String[] args) {
        ModelApi apiInstance = new ModelApi();
        Long id = 789; // Long | The model ID.
        Long orgId = 789; // Long | Optional destination organization ID to copy to.

        try {
            ModelResponse result = apiInstance.copyModel(id, orgId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModelApi#copyModel");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
ModelApi *apiInstance = [[ModelApi alloc] init];
Long *id = 789; // The model ID. (default to null)
Long *orgId = 789; // Optional destination organization ID to copy to. (optional) (default to null)

// Make a copy of a model. To copy to a different organization, extra permissions are required.
[apiInstance copyModelWith:id
    orgId:orgId
              completionHandler: ^(ModelResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.ModelApi()
var id = 789; // {Long} The model ID.
var opts = {
  'orgId': 789 // {Long} Optional destination organization ID to copy to.
};

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

namespace Example
{
    public class copyModelExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ModelApi();
            var id = 789;  // Long | The model ID. (default to null)
            var orgId = 789;  // Long | Optional destination organization ID to copy to. (optional)  (default to null)

            try {
                // Make a copy of a model. To copy to a different organization, extra permissions are required.
                ModelResponse result = apiInstance.copyModel(id, orgId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModelApi.copyModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModelApi();
$id = 789; // Long | The model ID.
$orgId = 789; // Long | Optional destination organization ID to copy to.

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModelApi->new();
my $id = 789; # Long | The model ID.
my $orgId = 789; # Long | Optional destination organization ID to copy to.

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

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

# Create an instance of the API class
api_instance = openapi_client.ModelApi()
id = 789 # Long | The model ID. (default to null)
orgId = 789 # Long | Optional destination organization ID to copy to. (optional) (default to null)

try:
    # Make a copy of a model. To copy to a different organization, extra permissions are required.
    api_response = api_instance.copy_model(id, orgId=orgId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModelApi->copyModel: %s\n" % e)
extern crate ModelApi;

pub fn main() {
    let id = 789; // Long
    let orgId = 789; // Long

    let mut context = ModelApi::Context::default();
    let result = client.copyModel(id, orgId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The model ID.
Required
Query parameters
Name Description
orgId
Long (int64)
Optional destination organization ID to copy to.

Responses


deleteModel

Delete a model by ID.


/api/v1/models/{id}

Usage and SDK Samples

curl -X DELETE \
-H "Authorization: [[apiKey]]" \
 "http://localhost:8082/api/v1/models/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModelApi;

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

public class ModelApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ModelApi apiInstance = new ModelApi();
        Long id = 789; // Long | The model ID.

        try {
            apiInstance.deleteModel(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModelApi#deleteModel");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModelApi;

public class ModelApiExample {
    public static void main(String[] args) {
        ModelApi apiInstance = new ModelApi();
        Long id = 789; // Long | The model ID.

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

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
ModelApi *apiInstance = [[ModelApi alloc] init];
Long *id = 789; // The model ID. (default to null)

// Delete a model by ID.
[apiInstance deleteModelWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.ModelApi()
var id = 789; // {Long} The model ID.

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

namespace Example
{
    public class deleteModelExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ModelApi();
            var id = 789;  // Long | The model ID. (default to null)

            try {
                // Delete a model by ID.
                apiInstance.deleteModel(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModelApi.deleteModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModelApi();
$id = 789; // Long | The model ID.

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModelApi->new();
my $id = 789; # Long | The model ID.

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

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

# Create an instance of the API class
api_instance = openapi_client.ModelApi()
id = 789 # Long | The model ID. (default to null)

try:
    # Delete a model by ID.
    api_instance.delete_model(id)
except ApiException as e:
    print("Exception when calling ModelApi->deleteModel: %s\n" % e)
extern crate ModelApi;

pub fn main() {
    let id = 789; // Long

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The model ID.
Required

Responses


downloadModelData

Download model data.


/api/v1/models/{id}/data

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/models/{id}/data?dataType=dataType_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModelApi;

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

public class ModelApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ModelApi apiInstance = new ModelApi();
        String dataType = dataType_example; // String | The data type.
        Long id = 789; // Long | The model ID.

        try {
            File result = apiInstance.downloadModelData(dataType, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModelApi#downloadModelData");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModelApi;

public class ModelApiExample {
    public static void main(String[] args) {
        ModelApi apiInstance = new ModelApi();
        String dataType = dataType_example; // String | The data type.
        Long id = 789; // Long | The model ID.

        try {
            File result = apiInstance.downloadModelData(dataType, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModelApi#downloadModelData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
ModelApi *apiInstance = [[ModelApi alloc] init];
String *dataType = dataType_example; // The data type. (default to null)
Long *id = 789; // The model ID. (default to null)

// Download model data.
[apiInstance downloadModelDataWith:dataType
    id:id
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.ModelApi()
var dataType = dataType_example; // {String} The data type.
var id = 789; // {Long} The model ID.

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

namespace Example
{
    public class downloadModelDataExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ModelApi();
            var dataType = dataType_example;  // String | The data type. (default to null)
            var id = 789;  // Long | The model ID. (default to null)

            try {
                // Download model data.
                File result = apiInstance.downloadModelData(dataType, id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModelApi.downloadModelData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModelApi();
$dataType = dataType_example; // String | The data type.
$id = 789; // Long | The model ID.

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModelApi->new();
my $dataType = dataType_example; # String | The data type.
my $id = 789; # Long | The model ID.

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

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

# Create an instance of the API class
api_instance = openapi_client.ModelApi()
dataType = dataType_example # String | The data type. (default to null)
id = 789 # Long | The model ID. (default to null)

try:
    # Download model data.
    api_response = api_instance.download_model_data(dataType, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModelApi->downloadModelData: %s\n" % e)
extern crate ModelApi;

pub fn main() {
    let dataType = dataType_example; // String
    let id = 789; // Long

    let mut context = ModelApi::Context::default();
    let result = client.downloadModelData(dataType, id, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The model ID.
Required
Query parameters
Name Description
dataType*
String
The data type.
Required

Responses


getModel

Get a model by ID.


/api/v1/models/{id}

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/models/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModelApi;

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

public class ModelApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ModelApi apiInstance = new ModelApi();
        Long id = 789; // Long | The model ID.

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

public class ModelApiExample {
    public static void main(String[] args) {
        ModelApi apiInstance = new ModelApi();
        Long id = 789; // Long | The model ID.

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

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
ModelApi *apiInstance = [[ModelApi alloc] init];
Long *id = 789; // The model ID. (default to null)

// Get a model by ID.
[apiInstance getModelWith:id
              completionHandler: ^(ModelResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.ModelApi()
var id = 789; // {Long} The model ID.

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

namespace Example
{
    public class getModelExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ModelApi();
            var id = 789;  // Long | The model ID. (default to null)

            try {
                // Get a model by ID.
                ModelResponse result = apiInstance.getModel(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModelApi.getModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModelApi();
$id = 789; // Long | The model ID.

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModelApi->new();
my $id = 789; # Long | The model ID.

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

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

# Create an instance of the API class
api_instance = openapi_client.ModelApi()
id = 789 # Long | The model ID. (default to null)

try:
    # Get a model by ID.
    api_response = api_instance.get_model(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModelApi->getModel: %s\n" % e)
extern crate ModelApi;

pub fn main() {
    let id = 789; // Long

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The model ID.
Required

Responses


getModels

Get the models available for this user.


/api/v1/models

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/models"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModelApi;

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

public class ModelApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

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

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

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

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

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


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

// Get the models available for this user.
[apiInstance getModelsWithCompletionHandler: 
              ^(array[ModelResponse] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

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

namespace Example
{
    public class getModelsExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

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

            try {
                // Get the models available for this user.
                array[ModelResponse] result = apiInstance.getModels();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModelApi.getModels: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

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

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

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

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

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

try:
    # Get the models available for this user.
    api_response = api_instance.get_models()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModelApi->getModels: %s\n" % e)
extern crate ModelApi;

pub fn main() {

    let mut context = ModelApi::Context::default();
    let result = client.getModels(&context).wait();

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

Scopes

Parameters

Responses


updateModel

Update model by ID.


/api/v1/models/{id}

Usage and SDK Samples

curl -X PUT \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: application/json,application/xml" \
 "http://localhost:8082/api/v1/models/{id}" \
 -d '{
  "environment" : "environment",
  "frameworkType" : "Keras",
  "name" : "name",
  "transforms" : [ {
    "name" : "name",
    "id" : 1,
    "params" : "{}"
  }, {
    "name" : "name",
    "id" : 1,
    "params" : "{}"
  } ],
  "datasetId" : 0,
  "description" : "description",
  "tasks" : [ "tasks", "tasks" ]
}' \
 -d '<ModelRequest>
  <datasetId>123456789</datasetId>
  <description>aeiou</description>
  <environment>aeiou</environment>
  <frameworkType>aeiou</frameworkType>
  <name>aeiou</name>
  <tasks>aeiou</tasks>
</ModelRequest>'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModelApi;

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

public class ModelApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ModelApi apiInstance = new ModelApi();
        Long id = 789; // Long | The model ID.
        ModelRequest model = ; // ModelRequest | 

        try {
            ModelResponse result = apiInstance.updateModel(id, model);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModelApi#updateModel");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModelApi;

public class ModelApiExample {
    public static void main(String[] args) {
        ModelApi apiInstance = new ModelApi();
        Long id = 789; // Long | The model ID.
        ModelRequest model = ; // ModelRequest | 

        try {
            ModelResponse result = apiInstance.updateModel(id, model);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModelApi#updateModel");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
ModelApi *apiInstance = [[ModelApi alloc] init];
Long *id = 789; // The model ID. (default to null)
ModelRequest *model = ; // 

// Update model by ID.
[apiInstance updateModelWith:id
    model:model
              completionHandler: ^(ModelResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.ModelApi()
var id = 789; // {Long} The model ID.
var model = ; // {ModelRequest} 

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

namespace Example
{
    public class updateModelExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ModelApi();
            var id = 789;  // Long | The model ID. (default to null)
            var model = new ModelRequest(); // ModelRequest | 

            try {
                // Update model by ID.
                ModelResponse result = apiInstance.updateModel(id, model);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModelApi.updateModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModelApi();
$id = 789; // Long | The model ID.
$model = ; // ModelRequest | 

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModelApi->new();
my $id = 789; # Long | The model ID.
my $model = WWW::OPenAPIClient::Object::ModelRequest->new(); # ModelRequest | 

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

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

# Create an instance of the API class
api_instance = openapi_client.ModelApi()
id = 789 # Long | The model ID. (default to null)
model =  # ModelRequest | 

try:
    # Update model by ID.
    api_response = api_instance.update_model(id, model)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModelApi->updateModel: %s\n" % e)
extern crate ModelApi;

pub fn main() {
    let id = 789; // Long
    let model = ; // ModelRequest

    let mut context = ModelApi::Context::default();
    let result = client.updateModel(id, model, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The model ID.
Required
Body parameters
Name Description
model *

The model update request.

Responses


uploadModelData

Upload model data.


/api/v1/models/{modelId}/modeldata

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: multipart/form-data" \
 "http://localhost:8082/api/v1/models/{modelId}/modeldata?dataType=dataType_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModelApi;

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

public class ModelApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ModelApi apiInstance = new ModelApi();
        String dataType = dataType_example; // String | dataType
        Long modelId = 789; // Long | The model ID.
        File file = BINARY_DATA_HERE; // File | 

        try {
            ModelResponse result = apiInstance.uploadModelData(dataType, modelId, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModelApi#uploadModelData");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModelApi;

public class ModelApiExample {
    public static void main(String[] args) {
        ModelApi apiInstance = new ModelApi();
        String dataType = dataType_example; // String | dataType
        Long modelId = 789; // Long | The model ID.
        File file = BINARY_DATA_HERE; // File | 

        try {
            ModelResponse result = apiInstance.uploadModelData(dataType, modelId, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModelApi#uploadModelData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
ModelApi *apiInstance = [[ModelApi alloc] init];
String *dataType = dataType_example; // dataType (default to null)
Long *modelId = 789; // The model ID. (default to null)
File *file = BINARY_DATA_HERE; //  (optional) (default to null)

// Upload model data.
[apiInstance uploadModelDataWith:dataType
    modelId:modelId
    file:file
              completionHandler: ^(ModelResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.ModelApi()
var dataType = dataType_example; // {String} dataType
var modelId = 789; // {Long} The model ID.
var opts = {
  'file': BINARY_DATA_HERE // {File} 
};

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

namespace Example
{
    public class uploadModelDataExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ModelApi();
            var dataType = dataType_example;  // String | dataType (default to null)
            var modelId = 789;  // Long | The model ID. (default to null)
            var file = BINARY_DATA_HERE;  // File |  (optional)  (default to null)

            try {
                // Upload model data.
                ModelResponse result = apiInstance.uploadModelData(dataType, modelId, file);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModelApi.uploadModelData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModelApi();
$dataType = dataType_example; // String | dataType
$modelId = 789; // Long | The model ID.
$file = BINARY_DATA_HERE; // File | 

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModelApi->new();
my $dataType = dataType_example; # String | dataType
my $modelId = 789; # Long | The model ID.
my $file = BINARY_DATA_HERE; # File | 

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

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

# Create an instance of the API class
api_instance = openapi_client.ModelApi()
dataType = dataType_example # String | dataType (default to null)
modelId = 789 # Long | The model ID. (default to null)
file = BINARY_DATA_HERE # File |  (optional) (default to null)

try:
    # Upload model data.
    api_response = api_instance.upload_model_data(dataType, modelId, file=file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModelApi->uploadModelData: %s\n" % e)
extern crate ModelApi;

pub fn main() {
    let dataType = dataType_example; // String
    let modelId = 789; // Long
    let file = BINARY_DATA_HERE; // File

    let mut context = ModelApi::Context::default();
    let result = client.uploadModelData(dataType, modelId, file, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
modelId*
Long (int64)
The model ID.
Required
Form parameters
Name Description
file
File (binary)
Query parameters
Name Description
dataType*
String
dataType
Required

Responses


Organization

addOrganization

Add organization.


/api/v1/organizations

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: application/json,application/xml" \
 "http://localhost:8082/api/v1/organizations" \
 -d '{
  "settings" : {
    "disabledFeatures" : [ "ADV_CRAFTING", "ADV_CRAFTING" ],
    "maxTimeAllocated" : 5,
    "maxItemCount" : 5,
    "maxTimePerTask" : 2,
    "classMappingFiles" : [ {
      "fileName" : "fileName",
      "ref" : "ref",
      "datasetId" : 1,
      "contentType" : "contentType"
    }, {
      "fileName" : "fileName",
      "ref" : "ref",
      "datasetId" : 1,
      "contentType" : "contentType"
    } ]
  },
  "name" : "name"
}' \
 -d '<OrganizationRequest>
  <name>aeiou</name>
</OrganizationRequest>'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrganizationApi;

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

public class OrganizationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        OrganizationApi apiInstance = new OrganizationApi();
        OrganizationRequest organization = ; // OrganizationRequest | 

        try {
            OrganizationResponse result = apiInstance.addOrganization(organization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganizationApi#addOrganization");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.OrganizationApi;

public class OrganizationApiExample {
    public static void main(String[] args) {
        OrganizationApi apiInstance = new OrganizationApi();
        OrganizationRequest organization = ; // OrganizationRequest | 

        try {
            OrganizationResponse result = apiInstance.addOrganization(organization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganizationApi#addOrganization");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


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

// Add organization.
[apiInstance addOrganizationWith:organization
              completionHandler: ^(OrganizationResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.OrganizationApi()
var organization = ; // {OrganizationRequest} 

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

namespace Example
{
    public class addOrganizationExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new OrganizationApi();
            var organization = new OrganizationRequest(); // OrganizationRequest | 

            try {
                // Add organization.
                OrganizationResponse result = apiInstance.addOrganization(organization);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrganizationApi.addOrganization: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrganizationApi();
$organization = ; // OrganizationRequest | 

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrganizationApi->new();
my $organization = WWW::OPenAPIClient::Object::OrganizationRequest->new(); # OrganizationRequest | 

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

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

# Create an instance of the API class
api_instance = openapi_client.OrganizationApi()
organization =  # OrganizationRequest | 

try:
    # Add organization.
    api_response = api_instance.add_organization(organization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrganizationApi->addOrganization: %s\n" % e)
extern crate OrganizationApi;

pub fn main() {
    let organization = ; // OrganizationRequest

    let mut context = OrganizationApi::Context::default();
    let result = client.addOrganization(organization, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
organization *

organization

Responses


copyOrganization

Make a copy of the organization to another organization (requires admin permissions).


/api/v1/organizations/{id}/copy

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: application/json,application/xml" \
 "http://localhost:8082/api/v1/organizations/{id}/copy" \
 -d '{
  "settings" : {
    "disabledFeatures" : [ "ADV_CRAFTING", "ADV_CRAFTING" ],
    "maxTimeAllocated" : 5,
    "maxItemCount" : 5,
    "maxTimePerTask" : 2,
    "classMappingFiles" : [ {
      "fileName" : "fileName",
      "ref" : "ref",
      "datasetId" : 1,
      "contentType" : "contentType"
    }, {
      "fileName" : "fileName",
      "ref" : "ref",
      "datasetId" : 1,
      "contentType" : "contentType"
    } ]
  },
  "name" : "name"
}' \
 -d '<OrganizationRequest>
  <name>aeiou</name>
</OrganizationRequest>'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrganizationApi;

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

public class OrganizationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        OrganizationApi apiInstance = new OrganizationApi();
        Long id = 789; // Long | The organization ID.
        OrganizationRequest organizationRequest = ; // OrganizationRequest | 

        try {
            OrganizationResponse result = apiInstance.copyOrganization(id, organizationRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganizationApi#copyOrganization");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.OrganizationApi;

public class OrganizationApiExample {
    public static void main(String[] args) {
        OrganizationApi apiInstance = new OrganizationApi();
        Long id = 789; // Long | The organization ID.
        OrganizationRequest organizationRequest = ; // OrganizationRequest | 

        try {
            OrganizationResponse result = apiInstance.copyOrganization(id, organizationRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganizationApi#copyOrganization");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
OrganizationApi *apiInstance = [[OrganizationApi alloc] init];
Long *id = 789; // The organization ID. (default to null)
OrganizationRequest *organizationRequest = ; // 

// Make a copy of the organization to another organization (requires admin permissions).
[apiInstance copyOrganizationWith:id
    organizationRequest:organizationRequest
              completionHandler: ^(OrganizationResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.OrganizationApi()
var id = 789; // {Long} The organization ID.
var organizationRequest = ; // {OrganizationRequest} 

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

namespace Example
{
    public class copyOrganizationExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new OrganizationApi();
            var id = 789;  // Long | The organization ID. (default to null)
            var organizationRequest = new OrganizationRequest(); // OrganizationRequest | 

            try {
                // Make a copy of the organization to another organization (requires admin permissions).
                OrganizationResponse result = apiInstance.copyOrganization(id, organizationRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrganizationApi.copyOrganization: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrganizationApi();
$id = 789; // Long | The organization ID.
$organizationRequest = ; // OrganizationRequest | 

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrganizationApi->new();
my $id = 789; # Long | The organization ID.
my $organizationRequest = WWW::OPenAPIClient::Object::OrganizationRequest->new(); # OrganizationRequest | 

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

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

# Create an instance of the API class
api_instance = openapi_client.OrganizationApi()
id = 789 # Long | The organization ID. (default to null)
organizationRequest =  # OrganizationRequest | 

try:
    # Make a copy of the organization to another organization (requires admin permissions).
    api_response = api_instance.copy_organization(id, organizationRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrganizationApi->copyOrganization: %s\n" % e)
extern crate OrganizationApi;

pub fn main() {
    let id = 789; // Long
    let organizationRequest = ; // OrganizationRequest

    let mut context = OrganizationApi::Context::default();
    let result = client.copyOrganization(id, organizationRequest, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The organization ID.
Required
Body parameters
Name Description
organizationRequest *

Optional new organization information.

Responses


deleteOrganization

Delete an organization.


/api/v1/organizations/{id}

Usage and SDK Samples

curl -X DELETE \
-H "Authorization: [[apiKey]]" \
 "http://localhost:8082/api/v1/organizations/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrganizationApi;

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

public class OrganizationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        OrganizationApi apiInstance = new OrganizationApi();
        Long id = 789; // Long | id

        try {
            apiInstance.deleteOrganization(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganizationApi#deleteOrganization");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.OrganizationApi;

public class OrganizationApiExample {
    public static void main(String[] args) {
        OrganizationApi apiInstance = new OrganizationApi();
        Long id = 789; // Long | id

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

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
OrganizationApi *apiInstance = [[OrganizationApi alloc] init];
Long *id = 789; // id (default to null)

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

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.OrganizationApi()
var id = 789; // {Long} id

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

namespace Example
{
    public class deleteOrganizationExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new OrganizationApi();
            var id = 789;  // Long | id (default to null)

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

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrganizationApi();
$id = 789; // Long | id

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrganizationApi->new();
my $id = 789; # Long | id

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

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

# Create an instance of the API class
api_instance = openapi_client.OrganizationApi()
id = 789 # Long | id (default to null)

try:
    # Delete an organization.
    api_instance.delete_organization(id)
except ApiException as e:
    print("Exception when calling OrganizationApi->deleteOrganization: %s\n" % e)
extern crate OrganizationApi;

pub fn main() {
    let id = 789; // Long

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
id
Required

Responses


deleteOrganizationFile

Delete organization file.


/api/v1/organizations/{id}/file

Usage and SDK Samples

curl -X DELETE \
-H "Authorization: [[apiKey]]" \
 "http://localhost:8082/api/v1/organizations/{id}/file?ref=ref_example&type=type_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrganizationApi;

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

public class OrganizationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        OrganizationApi apiInstance = new OrganizationApi();
        Long id = 789; // Long | The organization ID.
        String ref = ref_example; // String | File reference
        String type = type_example; // String | File type - i.e. 'classmapping'

        try {
            apiInstance.deleteOrganizationFile(id, ref, type);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganizationApi#deleteOrganizationFile");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.OrganizationApi;

public class OrganizationApiExample {
    public static void main(String[] args) {
        OrganizationApi apiInstance = new OrganizationApi();
        Long id = 789; // Long | The organization ID.
        String ref = ref_example; // String | File reference
        String type = type_example; // String | File type - i.e. 'classmapping'

        try {
            apiInstance.deleteOrganizationFile(id, ref, type);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganizationApi#deleteOrganizationFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
OrganizationApi *apiInstance = [[OrganizationApi alloc] init];
Long *id = 789; // The organization ID. (default to null)
String *ref = ref_example; // File reference (default to null)
String *type = type_example; // File type - i.e. 'classmapping' (default to null)

// Delete organization file.
[apiInstance deleteOrganizationFileWith:id
    ref:ref
    type:type
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.OrganizationApi()
var id = 789; // {Long} The organization ID.
var ref = ref_example; // {String} File reference
var type = type_example; // {String} File type - i.e. 'classmapping'

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

namespace Example
{
    public class deleteOrganizationFileExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new OrganizationApi();
            var id = 789;  // Long | The organization ID. (default to null)
            var ref = ref_example;  // String | File reference (default to null)
            var type = type_example;  // String | File type - i.e. 'classmapping' (default to null)

            try {
                // Delete organization file.
                apiInstance.deleteOrganizationFile(id, ref, type);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrganizationApi.deleteOrganizationFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrganizationApi();
$id = 789; // Long | The organization ID.
$ref = ref_example; // String | File reference
$type = type_example; // String | File type - i.e. 'classmapping'

try {
    $api_instance->deleteOrganizationFile($id, $ref, $type);
} catch (Exception $e) {
    echo 'Exception when calling OrganizationApi->deleteOrganizationFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OrganizationApi;

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrganizationApi->new();
my $id = 789; # Long | The organization ID.
my $ref = ref_example; # String | File reference
my $type = type_example; # String | File type - i.e. 'classmapping'

eval {
    $api_instance->deleteOrganizationFile(id => $id, ref => $ref, type => $type);
};
if ($@) {
    warn "Exception when calling OrganizationApi->deleteOrganizationFile: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

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

# Create an instance of the API class
api_instance = openapi_client.OrganizationApi()
id = 789 # Long | The organization ID. (default to null)
ref = ref_example # String | File reference (default to null)
type = type_example # String | File type - i.e. 'classmapping' (default to null)

try:
    # Delete organization file.
    api_instance.delete_organization_file(id, ref, type)
except ApiException as e:
    print("Exception when calling OrganizationApi->deleteOrganizationFile: %s\n" % e)
extern crate OrganizationApi;

pub fn main() {
    let id = 789; // Long
    let ref = ref_example; // String
    let type = type_example; // String

    let mut context = OrganizationApi::Context::default();
    let result = client.deleteOrganizationFile(id, ref, type, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The organization ID.
Required
Query parameters
Name Description
ref*
String
File reference
Required
type*
String
File type - i.e. 'classmapping'
Required

Responses


downloadOrganizationFile

Download organization file.


/api/v1/organizations/{id}/file

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/organizations/{id}/file?ref=ref_example&type=type_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrganizationApi;

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

public class OrganizationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        OrganizationApi apiInstance = new OrganizationApi();
        Long id = 789; // Long | The organization ID.
        String ref = ref_example; // String | File reference
        String type = type_example; // String | Download type - i.e. 'classmapping'

        try {
            File result = apiInstance.downloadOrganizationFile(id, ref, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganizationApi#downloadOrganizationFile");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.OrganizationApi;

public class OrganizationApiExample {
    public static void main(String[] args) {
        OrganizationApi apiInstance = new OrganizationApi();
        Long id = 789; // Long | The organization ID.
        String ref = ref_example; // String | File reference
        String type = type_example; // String | Download type - i.e. 'classmapping'

        try {
            File result = apiInstance.downloadOrganizationFile(id, ref, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganizationApi#downloadOrganizationFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
OrganizationApi *apiInstance = [[OrganizationApi alloc] init];
Long *id = 789; // The organization ID. (default to null)
String *ref = ref_example; // File reference (default to null)
String *type = type_example; // Download type - i.e. 'classmapping' (default to null)

// Download organization file.
[apiInstance downloadOrganizationFileWith:id
    ref:ref
    type:type
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.OrganizationApi()
var id = 789; // {Long} The organization ID.
var ref = ref_example; // {String} File reference
var type = type_example; // {String} Download type - i.e. 'classmapping'

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

namespace Example
{
    public class downloadOrganizationFileExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new OrganizationApi();
            var id = 789;  // Long | The organization ID. (default to null)
            var ref = ref_example;  // String | File reference (default to null)
            var type = type_example;  // String | Download type - i.e. 'classmapping' (default to null)

            try {
                // Download organization file.
                File result = apiInstance.downloadOrganizationFile(id, ref, type);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrganizationApi.downloadOrganizationFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrganizationApi();
$id = 789; // Long | The organization ID.
$ref = ref_example; // String | File reference
$type = type_example; // String | Download type - i.e. 'classmapping'

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrganizationApi->new();
my $id = 789; # Long | The organization ID.
my $ref = ref_example; # String | File reference
my $type = type_example; # String | Download type - i.e. 'classmapping'

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

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

# Create an instance of the API class
api_instance = openapi_client.OrganizationApi()
id = 789 # Long | The organization ID. (default to null)
ref = ref_example # String | File reference (default to null)
type = type_example # String | Download type - i.e. 'classmapping' (default to null)

try:
    # Download organization file.
    api_response = api_instance.download_organization_file(id, ref, type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrganizationApi->downloadOrganizationFile: %s\n" % e)
extern crate OrganizationApi;

pub fn main() {
    let id = 789; // Long
    let ref = ref_example; // String
    let type = type_example; // String

    let mut context = OrganizationApi::Context::default();
    let result = client.downloadOrganizationFile(id, ref, type, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The organization ID.
Required
Query parameters
Name Description
ref*
String
File reference
Required
type*
String
Download type - i.e. 'classmapping'
Required

Responses


getAssetDefinitions

Get the assets defined for this organization.


/api/v1/organizations/{id}/assets

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/organizations/{id}/assets"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrganizationApi;

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

public class OrganizationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        OrganizationApi apiInstance = new OrganizationApi();
        Long id = 789; // Long | The organization ID.

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

public class OrganizationApiExample {
    public static void main(String[] args) {
        OrganizationApi apiInstance = new OrganizationApi();
        Long id = 789; // Long | The organization ID.

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

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
OrganizationApi *apiInstance = [[OrganizationApi alloc] init];
Long *id = 789; // The organization ID. (default to null)

// Get the assets defined for this organization.
[apiInstance getAssetDefinitionsWith:id
              completionHandler: ^(AssetsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.OrganizationApi()
var id = 789; // {Long} The organization ID.

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

namespace Example
{
    public class getAssetDefinitionsExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new OrganizationApi();
            var id = 789;  // Long | The organization ID. (default to null)

            try {
                // Get the assets defined for this organization.
                AssetsResponse result = apiInstance.getAssetDefinitions(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrganizationApi.getAssetDefinitions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrganizationApi();
$id = 789; // Long | The organization ID.

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrganizationApi->new();
my $id = 789; # Long | The organization ID.

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

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

# Create an instance of the API class
api_instance = openapi_client.OrganizationApi()
id = 789 # Long | The organization ID. (default to null)

try:
    # Get the assets defined for this organization.
    api_response = api_instance.get_asset_definitions(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrganizationApi->getAssetDefinitions: %s\n" % e)
extern crate OrganizationApi;

pub fn main() {
    let id = 789; // Long

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The organization ID.
Required

Responses


getDefinedHPO

Get the hyper-parameter optimization methods defined for this organization.


/api/v1/organizations/{id}/hpo

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/organizations/{id}/hpo"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrganizationApi;

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

public class OrganizationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        OrganizationApi apiInstance = new OrganizationApi();
        Long id = 789; // Long | id

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

public class OrganizationApiExample {
    public static void main(String[] args) {
        OrganizationApi apiInstance = new OrganizationApi();
        Long id = 789; // Long | id

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

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
OrganizationApi *apiInstance = [[OrganizationApi alloc] init];
Long *id = 789; // id (default to null)

// Get the hyper-parameter optimization methods defined for this organization.
[apiInstance getDefinedHPOWith:id
              completionHandler: ^(array[HPODefinition] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.OrganizationApi()
var id = 789; // {Long} id

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

namespace Example
{
    public class getDefinedHPOExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new OrganizationApi();
            var id = 789;  // Long | id (default to null)

            try {
                // Get the hyper-parameter optimization methods defined for this organization.
                array[HPODefinition] result = apiInstance.getDefinedHPO(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrganizationApi.getDefinedHPO: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrganizationApi();
$id = 789; // Long | id

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrganizationApi->new();
my $id = 789; # Long | id

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

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

# Create an instance of the API class
api_instance = openapi_client.OrganizationApi()
id = 789 # Long | id (default to null)

try:
    # Get the hyper-parameter optimization methods defined for this organization.
    api_response = api_instance.get_defined_hpo(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrganizationApi->getDefinedHPO: %s\n" % e)
extern crate OrganizationApi;

pub fn main() {
    let id = 789; // Long

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
id
Required

Responses


getDefinedTransforms

Get the transforms defined for this organization.


/api/v1/organizations/{id}/transforms

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/organizations/{id}/transforms"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrganizationApi;

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

public class OrganizationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        OrganizationApi apiInstance = new OrganizationApi();
        Long id = 789; // Long | id

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

public class OrganizationApiExample {
    public static void main(String[] args) {
        OrganizationApi apiInstance = new OrganizationApi();
        Long id = 789; // Long | id

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

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
OrganizationApi *apiInstance = [[OrganizationApi alloc] init];
Long *id = 789; // id (default to null)

// Get the transforms defined for this organization.
[apiInstance getDefinedTransformsWith:id
              completionHandler: ^(array[TransformDefinition] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.OrganizationApi()
var id = 789; // {Long} id

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

namespace Example
{
    public class getDefinedTransformsExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new OrganizationApi();
            var id = 789;  // Long | id (default to null)

            try {
                // Get the transforms defined for this organization.
                array[TransformDefinition] result = apiInstance.getDefinedTransforms(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrganizationApi.getDefinedTransforms: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrganizationApi();
$id = 789; // Long | id

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrganizationApi->new();
my $id = 789; # Long | id

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

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

# Create an instance of the API class
api_instance = openapi_client.OrganizationApi()
id = 789 # Long | id (default to null)

try:
    # Get the transforms defined for this organization.
    api_response = api_instance.get_defined_transforms(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrganizationApi->getDefinedTransforms: %s\n" % e)
extern crate OrganizationApi;

pub fn main() {
    let id = 789; // Long

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
id
Required

Responses


getMembers

Get all members (admin access rights required).


/api/v1/organizations/{id}/members

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/organizations/{id}/members"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrganizationApi;

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

public class OrganizationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        OrganizationApi apiInstance = new OrganizationApi();
        Long id = 789; // Long | id

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

public class OrganizationApiExample {
    public static void main(String[] args) {
        OrganizationApi apiInstance = new OrganizationApi();
        Long id = 789; // Long | id

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

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
OrganizationApi *apiInstance = [[OrganizationApi alloc] init];
Long *id = 789; // id (default to null)

// Get all members (admin access rights required).
[apiInstance getMembersWith:id
              completionHandler: ^(array[UserResponse] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.OrganizationApi()
var id = 789; // {Long} id

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

namespace Example
{
    public class getMembersExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new OrganizationApi();
            var id = 789;  // Long | id (default to null)

            try {
                // Get all members (admin access rights required).
                array[UserResponse] result = apiInstance.getMembers(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrganizationApi.getMembers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrganizationApi();
$id = 789; // Long | id

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrganizationApi->new();
my $id = 789; # Long | id

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

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

# Create an instance of the API class
api_instance = openapi_client.OrganizationApi()
id = 789 # Long | id (default to null)

try:
    # Get all members (admin access rights required).
    api_response = api_instance.get_members(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrganizationApi->getMembers: %s\n" % e)
extern crate OrganizationApi;

pub fn main() {
    let id = 789; // Long

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
id
Required

Responses


getOrganization

Get organization by id.


/api/v1/organizations/{id}

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/organizations/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrganizationApi;

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

public class OrganizationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        OrganizationApi apiInstance = new OrganizationApi();
        Long id = 789; // Long | id

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

public class OrganizationApiExample {
    public static void main(String[] args) {
        OrganizationApi apiInstance = new OrganizationApi();
        Long id = 789; // Long | id

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

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
OrganizationApi *apiInstance = [[OrganizationApi alloc] init];
Long *id = 789; // id (default to null)

// Get organization by id.
[apiInstance getOrganizationWith:id
              completionHandler: ^(OrganizationResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.OrganizationApi()
var id = 789; // {Long} id

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

namespace Example
{
    public class getOrganizationExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new OrganizationApi();
            var id = 789;  // Long | id (default to null)

            try {
                // Get organization by id.
                OrganizationResponse result = apiInstance.getOrganization(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrganizationApi.getOrganization: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrganizationApi();
$id = 789; // Long | id

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrganizationApi->new();
my $id = 789; # Long | id

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

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

# Create an instance of the API class
api_instance = openapi_client.OrganizationApi()
id = 789 # Long | id (default to null)

try:
    # Get organization by id.
    api_response = api_instance.get_organization(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrganizationApi->getOrganization: %s\n" % e)
extern crate OrganizationApi;

pub fn main() {
    let id = 789; // Long

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
id
Required

Responses


getOrganizationFileUsage

Get organization file project usage.


/api/v1/organizations/{id}/file/usage

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/organizations/{id}/file/usage?ref=ref_example&type=type_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrganizationApi;

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

public class OrganizationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        OrganizationApi apiInstance = new OrganizationApi();
        Long id = 789; // Long | The organization ID.
        String ref = ref_example; // String | File reference
        String type = type_example; // String | File type - i.e. 'classmapping'

        try {
            array[Long] result = apiInstance.getOrganizationFileUsage(id, ref, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganizationApi#getOrganizationFileUsage");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.OrganizationApi;

public class OrganizationApiExample {
    public static void main(String[] args) {
        OrganizationApi apiInstance = new OrganizationApi();
        Long id = 789; // Long | The organization ID.
        String ref = ref_example; // String | File reference
        String type = type_example; // String | File type - i.e. 'classmapping'

        try {
            array[Long] result = apiInstance.getOrganizationFileUsage(id, ref, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganizationApi#getOrganizationFileUsage");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
OrganizationApi *apiInstance = [[OrganizationApi alloc] init];
Long *id = 789; // The organization ID. (default to null)
String *ref = ref_example; // File reference (default to null)
String *type = type_example; // File type - i.e. 'classmapping' (default to null)

// Get organization file project usage.
[apiInstance getOrganizationFileUsageWith:id
    ref:ref
    type:type
              completionHandler: ^(array[Long] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.OrganizationApi()
var id = 789; // {Long} The organization ID.
var ref = ref_example; // {String} File reference
var type = type_example; // {String} File type - i.e. 'classmapping'

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

namespace Example
{
    public class getOrganizationFileUsageExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new OrganizationApi();
            var id = 789;  // Long | The organization ID. (default to null)
            var ref = ref_example;  // String | File reference (default to null)
            var type = type_example;  // String | File type - i.e. 'classmapping' (default to null)

            try {
                // Get organization file project usage.
                array[Long] result = apiInstance.getOrganizationFileUsage(id, ref, type);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrganizationApi.getOrganizationFileUsage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrganizationApi();
$id = 789; // Long | The organization ID.
$ref = ref_example; // String | File reference
$type = type_example; // String | File type - i.e. 'classmapping'

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrganizationApi->new();
my $id = 789; # Long | The organization ID.
my $ref = ref_example; # String | File reference
my $type = type_example; # String | File type - i.e. 'classmapping'

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

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

# Create an instance of the API class
api_instance = openapi_client.OrganizationApi()
id = 789 # Long | The organization ID. (default to null)
ref = ref_example # String | File reference (default to null)
type = type_example # String | File type - i.e. 'classmapping' (default to null)

try:
    # Get organization file project usage.
    api_response = api_instance.get_organization_file_usage(id, ref, type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrganizationApi->getOrganizationFileUsage: %s\n" % e)
extern crate OrganizationApi;

pub fn main() {
    let id = 789; // Long
    let ref = ref_example; // String
    let type = type_example; // String

    let mut context = OrganizationApi::Context::default();
    let result = client.getOrganizationFileUsage(id, ref, type, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The organization ID.
Required
Query parameters
Name Description
ref*
String
File reference
Required
type*
String
File type - i.e. 'classmapping'
Required

Responses


getOrganizations

Get all organizations - (requires admin permissions).


/api/v1/organizations

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/organizations"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrganizationApi;

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

public class OrganizationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

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

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

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

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

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


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

// Get all organizations - (requires admin permissions).
[apiInstance getOrganizationsWithCompletionHandler: 
              ^(array[OrganizationResponse] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

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

namespace Example
{
    public class getOrganizationsExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

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

            try {
                // Get all organizations - (requires admin permissions).
                array[OrganizationResponse] result = apiInstance.getOrganizations();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrganizationApi.getOrganizations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

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

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

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

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

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

try:
    # Get all organizations - (requires admin permissions).
    api_response = api_instance.get_organizations()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrganizationApi->getOrganizations: %s\n" % e)
extern crate OrganizationApi;

pub fn main() {

    let mut context = OrganizationApi::Context::default();
    let result = client.getOrganizations(&context).wait();

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

Scopes

Parameters

Responses


renameOrganizationFile

Rename organization file.


/api/v1/organizations/{id}/file

Usage and SDK Samples

curl -X PUT \
-H "Authorization: [[apiKey]]" \
 "http://localhost:8082/api/v1/organizations/{id}/file?name=name_example&ref=ref_example&type=type_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrganizationApi;

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

public class OrganizationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        OrganizationApi apiInstance = new OrganizationApi();
        Long id = 789; // Long | The organization ID.
        String name = name_example; // String | File name
        String ref = ref_example; // String | File reference
        String type = type_example; // String | File type - i.e. 'classmapping'

        try {
            apiInstance.renameOrganizationFile(id, name, ref, type);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganizationApi#renameOrganizationFile");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.OrganizationApi;

public class OrganizationApiExample {
    public static void main(String[] args) {
        OrganizationApi apiInstance = new OrganizationApi();
        Long id = 789; // Long | The organization ID.
        String name = name_example; // String | File name
        String ref = ref_example; // String | File reference
        String type = type_example; // String | File type - i.e. 'classmapping'

        try {
            apiInstance.renameOrganizationFile(id, name, ref, type);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganizationApi#renameOrganizationFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
OrganizationApi *apiInstance = [[OrganizationApi alloc] init];
Long *id = 789; // The organization ID. (default to null)
String *name = name_example; // File name (default to null)
String *ref = ref_example; // File reference (default to null)
String *type = type_example; // File type - i.e. 'classmapping' (default to null)

// Rename organization file.
[apiInstance renameOrganizationFileWith:id
    name:name
    ref:ref
    type:type
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.OrganizationApi()
var id = 789; // {Long} The organization ID.
var name = name_example; // {String} File name
var ref = ref_example; // {String} File reference
var type = type_example; // {String} File type - i.e. 'classmapping'

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

namespace Example
{
    public class renameOrganizationFileExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new OrganizationApi();
            var id = 789;  // Long | The organization ID. (default to null)
            var name = name_example;  // String | File name (default to null)
            var ref = ref_example;  // String | File reference (default to null)
            var type = type_example;  // String | File type - i.e. 'classmapping' (default to null)

            try {
                // Rename organization file.
                apiInstance.renameOrganizationFile(id, name, ref, type);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrganizationApi.renameOrganizationFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrganizationApi();
$id = 789; // Long | The organization ID.
$name = name_example; // String | File name
$ref = ref_example; // String | File reference
$type = type_example; // String | File type - i.e. 'classmapping'

try {
    $api_instance->renameOrganizationFile($id, $name, $ref, $type);
} catch (Exception $e) {
    echo 'Exception when calling OrganizationApi->renameOrganizationFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OrganizationApi;

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrganizationApi->new();
my $id = 789; # Long | The organization ID.
my $name = name_example; # String | File name
my $ref = ref_example; # String | File reference
my $type = type_example; # String | File type - i.e. 'classmapping'

eval {
    $api_instance->renameOrganizationFile(id => $id, name => $name, ref => $ref, type => $type);
};
if ($@) {
    warn "Exception when calling OrganizationApi->renameOrganizationFile: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

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

# Create an instance of the API class
api_instance = openapi_client.OrganizationApi()
id = 789 # Long | The organization ID. (default to null)
name = name_example # String | File name (default to null)
ref = ref_example # String | File reference (default to null)
type = type_example # String | File type - i.e. 'classmapping' (default to null)

try:
    # Rename organization file.
    api_instance.rename_organization_file(id, name, ref, type)
except ApiException as e:
    print("Exception when calling OrganizationApi->renameOrganizationFile: %s\n" % e)
extern crate OrganizationApi;

pub fn main() {
    let id = 789; // Long
    let name = name_example; // String
    let ref = ref_example; // String
    let type = type_example; // String

    let mut context = OrganizationApi::Context::default();
    let result = client.renameOrganizationFile(id, name, ref, type, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The organization ID.
Required
Query parameters
Name Description
name*
String
File name
Required
ref*
String
File reference
Required
type*
String
File type - i.e. 'classmapping'
Required

Responses


updateOrgStats

Update storage and accounting information for this organization (admin rights).


/api/v1/organizations/{id}/stat

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 "http://localhost:8082/api/v1/organizations/{id}/stat"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrganizationApi;

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

public class OrganizationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        OrganizationApi apiInstance = new OrganizationApi();
        Long id = 789; // Long | The organization ID.

        try {
            apiInstance.updateOrgStats(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganizationApi#updateOrgStats");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.OrganizationApi;

public class OrganizationApiExample {
    public static void main(String[] args) {
        OrganizationApi apiInstance = new OrganizationApi();
        Long id = 789; // Long | The organization ID.

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

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
OrganizationApi *apiInstance = [[OrganizationApi alloc] init];
Long *id = 789; // The organization ID. (default to null)

// Update storage and accounting information for this organization (admin rights).
[apiInstance updateOrgStatsWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.OrganizationApi()
var id = 789; // {Long} The organization ID.

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

namespace Example
{
    public class updateOrgStatsExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new OrganizationApi();
            var id = 789;  // Long | The organization ID. (default to null)

            try {
                // Update storage and accounting information for this organization (admin rights).
                apiInstance.updateOrgStats(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrganizationApi.updateOrgStats: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrganizationApi();
$id = 789; // Long | The organization ID.

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrganizationApi->new();
my $id = 789; # Long | The organization ID.

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

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

# Create an instance of the API class
api_instance = openapi_client.OrganizationApi()
id = 789 # Long | The organization ID. (default to null)

try:
    # Update storage and accounting information for this organization (admin rights).
    api_instance.update_org_stats(id)
except ApiException as e:
    print("Exception when calling OrganizationApi->updateOrgStats: %s\n" % e)
extern crate OrganizationApi;

pub fn main() {
    let id = 789; // Long

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The organization ID.
Required

Responses


updateOrganization

Update organization.


/api/v1/organizations/{id}

Usage and SDK Samples

curl -X PUT \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: application/json,application/xml" \
 "http://localhost:8082/api/v1/organizations/{id}" \
 -d '{
  "settings" : {
    "disabledFeatures" : [ "ADV_CRAFTING", "ADV_CRAFTING" ],
    "maxTimeAllocated" : 5,
    "maxItemCount" : 5,
    "maxTimePerTask" : 2,
    "classMappingFiles" : [ {
      "fileName" : "fileName",
      "ref" : "ref",
      "datasetId" : 1,
      "contentType" : "contentType"
    }, {
      "fileName" : "fileName",
      "ref" : "ref",
      "datasetId" : 1,
      "contentType" : "contentType"
    } ]
  },
  "name" : "name"
}' \
 -d '<OrganizationRequest>
  <name>aeiou</name>
</OrganizationRequest>'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrganizationApi;

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

public class OrganizationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        OrganizationApi apiInstance = new OrganizationApi();
        Long id = 789; // Long | id
        OrganizationRequest request = ; // OrganizationRequest | 

        try {
            OrganizationResponse result = apiInstance.updateOrganization(id, request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganizationApi#updateOrganization");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.OrganizationApi;

public class OrganizationApiExample {
    public static void main(String[] args) {
        OrganizationApi apiInstance = new OrganizationApi();
        Long id = 789; // Long | id
        OrganizationRequest request = ; // OrganizationRequest | 

        try {
            OrganizationResponse result = apiInstance.updateOrganization(id, request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganizationApi#updateOrganization");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
OrganizationApi *apiInstance = [[OrganizationApi alloc] init];
Long *id = 789; // id (default to null)
OrganizationRequest *request = ; // 

// Update organization.
[apiInstance updateOrganizationWith:id
    request:request
              completionHandler: ^(OrganizationResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.OrganizationApi()
var id = 789; // {Long} id
var request = ; // {OrganizationRequest} 

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

namespace Example
{
    public class updateOrganizationExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new OrganizationApi();
            var id = 789;  // Long | id (default to null)
            var request = new OrganizationRequest(); // OrganizationRequest | 

            try {
                // Update organization.
                OrganizationResponse result = apiInstance.updateOrganization(id, request);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrganizationApi.updateOrganization: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrganizationApi();
$id = 789; // Long | id
$request = ; // OrganizationRequest | 

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrganizationApi->new();
my $id = 789; # Long | id
my $request = WWW::OPenAPIClient::Object::OrganizationRequest->new(); # OrganizationRequest | 

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

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

# Create an instance of the API class
api_instance = openapi_client.OrganizationApi()
id = 789 # Long | id (default to null)
request =  # OrganizationRequest | 

try:
    # Update organization.
    api_response = api_instance.update_organization(id, request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrganizationApi->updateOrganization: %s\n" % e)
extern crate OrganizationApi;

pub fn main() {
    let id = 789; // Long
    let request = ; // OrganizationRequest

    let mut context = OrganizationApi::Context::default();
    let result = client.updateOrganization(id, request, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
id
Required
Body parameters
Name Description
request *

request

Responses


uploadOrganizationFile

Upload a file to the organization and return a reference.


/api/v1/organizations/{id}/file

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: multipart/form-data" \
 "http://localhost:8082/api/v1/organizations/{id}/file?datasetId=789&ref=ref_example&type=type_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrganizationApi;

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

public class OrganizationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        OrganizationApi apiInstance = new OrganizationApi();
        Long id = 789; // Long | The organization ID.
        String type = type_example; // String | Upload type - i.e. 'classmapping'
        Long datasetId = 789; // Long | The dataset ID.
        String ref = ref_example; // String | Reference (supplied when updating)
        File file = BINARY_DATA_HERE; // File | 

        try {
            'String' result = apiInstance.uploadOrganizationFile(id, type, datasetId, ref, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganizationApi#uploadOrganizationFile");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.OrganizationApi;

public class OrganizationApiExample {
    public static void main(String[] args) {
        OrganizationApi apiInstance = new OrganizationApi();
        Long id = 789; // Long | The organization ID.
        String type = type_example; // String | Upload type - i.e. 'classmapping'
        Long datasetId = 789; // Long | The dataset ID.
        String ref = ref_example; // String | Reference (supplied when updating)
        File file = BINARY_DATA_HERE; // File | 

        try {
            'String' result = apiInstance.uploadOrganizationFile(id, type, datasetId, ref, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganizationApi#uploadOrganizationFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
OrganizationApi *apiInstance = [[OrganizationApi alloc] init];
Long *id = 789; // The organization ID. (default to null)
String *type = type_example; // Upload type - i.e. 'classmapping' (default to null)
Long *datasetId = 789; // The dataset ID. (optional) (default to null)
String *ref = ref_example; // Reference (supplied when updating) (optional) (default to null)
File *file = BINARY_DATA_HERE; //  (optional) (default to null)

// Upload a file to the organization and return a reference.
[apiInstance uploadOrganizationFileWith:id
    type:type
    datasetId:datasetId
    ref:ref
    file:file
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.OrganizationApi()
var id = 789; // {Long} The organization ID.
var type = type_example; // {String} Upload type - i.e. 'classmapping'
var opts = {
  'datasetId': 789, // {Long} The dataset ID.
  'ref': ref_example, // {String} Reference (supplied when updating)
  'file': BINARY_DATA_HERE // {File} 
};

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

namespace Example
{
    public class uploadOrganizationFileExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new OrganizationApi();
            var id = 789;  // Long | The organization ID. (default to null)
            var type = type_example;  // String | Upload type - i.e. 'classmapping' (default to null)
            var datasetId = 789;  // Long | The dataset ID. (optional)  (default to null)
            var ref = ref_example;  // String | Reference (supplied when updating) (optional)  (default to null)
            var file = BINARY_DATA_HERE;  // File |  (optional)  (default to null)

            try {
                // Upload a file to the organization and return a reference.
                'String' result = apiInstance.uploadOrganizationFile(id, type, datasetId, ref, file);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrganizationApi.uploadOrganizationFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrganizationApi();
$id = 789; // Long | The organization ID.
$type = type_example; // String | Upload type - i.e. 'classmapping'
$datasetId = 789; // Long | The dataset ID.
$ref = ref_example; // String | Reference (supplied when updating)
$file = BINARY_DATA_HERE; // File | 

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrganizationApi->new();
my $id = 789; # Long | The organization ID.
my $type = type_example; # String | Upload type - i.e. 'classmapping'
my $datasetId = 789; # Long | The dataset ID.
my $ref = ref_example; # String | Reference (supplied when updating)
my $file = BINARY_DATA_HERE; # File | 

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

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

# Create an instance of the API class
api_instance = openapi_client.OrganizationApi()
id = 789 # Long | The organization ID. (default to null)
type = type_example # String | Upload type - i.e. 'classmapping' (default to null)
datasetId = 789 # Long | The dataset ID. (optional) (default to null)
ref = ref_example # String | Reference (supplied when updating) (optional) (default to null)
file = BINARY_DATA_HERE # File |  (optional) (default to null)

try:
    # Upload a file to the organization and return a reference.
    api_response = api_instance.upload_organization_file(id, type, datasetId=datasetId, ref=ref, file=file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrganizationApi->uploadOrganizationFile: %s\n" % e)
extern crate OrganizationApi;

pub fn main() {
    let id = 789; // Long
    let type = type_example; // String
    let datasetId = 789; // Long
    let ref = ref_example; // String
    let file = BINARY_DATA_HERE; // File

    let mut context = OrganizationApi::Context::default();
    let result = client.uploadOrganizationFile(id, type, datasetId, ref, file, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The organization ID.
Required
Form parameters
Name Description
file
File (binary)
Query parameters
Name Description
datasetId
Long (int64)
The dataset ID.
ref
String
Reference (supplied when updating)
type*
String
Upload type - i.e. 'classmapping'
Required

Responses


Platform

cancelWorker

Administrative call to cancel a worker job (admin rights required)


/api/v1/platform/cancel

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 "http://localhost:8082/api/v1/platform/cancel?id=id_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PlatformApi;

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

public class PlatformApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PlatformApi apiInstance = new PlatformApi();
        String id = id_example; // String | id

        try {
            apiInstance.cancelWorker(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlatformApi#cancelWorker");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PlatformApi;

public class PlatformApiExample {
    public static void main(String[] args) {
        PlatformApi apiInstance = new PlatformApi();
        String id = id_example; // String | id

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

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
PlatformApi *apiInstance = [[PlatformApi alloc] init];
String *id = id_example; // id (default to null)

// Administrative call to cancel a worker job (admin rights required)
[apiInstance cancelWorkerWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.PlatformApi()
var id = id_example; // {String} id

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

namespace Example
{
    public class cancelWorkerExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PlatformApi();
            var id = id_example;  // String | id (default to null)

            try {
                // Administrative call to cancel a worker job (admin rights required)
                apiInstance.cancelWorker(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling PlatformApi.cancelWorker: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PlatformApi();
$id = id_example; // String | id

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PlatformApi->new();
my $id = id_example; # String | id

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

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

# Create an instance of the API class
api_instance = openapi_client.PlatformApi()
id = id_example # String | id (default to null)

try:
    # Administrative call to cancel a worker job (admin rights required)
    api_instance.cancel_worker(id)
except ApiException as e:
    print("Exception when calling PlatformApi->cancelWorker: %s\n" % e)
extern crate PlatformApi;

pub fn main() {
    let id = id_example; // String

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

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

Scopes

Parameters

Query parameters
Name Description
id*
String
id
Required

Responses


deletePlatformFile

Delete platform file (only admins).


/api/v1/platform/file

Usage and SDK Samples

curl -X DELETE \
-H "Authorization: [[apiKey]]" \
 "http://localhost:8082/api/v1/platform/file?ref=ref_example&type=type_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PlatformApi;

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

public class PlatformApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PlatformApi apiInstance = new PlatformApi();
        String ref = ref_example; // String | File reference
        String type = type_example; // String | File type - i.e. 'asset'

        try {
            apiInstance.deletePlatformFile(ref, type);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlatformApi#deletePlatformFile");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PlatformApi;

public class PlatformApiExample {
    public static void main(String[] args) {
        PlatformApi apiInstance = new PlatformApi();
        String ref = ref_example; // String | File reference
        String type = type_example; // String | File type - i.e. 'asset'

        try {
            apiInstance.deletePlatformFile(ref, type);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlatformApi#deletePlatformFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
PlatformApi *apiInstance = [[PlatformApi alloc] init];
String *ref = ref_example; // File reference (default to null)
String *type = type_example; // File type - i.e. 'asset' (default to null)

// Delete platform file (only admins).
[apiInstance deletePlatformFileWith:ref
    type:type
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.PlatformApi()
var ref = ref_example; // {String} File reference
var type = type_example; // {String} File type - i.e. 'asset'

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

namespace Example
{
    public class deletePlatformFileExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PlatformApi();
            var ref = ref_example;  // String | File reference (default to null)
            var type = type_example;  // String | File type - i.e. 'asset' (default to null)

            try {
                // Delete platform file (only admins).
                apiInstance.deletePlatformFile(ref, type);
            } catch (Exception e) {
                Debug.Print("Exception when calling PlatformApi.deletePlatformFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PlatformApi();
$ref = ref_example; // String | File reference
$type = type_example; // String | File type - i.e. 'asset'

try {
    $api_instance->deletePlatformFile($ref, $type);
} catch (Exception $e) {
    echo 'Exception when calling PlatformApi->deletePlatformFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PlatformApi;

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PlatformApi->new();
my $ref = ref_example; # String | File reference
my $type = type_example; # String | File type - i.e. 'asset'

eval {
    $api_instance->deletePlatformFile(ref => $ref, type => $type);
};
if ($@) {
    warn "Exception when calling PlatformApi->deletePlatformFile: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

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

# Create an instance of the API class
api_instance = openapi_client.PlatformApi()
ref = ref_example # String | File reference (default to null)
type = type_example # String | File type - i.e. 'asset' (default to null)

try:
    # Delete platform file (only admins).
    api_instance.delete_platform_file(ref, type)
except ApiException as e:
    print("Exception when calling PlatformApi->deletePlatformFile: %s\n" % e)
extern crate PlatformApi;

pub fn main() {
    let ref = ref_example; // String
    let type = type_example; // String

    let mut context = PlatformApi::Context::default();
    let result = client.deletePlatformFile(ref, type, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
ref*
String
File reference
Required
type*
String
File type - i.e. 'asset'
Required

Responses


downloadPlatformFile

Download platform file.


/api/v1/platform/file

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/platform/file?ref=ref_example&type=type_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PlatformApi;

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

public class PlatformApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PlatformApi apiInstance = new PlatformApi();
        String ref = ref_example; // String | File reference
        String type = type_example; // String | Download type - i.e. 'asset'

        try {
            File result = apiInstance.downloadPlatformFile(ref, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlatformApi#downloadPlatformFile");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PlatformApi;

public class PlatformApiExample {
    public static void main(String[] args) {
        PlatformApi apiInstance = new PlatformApi();
        String ref = ref_example; // String | File reference
        String type = type_example; // String | Download type - i.e. 'asset'

        try {
            File result = apiInstance.downloadPlatformFile(ref, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlatformApi#downloadPlatformFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
PlatformApi *apiInstance = [[PlatformApi alloc] init];
String *ref = ref_example; // File reference (default to null)
String *type = type_example; // Download type - i.e. 'asset' (default to null)

// Download platform file.
[apiInstance downloadPlatformFileWith:ref
    type:type
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.PlatformApi()
var ref = ref_example; // {String} File reference
var type = type_example; // {String} Download type - i.e. 'asset'

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

namespace Example
{
    public class downloadPlatformFileExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PlatformApi();
            var ref = ref_example;  // String | File reference (default to null)
            var type = type_example;  // String | Download type - i.e. 'asset' (default to null)

            try {
                // Download platform file.
                File result = apiInstance.downloadPlatformFile(ref, type);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PlatformApi.downloadPlatformFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PlatformApi();
$ref = ref_example; // String | File reference
$type = type_example; // String | Download type - i.e. 'asset'

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PlatformApi->new();
my $ref = ref_example; # String | File reference
my $type = type_example; # String | Download type - i.e. 'asset'

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

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

# Create an instance of the API class
api_instance = openapi_client.PlatformApi()
ref = ref_example # String | File reference (default to null)
type = type_example # String | Download type - i.e. 'asset' (default to null)

try:
    # Download platform file.
    api_response = api_instance.download_platform_file(ref, type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlatformApi->downloadPlatformFile: %s\n" % e)
extern crate PlatformApi;

pub fn main() {
    let ref = ref_example; // String
    let type = type_example; // String

    let mut context = PlatformApi::Context::default();
    let result = client.downloadPlatformFile(ref, type, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
ref*
String
File reference
Required
type*
String
Download type - i.e. 'asset'
Required

Responses


getEnvironments

Get the list of environments.


/api/v1/platform/environments

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/platform/environments"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PlatformApi;

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

public class PlatformApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

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

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

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

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

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


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

// Get the list of environments.
[apiInstance getEnvironmentsWithCompletionHandler: 
              ^(array[EnvironmentResponse] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

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

namespace Example
{
    public class getEnvironmentsExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

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

            try {
                // Get the list of environments.
                array[EnvironmentResponse] result = apiInstance.getEnvironments();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PlatformApi.getEnvironments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

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

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

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

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

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

try:
    # Get the list of environments.
    api_response = api_instance.get_environments()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlatformApi->getEnvironments: %s\n" % e)
extern crate PlatformApi;

pub fn main() {

    let mut context = PlatformApi::Context::default();
    let result = client.getEnvironments(&context).wait();

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

Scopes

Parameters

Responses


getQueueInfo

Get worker queue information.


/api/v1/platform/workerqueue

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/platform/workerqueue"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PlatformApi;

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

public class PlatformApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

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

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

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

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

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


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

// Get worker queue information.
[apiInstance getQueueInfoWithCompletionHandler: 
              ^(QueueInfoResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

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

namespace Example
{
    public class getQueueInfoExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

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

            try {
                // Get worker queue information.
                QueueInfoResponse result = apiInstance.getQueueInfo();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PlatformApi.getQueueInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

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

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

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

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

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

try:
    # Get worker queue information.
    api_response = api_instance.get_queue_info()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlatformApi->getQueueInfo: %s\n" % e)
extern crate PlatformApi;

pub fn main() {

    let mut context = PlatformApi::Context::default();
    let result = client.getQueueInfo(&context).wait();

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

Scopes

Parameters

Responses


statPlatformFile

Stat platform file (only admins).


/api/v1/platform/file/stat

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/platform/file/stat?ref=ref_example&type=type_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PlatformApi;

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

public class PlatformApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PlatformApi apiInstance = new PlatformApi();
        String ref = ref_example; // String | File reference
        String type = type_example; // String | File type - i.e. 'asset'

        try {
            FileStatResponse result = apiInstance.statPlatformFile(ref, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlatformApi#statPlatformFile");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PlatformApi;

public class PlatformApiExample {
    public static void main(String[] args) {
        PlatformApi apiInstance = new PlatformApi();
        String ref = ref_example; // String | File reference
        String type = type_example; // String | File type - i.e. 'asset'

        try {
            FileStatResponse result = apiInstance.statPlatformFile(ref, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlatformApi#statPlatformFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
PlatformApi *apiInstance = [[PlatformApi alloc] init];
String *ref = ref_example; // File reference (default to null)
String *type = type_example; // File type - i.e. 'asset' (default to null)

// Stat platform file (only admins).
[apiInstance statPlatformFileWith:ref
    type:type
              completionHandler: ^(FileStatResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.PlatformApi()
var ref = ref_example; // {String} File reference
var type = type_example; // {String} File type - i.e. 'asset'

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

namespace Example
{
    public class statPlatformFileExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PlatformApi();
            var ref = ref_example;  // String | File reference (default to null)
            var type = type_example;  // String | File type - i.e. 'asset' (default to null)

            try {
                // Stat platform file (only admins).
                FileStatResponse result = apiInstance.statPlatformFile(ref, type);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PlatformApi.statPlatformFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PlatformApi();
$ref = ref_example; // String | File reference
$type = type_example; // String | File type - i.e. 'asset'

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PlatformApi->new();
my $ref = ref_example; # String | File reference
my $type = type_example; # String | File type - i.e. 'asset'

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

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

# Create an instance of the API class
api_instance = openapi_client.PlatformApi()
ref = ref_example # String | File reference (default to null)
type = type_example # String | File type - i.e. 'asset' (default to null)

try:
    # Stat platform file (only admins).
    api_response = api_instance.stat_platform_file(ref, type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlatformApi->statPlatformFile: %s\n" % e)
extern crate PlatformApi;

pub fn main() {
    let ref = ref_example; // String
    let type = type_example; // String

    let mut context = PlatformApi::Context::default();
    let result = client.statPlatformFile(ref, type, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
ref*
String
File reference
Required
type*
String
File type - i.e. 'asset'
Required

Responses


uploadFilePart

Upload a file part to the platform.


/api/v1/platform/filepart

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: multipart/form-data" \
 "http://localhost:8082/api/v1/platform/filepart?ref=ref_example&state=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PlatformApi;

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

public class PlatformApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PlatformApi apiInstance = new PlatformApi();
        String ref = ref_example; // String | File reference
        Integer state = 56; // Integer | File upload state: 1 - part, 2 - done.
        File file = BINARY_DATA_HERE; // File | 

        try {
            'String' result = apiInstance.uploadFilePart(ref, state, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlatformApi#uploadFilePart");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PlatformApi;

public class PlatformApiExample {
    public static void main(String[] args) {
        PlatformApi apiInstance = new PlatformApi();
        String ref = ref_example; // String | File reference
        Integer state = 56; // Integer | File upload state: 1 - part, 2 - done.
        File file = BINARY_DATA_HERE; // File | 

        try {
            'String' result = apiInstance.uploadFilePart(ref, state, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlatformApi#uploadFilePart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
PlatformApi *apiInstance = [[PlatformApi alloc] init];
String *ref = ref_example; // File reference (default to null)
Integer *state = 56; // File upload state: 1 - part, 2 - done. (default to null)
File *file = BINARY_DATA_HERE; //  (optional) (default to null)

// Upload a file part to the platform.
[apiInstance uploadFilePartWith:ref
    state:state
    file:file
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new GuardAiPlatformApi.PlatformApi()
var ref = ref_example; // {String} File reference
var state = 56; // {Integer} File upload state: 1 - part, 2 - done.
var opts = {
  'file': BINARY_DATA_HERE // {File} 
};

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

namespace Example
{
    public class uploadFilePartExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PlatformApi();
            var ref = ref_example;  // String | File reference (default to null)
            var state = 56;  // Integer | File upload state: 1 - part, 2 - done. (default to null)
            var file = BINARY_DATA_HERE;  // File |  (optional)  (default to null)

            try {
                // Upload a file part to the platform.
                'String' result = apiInstance.uploadFilePart(ref, state, file);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PlatformApi.uploadFilePart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PlatformApi();
$ref = ref_example; // String | File reference
$state = 56; // Integer | File upload state: 1 - part, 2 - done.
$file = BINARY_DATA_HERE; // File | 

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PlatformApi->new();
my $ref = ref_example; # String | File reference
my $state = 56; # Integer | File upload state: 1 - part, 2 - done.
my $file = BINARY_DATA_HERE; # File | 

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

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

# Create an instance of the API class
api_instance = openapi_client.PlatformApi()
ref = ref_example # String | File reference (default to null)
state = 56 # Integer | File upload state: 1 - part, 2 - done. (default to null)
file = BINARY_DATA_HERE # File |  (optional) (default to null)

try:
    # Upload a file part to the platform.
    api_response = api_instance.upload_file_part(ref, state, file=file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlatformApi->uploadFilePart: %s\n" % e)
extern crate PlatformApi;

pub fn main() {
    let ref = ref_example; // String
    let state = 56; // Integer
    let file = BINARY_DATA_HERE; // File

    let mut context = PlatformApi::Context::default();
    let result = client.uploadFilePart(ref, state, file, &context).wait();

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

Scopes

Parameters

Form parameters
Name Description
file
File (binary)
Query parameters
Name Description
ref*
String
File reference
Required
state*
Integer (int32)
File upload state: 1 - part, 2 - done.
Required

Responses


uploadPlatformFile

Upload a file to the platform and return a reference (only admins).


/api/v1/platform/file

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: multipart/form-data" \
 "http://localhost:8082/api/v1/platform/file?chunked=true&description=description_example&type=type_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PlatformApi;

import java.io.File;
import java.util.*;

public class PlatformApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PlatformApi apiInstance = new PlatformApi();
        String type = type_example; // String | Upload type - i.e. 'asset'
        Boolean chunked = true; // Boolean | Chunked upload
        String description = description_example; // String | File description
        File file = BINARY_DATA_HERE; // File | 

        try {
            'String' result = apiInstance.uploadPlatformFile(type, chunked, description, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlatformApi#uploadPlatformFile");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PlatformApi;

public class PlatformApiExample {
    public static void main(String[] args) {
        PlatformApi apiInstance = new PlatformApi();
        String type = type_example; // String | Upload type - i.e. 'asset'
        Boolean chunked = true; // Boolean | Chunked upload
        String description = description_example; // String | File description
        File file = BINARY_DATA_HERE; // File | 

        try {
            'String' result = apiInstance.uploadPlatformFile(type, chunked, description, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlatformApi#uploadPlatformFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
PlatformApi *apiInstance = [[PlatformApi alloc] init];
String *type = type_example; // Upload type - i.e. 'asset' (default to null)
Boolean *chunked = true; // Chunked upload (optional) (default to null)
String *description = description_example; // File description (optional) (default to null)
File *file = BINARY_DATA_HERE; //  (optional) (default to null)

// Upload a file to the platform and return a reference (only admins).
[apiInstance uploadPlatformFileWith:type
    chunked:chunked
    description:description
    file:file
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.PlatformApi()
var type = type_example; // {String} Upload type - i.e. 'asset'
var opts = {
  'chunked': true, // {Boolean} Chunked upload
  'description': description_example, // {String} File description
  'file': BINARY_DATA_HERE // {File} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.uploadPlatformFile(type, opts, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class uploadPlatformFileExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PlatformApi();
            var type = type_example;  // String | Upload type - i.e. 'asset' (default to null)
            var chunked = true;  // Boolean | Chunked upload (optional)  (default to null)
            var description = description_example;  // String | File description (optional)  (default to null)
            var file = BINARY_DATA_HERE;  // File |  (optional)  (default to null)

            try {
                // Upload a file to the platform and return a reference (only admins).
                'String' result = apiInstance.uploadPlatformFile(type, chunked, description, file);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PlatformApi.uploadPlatformFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PlatformApi();
$type = type_example; // String | Upload type - i.e. 'asset'
$chunked = true; // Boolean | Chunked upload
$description = description_example; // String | File description
$file = BINARY_DATA_HERE; // File | 

try {
    $result = $api_instance->uploadPlatformFile($type, $chunked, $description, $file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PlatformApi->uploadPlatformFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PlatformApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PlatformApi->new();
my $type = type_example; # String | Upload type - i.e. 'asset'
my $chunked = true; # Boolean | Chunked upload
my $description = description_example; # String | File description
my $file = BINARY_DATA_HERE; # File | 

eval {
    my $result = $api_instance->uploadPlatformFile(type => $type, chunked => $chunked, description => $description, file => $file);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PlatformApi->uploadPlatformFile: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PlatformApi()
type = type_example # String | Upload type - i.e. 'asset' (default to null)
chunked = true # Boolean | Chunked upload (optional) (default to null)
description = description_example # String | File description (optional) (default to null)
file = BINARY_DATA_HERE # File |  (optional) (default to null)

try:
    # Upload a file to the platform and return a reference (only admins).
    api_response = api_instance.upload_platform_file(type, chunked=chunked, description=description, file=file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlatformApi->uploadPlatformFile: %s\n" % e)
extern crate PlatformApi;

pub fn main() {
    let type = type_example; // String
    let chunked = true; // Boolean
    let description = description_example; // String
    let file = BINARY_DATA_HERE; // File

    let mut context = PlatformApi::Context::default();
    let result = client.uploadPlatformFile(type, chunked, description, file, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Form parameters
Name Description
file
File (binary)
Query parameters
Name Description
chunked
Boolean
Chunked upload
description
String
File description
type*
String
Upload type - i.e. 'asset'
Required

Responses


workerHeartbeat

Worker heartbeat - can only be called by a worker instance.


/api/v1/platform/heartbeat

Usage and SDK Samples

curl -X PUT \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: application/json,application/xml" \
 "http://localhost:8082/api/v1/platform/heartbeat" \
 -d '{
  "workerId" : "workerId",
  "status" : "CANCELLED"
}' \
 -d '<WorkerHeartbeatRequest>
  <status>aeiou</status>
  <workerId>aeiou</workerId>
</WorkerHeartbeatRequest>'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PlatformApi;

import java.io.File;
import java.util.*;

public class PlatformApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PlatformApi apiInstance = new PlatformApi();
        WorkerHeartbeatRequest request = ; // WorkerHeartbeatRequest | 

        try {
            'Boolean' result = apiInstance.workerHeartbeat(request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlatformApi#workerHeartbeat");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PlatformApi;

public class PlatformApiExample {
    public static void main(String[] args) {
        PlatformApi apiInstance = new PlatformApi();
        WorkerHeartbeatRequest request = ; // WorkerHeartbeatRequest | 

        try {
            'Boolean' result = apiInstance.workerHeartbeat(request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlatformApi#workerHeartbeat");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
PlatformApi *apiInstance = [[PlatformApi alloc] init];
WorkerHeartbeatRequest *request = ; // 

// Worker heartbeat - can only be called by a worker instance.
[apiInstance workerHeartbeatWith:request
              completionHandler: ^('Boolean' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.PlatformApi()
var request = ; // {WorkerHeartbeatRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.workerHeartbeat(request, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class workerHeartbeatExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PlatformApi();
            var request = new WorkerHeartbeatRequest(); // WorkerHeartbeatRequest | 

            try {
                // Worker heartbeat - can only be called by a worker instance.
                'Boolean' result = apiInstance.workerHeartbeat(request);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PlatformApi.workerHeartbeat: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PlatformApi();
$request = ; // WorkerHeartbeatRequest | 

try {
    $result = $api_instance->workerHeartbeat($request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PlatformApi->workerHeartbeat: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PlatformApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PlatformApi->new();
my $request = WWW::OPenAPIClient::Object::WorkerHeartbeatRequest->new(); # WorkerHeartbeatRequest | 

eval {
    my $result = $api_instance->workerHeartbeat(request => $request);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PlatformApi->workerHeartbeat: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PlatformApi()
request =  # WorkerHeartbeatRequest | 

try:
    # Worker heartbeat - can only be called by a worker instance.
    api_response = api_instance.worker_heartbeat(request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlatformApi->workerHeartbeat: %s\n" % e)
extern crate PlatformApi;

pub fn main() {
    let request = ; // WorkerHeartbeatRequest

    let mut context = PlatformApi::Context::default();
    let result = client.workerHeartbeat(request, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
request *

request

Responses


Project

addProject

Add a project to an organization.


/api/v1/projects

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: application/json,application/xml" \
 "http://localhost:8082/api/v1/projects?organizationId=789" \
 -d '{
  "valid" : true,
  "settings" : {
    "classMappingParams" : "{}",
    "storeIntermediateData" : true,
    "transforms" : [ {
      "name" : "name",
      "id" : 1,
      "params" : "{}"
    }, {
      "name" : "name",
      "id" : 1,
      "params" : "{}"
    } ],
    "classMappingEstimation" : true,
    "hpoId" : 5,
    "sourceModelId" : 2,
    "epsExplorationParams" : "{}",
    "epsExploration" : true,
    "headSettings" : [ {
      "head" : {
        "name" : "name",
        "losses" : [ "losses", "losses" ]
      },
      "metrics" : [ {
        "uid" : "uid",
        "name" : "name",
        "params" : "{}",
        "enabled" : true
      }, {
        "uid" : "uid",
        "name" : "name",
        "params" : "{}",
        "enabled" : true
      } ]
    }, {
      "head" : {
        "name" : "name",
        "losses" : [ "losses", "losses" ]
      },
      "metrics" : [ {
        "uid" : "uid",
        "name" : "name",
        "params" : "{}",
        "enabled" : true
      }, {
        "uid" : "uid",
        "name" : "name",
        "params" : "{}",
        "enabled" : true
      } ]
    } ],
    "approximateRobustness" : true,
    "storeCompositeImages" : true,
    "useClassNamesFromDataset" : true,
    "batchWiseHPO" : true,
    "datasetId" : 5,
    "hpoParams" : "{}",
    "optimalParameterization" : true,
    "tasks" : [ "tasks", "tasks" ],
    "arParams" : "{}"
  },
  "datasetLength" : 0,
  "name" : "name",
  "heads" : [ {
    "name" : "name",
    "losses" : [ "losses", "losses" ]
  }, {
    "name" : "name",
    "losses" : [ "losses", "losses" ]
  } ],
  "message" : "message"
}' \
 -d '<ProjectRequest>
  <datasetLength>123456789</datasetLength>
  <message>aeiou</message>
  <name>aeiou</name>
  <valid>true</valid>
</ProjectRequest>'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectApi;

import java.io.File;
import java.util.*;

public class ProjectApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ProjectApi apiInstance = new ProjectApi();
        Long organizationId = 789; // Long | The organization ID.
        ProjectRequest project = ; // ProjectRequest | 

        try {
            ProjectResponse result = apiInstance.addProject(organizationId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#addProject");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ProjectApi;

public class ProjectApiExample {
    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        Long organizationId = 789; // Long | The organization ID.
        ProjectRequest project = ; // ProjectRequest | 

        try {
            ProjectResponse result = apiInstance.addProject(organizationId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#addProject");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
ProjectApi *apiInstance = [[ProjectApi alloc] init];
Long *organizationId = 789; // The organization ID. (default to null)
ProjectRequest *project = ; // 

// Add a project to an organization.
[apiInstance addProjectWith:organizationId
    project:project
              completionHandler: ^(ProjectResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.ProjectApi()
var organizationId = 789; // {Long} The organization ID.
var project = ; // {ProjectRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addProject(organizationId, project, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class addProjectExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ProjectApi();
            var organizationId = 789;  // Long | The organization ID. (default to null)
            var project = new ProjectRequest(); // ProjectRequest | 

            try {
                // Add a project to an organization.
                ProjectResponse result = apiInstance.addProject(organizationId, project);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectApi.addProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectApi();
$organizationId = 789; // Long | The organization ID.
$project = ; // ProjectRequest | 

try {
    $result = $api_instance->addProject($organizationId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->addProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectApi->new();
my $organizationId = 789; # Long | The organization ID.
my $project = WWW::OPenAPIClient::Object::ProjectRequest->new(); # ProjectRequest | 

eval {
    my $result = $api_instance->addProject(organizationId => $organizationId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->addProject: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ProjectApi()
organizationId = 789 # Long | The organization ID. (default to null)
project =  # ProjectRequest | 

try:
    # Add a project to an organization.
    api_response = api_instance.add_project(organizationId, project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->addProject: %s\n" % e)
extern crate ProjectApi;

pub fn main() {
    let organizationId = 789; // Long
    let project = ; // ProjectRequest

    let mut context = ProjectApi::Context::default();
    let result = client.addProject(organizationId, project, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
project *

project

Query parameters
Name Description
organizationId*
Long (int64)
The organization ID.
Required

Responses


copyProject

Make a copy of the project available to (optionally) another organization.


/api/v1/projects/{id}/copy

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: application/json,application/xml" \
 "http://localhost:8082/api/v1/projects/{id}/copy?destOrgId=789" \
 -d '{
  "valid" : true,
  "settings" : {
    "classMappingParams" : "{}",
    "storeIntermediateData" : true,
    "transforms" : [ {
      "name" : "name",
      "id" : 1,
      "params" : "{}"
    }, {
      "name" : "name",
      "id" : 1,
      "params" : "{}"
    } ],
    "classMappingEstimation" : true,
    "hpoId" : 5,
    "sourceModelId" : 2,
    "epsExplorationParams" : "{}",
    "epsExploration" : true,
    "headSettings" : [ {
      "head" : {
        "name" : "name",
        "losses" : [ "losses", "losses" ]
      },
      "metrics" : [ {
        "uid" : "uid",
        "name" : "name",
        "params" : "{}",
        "enabled" : true
      }, {
        "uid" : "uid",
        "name" : "name",
        "params" : "{}",
        "enabled" : true
      } ]
    }, {
      "head" : {
        "name" : "name",
        "losses" : [ "losses", "losses" ]
      },
      "metrics" : [ {
        "uid" : "uid",
        "name" : "name",
        "params" : "{}",
        "enabled" : true
      }, {
        "uid" : "uid",
        "name" : "name",
        "params" : "{}",
        "enabled" : true
      } ]
    } ],
    "approximateRobustness" : true,
    "storeCompositeImages" : true,
    "useClassNamesFromDataset" : true,
    "batchWiseHPO" : true,
    "datasetId" : 5,
    "hpoParams" : "{}",
    "optimalParameterization" : true,
    "tasks" : [ "tasks", "tasks" ],
    "arParams" : "{}"
  },
  "datasetLength" : 0,
  "name" : "name",
  "heads" : [ {
    "name" : "name",
    "losses" : [ "losses", "losses" ]
  }, {
    "name" : "name",
    "losses" : [ "losses", "losses" ]
  } ],
  "message" : "message"
}' \
 -d '<ProjectRequest>
  <datasetLength>123456789</datasetLength>
  <message>aeiou</message>
  <name>aeiou</name>
  <valid>true</valid>
</ProjectRequest>'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectApi;

import java.io.File;
import java.util.*;

public class ProjectApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ProjectApi apiInstance = new ProjectApi();
        Long id = 789; // Long | The project ID.
        ProjectRequest newProject = ; // ProjectRequest | 
        Long destOrgId = 789; // Long | The optional destination organization id.

        try {
            ProjectResponse result = apiInstance.copyProject(id, newProject, destOrgId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#copyProject");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ProjectApi;

public class ProjectApiExample {
    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        Long id = 789; // Long | The project ID.
        ProjectRequest newProject = ; // ProjectRequest | 
        Long destOrgId = 789; // Long | The optional destination organization id.

        try {
            ProjectResponse result = apiInstance.copyProject(id, newProject, destOrgId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#copyProject");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
ProjectApi *apiInstance = [[ProjectApi alloc] init];
Long *id = 789; // The project ID. (default to null)
ProjectRequest *newProject = ; // 
Long *destOrgId = 789; // The optional destination organization id. (optional) (default to null)

// Make a copy of the project available to (optionally) another organization.
[apiInstance copyProjectWith:id
    newProject:newProject
    destOrgId:destOrgId
              completionHandler: ^(ProjectResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.ProjectApi()
var id = 789; // {Long} The project ID.
var newProject = ; // {ProjectRequest} 
var opts = {
  'destOrgId': 789 // {Long} The optional destination organization id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.copyProject(id, newProject, opts, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class copyProjectExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ProjectApi();
            var id = 789;  // Long | The project ID. (default to null)
            var newProject = new ProjectRequest(); // ProjectRequest | 
            var destOrgId = 789;  // Long | The optional destination organization id. (optional)  (default to null)

            try {
                // Make a copy of the project available to (optionally) another organization.
                ProjectResponse result = apiInstance.copyProject(id, newProject, destOrgId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectApi.copyProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectApi();
$id = 789; // Long | The project ID.
$newProject = ; // ProjectRequest | 
$destOrgId = 789; // Long | The optional destination organization id.

try {
    $result = $api_instance->copyProject($id, $newProject, $destOrgId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->copyProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectApi->new();
my $id = 789; # Long | The project ID.
my $newProject = WWW::OPenAPIClient::Object::ProjectRequest->new(); # ProjectRequest | 
my $destOrgId = 789; # Long | The optional destination organization id.

eval {
    my $result = $api_instance->copyProject(id => $id, newProject => $newProject, destOrgId => $destOrgId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->copyProject: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ProjectApi()
id = 789 # Long | The project ID. (default to null)
newProject =  # ProjectRequest | 
destOrgId = 789 # Long | The optional destination organization id. (optional) (default to null)

try:
    # Make a copy of the project available to (optionally) another organization.
    api_response = api_instance.copy_project(id, newProject, destOrgId=destOrgId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->copyProject: %s\n" % e)
extern crate ProjectApi;

pub fn main() {
    let id = 789; // Long
    let newProject = ; // ProjectRequest
    let destOrgId = 789; // Long

    let mut context = ProjectApi::Context::default();
    let result = client.copyProject(id, newProject, destOrgId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The project ID.
Required
Body parameters
Name Description
newProject *

Optional new project information.

Query parameters
Name Description
destOrgId
Long (int64)
The optional destination organization id.

Responses


copyProjectModel

Make a copy of the project model available to the organization.


/api/v1/projects/{id}/copymodel

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 -H "Content-Type: application/json,application/xml" \
 "http://localhost:8082/api/v1/projects/{id}/copymodel?destModelId=789" \
 -d '{
  "environment" : "environment",
  "frameworkType" : "Keras",
  "name" : "name",
  "transforms" : [ {
    "name" : "name",
    "id" : 1,
    "params" : "{}"
  }, {
    "name" : "name",
    "id" : 1,
    "params" : "{}"
  } ],
  "datasetId" : 0,
  "description" : "description",
  "tasks" : [ "tasks", "tasks" ]
}' \
 -d '<ModelRequest>
  <datasetId>123456789</datasetId>
  <description>aeiou</description>
  <environment>aeiou</environment>
  <frameworkType>aeiou</frameworkType>
  <name>aeiou</name>
  <tasks>aeiou</tasks>
</ModelRequest>'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectApi;

import java.io.File;
import java.util.*;

public class ProjectApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ProjectApi apiInstance = new ProjectApi();
        Long id = 789; // Long | The project ID.
        ModelRequest model = ; // ModelRequest | 
        Long destModelId = 789; // Long | The optional destination model id.

        try {
            apiInstance.copyProjectModel(id, model, destModelId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#copyProjectModel");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ProjectApi;

public class ProjectApiExample {
    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        Long id = 789; // Long | The project ID.
        ModelRequest model = ; // ModelRequest | 
        Long destModelId = 789; // Long | The optional destination model id.

        try {
            apiInstance.copyProjectModel(id, model, destModelId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#copyProjectModel");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
ProjectApi *apiInstance = [[ProjectApi alloc] init];
Long *id = 789; // The project ID. (default to null)
ModelRequest *model = ; // 
Long *destModelId = 789; // The optional destination model id. (optional) (default to null)

// Make a copy of the project model available to the organization.
[apiInstance copyProjectModelWith:id
    model:model
    destModelId:destModelId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.ProjectApi()
var id = 789; // {Long} The project ID.
var model = ; // {ModelRequest} 
var opts = {
  'destModelId': 789 // {Long} The optional destination model id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.copyProjectModel(id, model, opts, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class copyProjectModelExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ProjectApi();
            var id = 789;  // Long | The project ID. (default to null)
            var model = new ModelRequest(); // ModelRequest | 
            var destModelId = 789;  // Long | The optional destination model id. (optional)  (default to null)

            try {
                // Make a copy of the project model available to the organization.
                apiInstance.copyProjectModel(id, model, destModelId);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectApi.copyProjectModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectApi();
$id = 789; // Long | The project ID.
$model = ; // ModelRequest | 
$destModelId = 789; // Long | The optional destination model id.

try {
    $api_instance->copyProjectModel($id, $model, $destModelId);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->copyProjectModel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectApi->new();
my $id = 789; # Long | The project ID.
my $model = WWW::OPenAPIClient::Object::ModelRequest->new(); # ModelRequest | 
my $destModelId = 789; # Long | The optional destination model id.

eval {
    $api_instance->copyProjectModel(id => $id, model => $model, destModelId => $destModelId);
};
if ($@) {
    warn "Exception when calling ProjectApi->copyProjectModel: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ProjectApi()
id = 789 # Long | The project ID. (default to null)
model =  # ModelRequest | 
destModelId = 789 # Long | The optional destination model id. (optional) (default to null)

try:
    # Make a copy of the project model available to the organization.
    api_instance.copy_project_model(id, model, destModelId=destModelId)
except ApiException as e:
    print("Exception when calling ProjectApi->copyProjectModel: %s\n" % e)
extern crate ProjectApi;

pub fn main() {
    let id = 789; // Long
    let model = ; // ModelRequest
    let destModelId = 789; // Long

    let mut context = ProjectApi::Context::default();
    let result = client.copyProjectModel(id, model, destModelId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The project ID.
Required
Body parameters
Name Description
model *

New model information.

Query parameters
Name Description
destModelId
Long (int64)
The optional destination model id.

Responses


deleteData

Delete project model data.


/api/v1/projects/{id}/modeldata

Usage and SDK Samples

curl -X DELETE \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/projects/{id}/modeldata?dataType=dataType_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectApi;

import java.io.File;
import java.util.*;

public class ProjectApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ProjectApi apiInstance = new ProjectApi();
        String dataType = dataType_example; // String | dataType
        Long id = 789; // Long | The project ID.

        try {
            ProjectResponse result = apiInstance.deleteData(dataType, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#deleteData");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ProjectApi;

public class ProjectApiExample {
    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        String dataType = dataType_example; // String | dataType
        Long id = 789; // Long | The project ID.

        try {
            ProjectResponse result = apiInstance.deleteData(dataType, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#deleteData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
ProjectApi *apiInstance = [[ProjectApi alloc] init];
String *dataType = dataType_example; // dataType (default to null)
Long *id = 789; // The project ID. (default to null)

// Delete project model data.
[apiInstance deleteDataWith:dataType
    id:id
              completionHandler: ^(ProjectResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.ProjectApi()
var dataType = dataType_example; // {String} dataType
var id = 789; // {Long} The project ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteData(dataType, id, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class deleteDataExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ProjectApi();
            var dataType = dataType_example;  // String | dataType (default to null)
            var id = 789;  // Long | The project ID. (default to null)

            try {
                // Delete project model data.
                ProjectResponse result = apiInstance.deleteData(dataType, id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectApi.deleteData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectApi();
$dataType = dataType_example; // String | dataType
$id = 789; // Long | The project ID.

try {
    $result = $api_instance->deleteData($dataType, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->deleteData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectApi->new();
my $dataType = dataType_example; # String | dataType
my $id = 789; # Long | The project ID.

eval {
    my $result = $api_instance->deleteData(dataType => $dataType, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->deleteData: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ProjectApi()
dataType = dataType_example # String | dataType (default to null)
id = 789 # Long | The project ID. (default to null)

try:
    # Delete project model data.
    api_response = api_instance.delete_data(dataType, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->deleteData: %s\n" % e)
extern crate ProjectApi;

pub fn main() {
    let dataType = dataType_example; // String
    let id = 789; // Long

    let mut context = ProjectApi::Context::default();
    let result = client.deleteData(dataType, id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The project ID.
Required
Query parameters
Name Description
dataType*
String
dataType
Required

Responses


deleteProject

Delete a project.


/api/v1/projects/{id}

Usage and SDK Samples

curl -X DELETE \
-H "Authorization: [[apiKey]]" \
 "http://localhost:8082/api/v1/projects/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectApi;

import java.io.File;
import java.util.*;

public class ProjectApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ProjectApi apiInstance = new ProjectApi();
        Long id = 789; // Long | The project ID.

        try {
            apiInstance.deleteProject(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#deleteProject");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ProjectApi;

public class ProjectApiExample {
    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        Long id = 789; // Long | The project ID.

        try {
            apiInstance.deleteProject(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#deleteProject");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
ProjectApi *apiInstance = [[ProjectApi alloc] init];
Long *id = 789; // The project ID. (default to null)

// Delete a project.
[apiInstance deleteProjectWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.ProjectApi()
var id = 789; // {Long} The project ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteProject(id, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class deleteProjectExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ProjectApi();
            var id = 789;  // Long | The project ID. (default to null)

            try {
                // Delete a project.
                apiInstance.deleteProject(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectApi.deleteProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectApi();
$id = 789; // Long | The project ID.

try {
    $api_instance->deleteProject($id);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->deleteProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectApi->new();
my $id = 789; # Long | The project ID.

eval {
    $api_instance->deleteProject(id => $id);
};
if ($@) {
    warn "Exception when calling ProjectApi->deleteProject: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ProjectApi()
id = 789 # Long | The project ID. (default to null)

try:
    # Delete a project.
    api_instance.delete_project(id)
except ApiException as e:
    print("Exception when calling ProjectApi->deleteProject: %s\n" % e)
extern crate ProjectApi;

pub fn main() {
    let id = 789; // Long

    let mut context = ProjectApi::Context::default();
    let result = client.deleteProject(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The project ID.
Required

Responses


downloadProjectData

Download project data.


/api/v1/projects/{id}/data

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/projects/{id}/data?dataType=dataType_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectApi;

import java.io.File;
import java.util.*;

public class ProjectApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ProjectApi apiInstance = new ProjectApi();
        String dataType = dataType_example; // String | dataType
        Long id = 789; // Long | The project ID.

        try {
            File result = apiInstance.downloadProjectData(dataType, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#downloadProjectData");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ProjectApi;

public class ProjectApiExample {
    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        String dataType = dataType_example; // String | dataType
        Long id = 789; // Long | The project ID.

        try {
            File result = apiInstance.downloadProjectData(dataType, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#downloadProjectData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
ProjectApi *apiInstance = [[ProjectApi alloc] init];
String *dataType = dataType_example; // dataType (default to null)
Long *id = 789; // The project ID. (default to null)

// Download project data.
[apiInstance downloadProjectDataWith:dataType
    id:id
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.ProjectApi()
var dataType = dataType_example; // {String} dataType
var id = 789; // {Long} The project ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.downloadProjectData(dataType, id, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class downloadProjectDataExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ProjectApi();
            var dataType = dataType_example;  // String | dataType (default to null)
            var id = 789;  // Long | The project ID. (default to null)

            try {
                // Download project data.
                File result = apiInstance.downloadProjectData(dataType, id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectApi.downloadProjectData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectApi();
$dataType = dataType_example; // String | dataType
$id = 789; // Long | The project ID.

try {
    $result = $api_instance->downloadProjectData($dataType, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->downloadProjectData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectApi->new();
my $dataType = dataType_example; # String | dataType
my $id = 789; # Long | The project ID.

eval {
    my $result = $api_instance->downloadProjectData(dataType => $dataType, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->downloadProjectData: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ProjectApi()
dataType = dataType_example # String | dataType (default to null)
id = 789 # Long | The project ID. (default to null)

try:
    # Download project data.
    api_response = api_instance.download_project_data(dataType, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->downloadProjectData: %s\n" % e)
extern crate ProjectApi;

pub fn main() {
    let dataType = dataType_example; // String
    let id = 789; // Long

    let mut context = ProjectApi::Context::default();
    let result = client.downloadProjectData(dataType, id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The project ID.
Required
Query parameters
Name Description
dataType*
String
dataType
Required

Responses


getProject

Get a project.


/api/v1/projects/{id}

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/projects/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectApi;

import java.io.File;
import java.util.*;

public class ProjectApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ProjectApi apiInstance = new ProjectApi();
        Long id = 789; // Long | The project ID.

        try {
            ProjectResponse result = apiInstance.getProject(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#getProject");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ProjectApi;

public class ProjectApiExample {
    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        Long id = 789; // Long | The project ID.

        try {
            ProjectResponse result = apiInstance.getProject(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#getProject");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
ProjectApi *apiInstance = [[ProjectApi alloc] init];
Long *id = 789; // The project ID. (default to null)

// Get a project.
[apiInstance getProjectWith:id
              completionHandler: ^(ProjectResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.ProjectApi()
var id = 789; // {Long} The project ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProject(id, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class getProjectExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ProjectApi();
            var id = 789;  // Long | The project ID. (default to null)

            try {
                // Get a project.
                ProjectResponse result = apiInstance.getProject(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectApi.getProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectApi();
$id = 789; // Long | The project ID.

try {
    $result = $api_instance->getProject($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->getProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectApi->new();
my $id = 789; # Long | The project ID.

eval {
    my $result = $api_instance->getProject(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->getProject: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ProjectApi()
id = 789 # Long | The project ID. (default to null)

try:
    # Get a project.
    api_response = api_instance.get_project(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->getProject: %s\n" % e)
extern crate ProjectApi;

pub fn main() {
    let id = 789; // Long

    let mut context = ProjectApi::Context::default();
    let result = client.getProject(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The project ID.
Required

Responses


getProjects

Get list of projects.


/api/v1/projects

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/projects?organizationId=789"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectApi;

import java.io.File;
import java.util.*;

public class ProjectApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ProjectApi apiInstance = new ProjectApi();
        Long organizationId = 789; // Long | The optional organization ID.

        try {
            array[ProjectResponse] result = apiInstance.getProjects(organizationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#getProjects");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ProjectApi;

public class ProjectApiExample {
    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        Long organizationId = 789; // Long | The optional organization ID.

        try {
            array[ProjectResponse] result = apiInstance.getProjects(organizationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#getProjects");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
ProjectApi *apiInstance = [[ProjectApi alloc] init];
Long *organizationId = 789; // The optional organization ID. (optional) (default to null)

// Get list of projects.
[apiInstance getProjectsWith:organizationId
              completionHandler: ^(array[ProjectResponse] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.ProjectApi()
var opts = {
  'organizationId': 789 // {Long} The optional organization ID.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProjects(opts, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class getProjectsExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ProjectApi();
            var organizationId = 789;  // Long | The optional organization ID. (optional)  (default to null)

            try {
                // Get list of projects.
                array[ProjectResponse] result = apiInstance.getProjects(organizationId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectApi.getProjects: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectApi();
$organizationId = 789; // Long | The optional organization ID.

try {
    $result = $api_instance->getProjects($organizationId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->getProjects: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectApi->new();
my $organizationId = 789; # Long | The optional organization ID.

eval {
    my $result = $api_instance->getProjects(organizationId => $organizationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->getProjects: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ProjectApi()
organizationId = 789 # Long | The optional organization ID. (optional) (default to null)

try:
    # Get list of projects.
    api_response = api_instance.get_projects(organizationId=organizationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->getProjects: %s\n" % e)
extern crate ProjectApi;

pub fn main() {
    let organizationId = 789; // Long

    let mut context = ProjectApi::Context::default();
    let result = client.getProjects(organizationId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
organizationId
Long (int64)
The optional organization ID.

Responses


updateProject

Update project .


/api/v1/projects/{id}

Usage and SDK Samples

curl -X PUT \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: application/json,application/xml" \
 "http://localhost:8082/api/v1/projects/{id}" \
 -d '{
  "valid" : true,
  "settings" : {
    "classMappingParams" : "{}",
    "storeIntermediateData" : true,
    "transforms" : [ {
      "name" : "name",
      "id" : 1,
      "params" : "{}"
    }, {
      "name" : "name",
      "id" : 1,
      "params" : "{}"
    } ],
    "classMappingEstimation" : true,
    "hpoId" : 5,
    "sourceModelId" : 2,
    "epsExplorationParams" : "{}",
    "epsExploration" : true,
    "headSettings" : [ {
      "head" : {
        "name" : "name",
        "losses" : [ "losses", "losses" ]
      },
      "metrics" : [ {
        "uid" : "uid",
        "name" : "name",
        "params" : "{}",
        "enabled" : true
      }, {
        "uid" : "uid",
        "name" : "name",
        "params" : "{}",
        "enabled" : true
      } ]
    }, {
      "head" : {
        "name" : "name",
        "losses" : [ "losses", "losses" ]
      },
      "metrics" : [ {
        "uid" : "uid",
        "name" : "name",
        "params" : "{}",
        "enabled" : true
      }, {
        "uid" : "uid",
        "name" : "name",
        "params" : "{}",
        "enabled" : true
      } ]
    } ],
    "approximateRobustness" : true,
    "storeCompositeImages" : true,
    "useClassNamesFromDataset" : true,
    "batchWiseHPO" : true,
    "datasetId" : 5,
    "hpoParams" : "{}",
    "optimalParameterization" : true,
    "tasks" : [ "tasks", "tasks" ],
    "arParams" : "{}"
  },
  "datasetLength" : 0,
  "name" : "name",
  "heads" : [ {
    "name" : "name",
    "losses" : [ "losses", "losses" ]
  }, {
    "name" : "name",
    "losses" : [ "losses", "losses" ]
  } ],
  "message" : "message"
}' \
 -d '<ProjectRequest>
  <datasetLength>123456789</datasetLength>
  <message>aeiou</message>
  <name>aeiou</name>
  <valid>true</valid>
</ProjectRequest>'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectApi;

import java.io.File;
import java.util.*;

public class ProjectApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ProjectApi apiInstance = new ProjectApi();
        Long id = 789; // Long | The project ID.
        ProjectRequest projectRequest = ; // ProjectRequest | 

        try {
            ProjectResponse result = apiInstance.updateProject(id, projectRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#updateProject");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ProjectApi;

public class ProjectApiExample {
    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        Long id = 789; // Long | The project ID.
        ProjectRequest projectRequest = ; // ProjectRequest | 

        try {
            ProjectResponse result = apiInstance.updateProject(id, projectRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#updateProject");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
ProjectApi *apiInstance = [[ProjectApi alloc] init];
Long *id = 789; // The project ID. (default to null)
ProjectRequest *projectRequest = ; // 

// Update project .
[apiInstance updateProjectWith:id
    projectRequest:projectRequest
              completionHandler: ^(ProjectResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.ProjectApi()
var id = 789; // {Long} The project ID.
var projectRequest = ; // {ProjectRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateProject(id, projectRequest, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class updateProjectExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ProjectApi();
            var id = 789;  // Long | The project ID. (default to null)
            var projectRequest = new ProjectRequest(); // ProjectRequest | 

            try {
                // Update project .
                ProjectResponse result = apiInstance.updateProject(id, projectRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectApi.updateProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectApi();
$id = 789; // Long | The project ID.
$projectRequest = ; // ProjectRequest | 

try {
    $result = $api_instance->updateProject($id, $projectRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->updateProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectApi->new();
my $id = 789; # Long | The project ID.
my $projectRequest = WWW::OPenAPIClient::Object::ProjectRequest->new(); # ProjectRequest | 

eval {
    my $result = $api_instance->updateProject(id => $id, projectRequest => $projectRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->updateProject: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ProjectApi()
id = 789 # Long | The project ID. (default to null)
projectRequest =  # ProjectRequest | 

try:
    # Update project .
    api_response = api_instance.update_project(id, projectRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->updateProject: %s\n" % e)
extern crate ProjectApi;

pub fn main() {
    let id = 789; // Long
    let projectRequest = ; // ProjectRequest

    let mut context = ProjectApi::Context::default();
    let result = client.updateProject(id, projectRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The project ID.
Required
Body parameters
Name Description
projectRequest *

projectRequest

Responses


uploadProjectData

Upload project data.


/api/v1/projects/{id}/modeldata

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: multipart/form-data" \
 "http://localhost:8082/api/v1/projects/{id}/modeldata?dataType=dataType_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectApi;

import java.io.File;
import java.util.*;

public class ProjectApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ProjectApi apiInstance = new ProjectApi();
        String dataType = dataType_example; // String | dataType
        Long id = 789; // Long | The project ID.
        File file = BINARY_DATA_HERE; // File | 

        try {
            ProjectResponse result = apiInstance.uploadProjectData(dataType, id, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#uploadProjectData");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ProjectApi;

public class ProjectApiExample {
    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        String dataType = dataType_example; // String | dataType
        Long id = 789; // Long | The project ID.
        File file = BINARY_DATA_HERE; // File | 

        try {
            ProjectResponse result = apiInstance.uploadProjectData(dataType, id, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#uploadProjectData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
ProjectApi *apiInstance = [[ProjectApi alloc] init];
String *dataType = dataType_example; // dataType (default to null)
Long *id = 789; // The project ID. (default to null)
File *file = BINARY_DATA_HERE; //  (optional) (default to null)

// Upload project data.
[apiInstance uploadProjectDataWith:dataType
    id:id
    file:file
              completionHandler: ^(ProjectResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.ProjectApi()
var dataType = dataType_example; // {String} dataType
var id = 789; // {Long} The project ID.
var opts = {
  'file': BINARY_DATA_HERE // {File} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.uploadProjectData(dataType, id, opts, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class uploadProjectDataExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ProjectApi();
            var dataType = dataType_example;  // String | dataType (default to null)
            var id = 789;  // Long | The project ID. (default to null)
            var file = BINARY_DATA_HERE;  // File |  (optional)  (default to null)

            try {
                // Upload project data.
                ProjectResponse result = apiInstance.uploadProjectData(dataType, id, file);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectApi.uploadProjectData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectApi();
$dataType = dataType_example; // String | dataType
$id = 789; // Long | The project ID.
$file = BINARY_DATA_HERE; // File | 

try {
    $result = $api_instance->uploadProjectData($dataType, $id, $file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->uploadProjectData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectApi->new();
my $dataType = dataType_example; # String | dataType
my $id = 789; # Long | The project ID.
my $file = BINARY_DATA_HERE; # File | 

eval {
    my $result = $api_instance->uploadProjectData(dataType => $dataType, id => $id, file => $file);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->uploadProjectData: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ProjectApi()
dataType = dataType_example # String | dataType (default to null)
id = 789 # Long | The project ID. (default to null)
file = BINARY_DATA_HERE # File |  (optional) (default to null)

try:
    # Upload project data.
    api_response = api_instance.upload_project_data(dataType, id, file=file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->uploadProjectData: %s\n" % e)
extern crate ProjectApi;

pub fn main() {
    let dataType = dataType_example; // String
    let id = 789; // Long
    let file = BINARY_DATA_HERE; // File

    let mut context = ProjectApi::Context::default();
    let result = client.uploadProjectData(dataType, id, file, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The project ID.
Required
Form parameters
Name Description
file
File (binary)
Query parameters
Name Description
dataType*
String
dataType
Required

Responses


uploadProjectFile

Upload a file to the project and return a reference.


/api/v1/projects/{id}/files

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: multipart/form-data" \
 "http://localhost:8082/api/v1/projects/{id}/files?type=type_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectApi;

import java.io.File;
import java.util.*;

public class ProjectApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ProjectApi apiInstance = new ProjectApi();
        Long id = 789; // Long | The project ID.
        String type = type_example; // String | Upload type - 'transform' for transform parameters
        File file = BINARY_DATA_HERE; // File | 

        try {
            'String' result = apiInstance.uploadProjectFile(id, type, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#uploadProjectFile");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ProjectApi;

public class ProjectApiExample {
    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        Long id = 789; // Long | The project ID.
        String type = type_example; // String | Upload type - 'transform' for transform parameters
        File file = BINARY_DATA_HERE; // File | 

        try {
            'String' result = apiInstance.uploadProjectFile(id, type, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#uploadProjectFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
ProjectApi *apiInstance = [[ProjectApi alloc] init];
Long *id = 789; // The project ID. (default to null)
String *type = type_example; // Upload type - 'transform' for transform parameters (default to null)
File *file = BINARY_DATA_HERE; //  (optional) (default to null)

// Upload a file to the project and return a reference.
[apiInstance uploadProjectFileWith:id
    type:type
    file:file
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.ProjectApi()
var id = 789; // {Long} The project ID.
var type = type_example; // {String} Upload type - 'transform' for transform parameters
var opts = {
  'file': BINARY_DATA_HERE // {File} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.uploadProjectFile(id, type, opts, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class uploadProjectFileExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ProjectApi();
            var id = 789;  // Long | The project ID. (default to null)
            var type = type_example;  // String | Upload type - 'transform' for transform parameters (default to null)
            var file = BINARY_DATA_HERE;  // File |  (optional)  (default to null)

            try {
                // Upload a file to the project and return a reference.
                'String' result = apiInstance.uploadProjectFile(id, type, file);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectApi.uploadProjectFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectApi();
$id = 789; // Long | The project ID.
$type = type_example; // String | Upload type - 'transform' for transform parameters
$file = BINARY_DATA_HERE; // File | 

try {
    $result = $api_instance->uploadProjectFile($id, $type, $file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->uploadProjectFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectApi->new();
my $id = 789; # Long | The project ID.
my $type = type_example; # String | Upload type - 'transform' for transform parameters
my $file = BINARY_DATA_HERE; # File | 

eval {
    my $result = $api_instance->uploadProjectFile(id => $id, type => $type, file => $file);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->uploadProjectFile: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ProjectApi()
id = 789 # Long | The project ID. (default to null)
type = type_example # String | Upload type - 'transform' for transform parameters (default to null)
file = BINARY_DATA_HERE # File |  (optional) (default to null)

try:
    # Upload a file to the project and return a reference.
    api_response = api_instance.upload_project_file(id, type, file=file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->uploadProjectFile: %s\n" % e)
extern crate ProjectApi;

pub fn main() {
    let id = 789; // Long
    let type = type_example; // String
    let file = BINARY_DATA_HERE; // File

    let mut context = ProjectApi::Context::default();
    let result = client.uploadProjectFile(id, type, file, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The project ID.
Required
Form parameters
Name Description
file
File (binary)
Query parameters
Name Description
type*
String
Upload type - 'transform' for transform parameters
Required

Responses


useModel

Use an existing model to configure the project.


/api/v1/projects/{id}/usemodel

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/projects/{id}/usemodel?modelId=789"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectApi;

import java.io.File;
import java.util.*;

public class ProjectApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ProjectApi apiInstance = new ProjectApi();
        Long id = 789; // Long | The project ID.
        Long modelId = 789; // Long | The model ID.

        try {
            ProjectResponse result = apiInstance.useModel(id, modelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#useModel");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ProjectApi;

public class ProjectApiExample {
    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        Long id = 789; // Long | The project ID.
        Long modelId = 789; // Long | The model ID.

        try {
            ProjectResponse result = apiInstance.useModel(id, modelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#useModel");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
ProjectApi *apiInstance = [[ProjectApi alloc] init];
Long *id = 789; // The project ID. (default to null)
Long *modelId = 789; // The model ID. (default to null)

// Use an existing model to configure the project.
[apiInstance useModelWith:id
    modelId:modelId
              completionHandler: ^(ProjectResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.ProjectApi()
var id = 789; // {Long} The project ID.
var modelId = 789; // {Long} The model ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.useModel(id, modelId, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class useModelExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ProjectApi();
            var id = 789;  // Long | The project ID. (default to null)
            var modelId = 789;  // Long | The model ID. (default to null)

            try {
                // Use an existing model to configure the project.
                ProjectResponse result = apiInstance.useModel(id, modelId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectApi.useModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectApi();
$id = 789; // Long | The project ID.
$modelId = 789; // Long | The model ID.

try {
    $result = $api_instance->useModel($id, $modelId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->useModel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectApi->new();
my $id = 789; # Long | The project ID.
my $modelId = 789; # Long | The model ID.

eval {
    my $result = $api_instance->useModel(id => $id, modelId => $modelId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->useModel: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ProjectApi()
id = 789 # Long | The project ID. (default to null)
modelId = 789 # Long | The model ID. (default to null)

try:
    # Use an existing model to configure the project.
    api_response = api_instance.use_model(id, modelId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->useModel: %s\n" % e)
extern crate ProjectApi;

pub fn main() {
    let id = 789; // Long
    let modelId = 789; // Long

    let mut context = ProjectApi::Context::default();
    let result = client.useModel(id, modelId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The project ID.
Required
Query parameters
Name Description
modelId*
Long (int64)
The model ID.
Required

Responses


verifyProject

Start the model verification process.


/api/v1/projects/{id}/verify

Usage and SDK Samples

curl -X PUT \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/projects/{id}/verify"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectApi;

import java.io.File;
import java.util.*;

public class ProjectApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ProjectApi apiInstance = new ProjectApi();
        Long id = 789; // Long | The project ID.

        try {
            ProjectResponse result = apiInstance.verifyProject(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#verifyProject");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ProjectApi;

public class ProjectApiExample {
    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        Long id = 789; // Long | The project ID.

        try {
            ProjectResponse result = apiInstance.verifyProject(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#verifyProject");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
ProjectApi *apiInstance = [[ProjectApi alloc] init];
Long *id = 789; // The project ID. (default to null)

// Start the model verification process.
[apiInstance verifyProjectWith:id
              completionHandler: ^(ProjectResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.ProjectApi()
var id = 789; // {Long} The project ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.verifyProject(id, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class verifyProjectExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ProjectApi();
            var id = 789;  // Long | The project ID. (default to null)

            try {
                // Start the model verification process.
                ProjectResponse result = apiInstance.verifyProject(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectApi.verifyProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectApi();
$id = 789; // Long | The project ID.

try {
    $result = $api_instance->verifyProject($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->verifyProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectApi->new();
my $id = 789; # Long | The project ID.

eval {
    my $result = $api_instance->verifyProject(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->verifyProject: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ProjectApi()
id = 789 # Long | The project ID. (default to null)

try:
    # Start the model verification process.
    api_response = api_instance.verify_project(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->verifyProject: %s\n" % e)
extern crate ProjectApi;

pub fn main() {
    let id = 789; // Long

    let mut context = ProjectApi::Context::default();
    let result = client.verifyProject(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The project ID.
Required

Responses


Register

register

Register user


/api/v1/register

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: application/json,application/xml" \
 "http://localhost:8082/api/v1/register" \
 -d '{
  "token" : "token"
}' \
 -d '<RegisterRequest>
  <token>aeiou</token>
</RegisterRequest>'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RegisterApi;

import java.io.File;
import java.util.*;

public class RegisterApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        RegisterApi apiInstance = new RegisterApi();
        RegisterRequest request = ; // RegisterRequest | 

        try {
            AuthorizedUserResponse result = apiInstance.register(request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegisterApi#register");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RegisterApi;

public class RegisterApiExample {
    public static void main(String[] args) {
        RegisterApi apiInstance = new RegisterApi();
        RegisterRequest request = ; // RegisterRequest | 

        try {
            AuthorizedUserResponse result = apiInstance.register(request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegisterApi#register");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
RegisterApi *apiInstance = [[RegisterApi alloc] init];
RegisterRequest *request = ; // 

// Register user
[apiInstance registerWith:request
              completionHandler: ^(AuthorizedUserResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.RegisterApi()
var request = ; // {RegisterRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.register(request, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class registerExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new RegisterApi();
            var request = new RegisterRequest(); // RegisterRequest | 

            try {
                // Register user
                AuthorizedUserResponse result = apiInstance.register(request);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RegisterApi.register: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RegisterApi();
$request = ; // RegisterRequest | 

try {
    $result = $api_instance->register($request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RegisterApi->register: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RegisterApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RegisterApi->new();
my $request = WWW::OPenAPIClient::Object::RegisterRequest->new(); # RegisterRequest | 

eval {
    my $result = $api_instance->register(request => $request);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RegisterApi->register: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.RegisterApi()
request =  # RegisterRequest | 

try:
    # Register user
    api_response = api_instance.register(request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegisterApi->register: %s\n" % e)
extern crate RegisterApi;

pub fn main() {
    let request = ; // RegisterRequest

    let mut context = RegisterApi::Context::default();
    let result = client.register(request, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
request *

request

Responses


sendInvite

Send user invite - admin permissions required.


/api/v1/register/invite

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 -H "Content-Type: application/json,application/xml" \
 "http://localhost:8082/api/v1/register/invite" \
 -d '{
  "name" : "name",
  "email" : "email"
}' \
 -d '<InviteRequest>
  <email>aeiou</email>
  <name>aeiou</name>
</InviteRequest>'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RegisterApi;

import java.io.File;
import java.util.*;

public class RegisterApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        RegisterApi apiInstance = new RegisterApi();
        InviteRequest request = ; // InviteRequest | 

        try {
            apiInstance.sendInvite(request);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegisterApi#sendInvite");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RegisterApi;

public class RegisterApiExample {
    public static void main(String[] args) {
        RegisterApi apiInstance = new RegisterApi();
        InviteRequest request = ; // InviteRequest | 

        try {
            apiInstance.sendInvite(request);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegisterApi#sendInvite");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
RegisterApi *apiInstance = [[RegisterApi alloc] init];
InviteRequest *request = ; // 

// Send user invite - admin permissions required.
[apiInstance sendInviteWith:request
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.RegisterApi()
var request = ; // {InviteRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.sendInvite(request, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class sendInviteExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new RegisterApi();
            var request = new InviteRequest(); // InviteRequest | 

            try {
                // Send user invite - admin permissions required.
                apiInstance.sendInvite(request);
            } catch (Exception e) {
                Debug.Print("Exception when calling RegisterApi.sendInvite: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RegisterApi();
$request = ; // InviteRequest | 

try {
    $api_instance->sendInvite($request);
} catch (Exception $e) {
    echo 'Exception when calling RegisterApi->sendInvite: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RegisterApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RegisterApi->new();
my $request = WWW::OPenAPIClient::Object::InviteRequest->new(); # InviteRequest | 

eval {
    $api_instance->sendInvite(request => $request);
};
if ($@) {
    warn "Exception when calling RegisterApi->sendInvite: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.RegisterApi()
request =  # InviteRequest | 

try:
    # Send user invite - admin permissions required.
    api_instance.send_invite(request)
except ApiException as e:
    print("Exception when calling RegisterApi->sendInvite: %s\n" % e)
extern crate RegisterApi;

pub fn main() {
    let request = ; // InviteRequest

    let mut context = RegisterApi::Context::default();
    let result = client.sendInvite(request, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
request *

request

Responses


Reports

addReport

Add report.


/api/v1/reports

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: application/json,application/xml" \
 "http://localhost:8082/api/v1/reports" \
 -d '{
  "testId" : 1,
  "jsonReport" : "jsonReport",
  "runId" : 6,
  "dataRef" : "dataRef",
  "projectId" : 0
}' \
 -d '<ReportRequest>
  <dataRef>aeiou</dataRef>
  <jsonReport>aeiou</jsonReport>
  <projectId>123456789</projectId>
  <runId>123</runId>
  <testId>123456789</testId>
</ReportRequest>'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ReportsApi;

import java.io.File;
import java.util.*;

public class ReportsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ReportsApi apiInstance = new ReportsApi();
        ReportRequest report = ; // ReportRequest | 

        try {
            ReportResponse result = apiInstance.addReport(report);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#addReport");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ReportsApi;

public class ReportsApiExample {
    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        ReportRequest report = ; // ReportRequest | 

        try {
            ReportResponse result = apiInstance.addReport(report);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#addReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
ReportsApi *apiInstance = [[ReportsApi alloc] init];
ReportRequest *report = ; // 

// Add report.
[apiInstance addReportWith:report
              completionHandler: ^(ReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.ReportsApi()
var report = ; // {ReportRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addReport(report, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class addReportExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ReportsApi();
            var report = new ReportRequest(); // ReportRequest | 

            try {
                // Add report.
                ReportResponse result = apiInstance.addReport(report);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ReportsApi.addReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ReportsApi();
$report = ; // ReportRequest | 

try {
    $result = $api_instance->addReport($report);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->addReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ReportsApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ReportsApi->new();
my $report = WWW::OPenAPIClient::Object::ReportRequest->new(); # ReportRequest | 

eval {
    my $result = $api_instance->addReport(report => $report);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReportsApi->addReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ReportsApi()
report =  # ReportRequest | 

try:
    # Add report.
    api_response = api_instance.add_report(report)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReportsApi->addReport: %s\n" % e)
extern crate ReportsApi;

pub fn main() {
    let report = ; // ReportRequest

    let mut context = ReportsApi::Context::default();
    let result = client.addReport(report, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
report *

report

Responses


deleteReport

Delete a report.


/api/v1/reports/{id}

Usage and SDK Samples

curl -X DELETE \
-H "Authorization: [[apiKey]]" \
 "http://localhost:8082/api/v1/reports/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ReportsApi;

import java.io.File;
import java.util.*;

public class ReportsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ReportsApi apiInstance = new ReportsApi();
        Long id = 789; // Long | id

        try {
            apiInstance.deleteReport(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#deleteReport");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ReportsApi;

public class ReportsApiExample {
    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        Long id = 789; // Long | id

        try {
            apiInstance.deleteReport(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#deleteReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
ReportsApi *apiInstance = [[ReportsApi alloc] init];
Long *id = 789; // id (default to null)

// Delete a report.
[apiInstance deleteReportWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.ReportsApi()
var id = 789; // {Long} id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteReport(id, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class deleteReportExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ReportsApi();
            var id = 789;  // Long | id (default to null)

            try {
                // Delete a report.
                apiInstance.deleteReport(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling ReportsApi.deleteReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ReportsApi();
$id = 789; // Long | id

try {
    $api_instance->deleteReport($id);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->deleteReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ReportsApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ReportsApi->new();
my $id = 789; # Long | id

eval {
    $api_instance->deleteReport(id => $id);
};
if ($@) {
    warn "Exception when calling ReportsApi->deleteReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ReportsApi()
id = 789 # Long | id (default to null)

try:
    # Delete a report.
    api_instance.delete_report(id)
except ApiException as e:
    print("Exception when calling ReportsApi->deleteReport: %s\n" % e)
extern crate ReportsApi;

pub fn main() {
    let id = 789; // Long

    let mut context = ReportsApi::Context::default();
    let result = client.deleteReport(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
id
Required

Responses


downloadReportData

Download report data.


/api/v1/reports/{id}/download

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/reports/{id}/download"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ReportsApi;

import java.io.File;
import java.util.*;

public class ReportsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ReportsApi apiInstance = new ReportsApi();
        Long id = 789; // Long | id

        try {
            File result = apiInstance.downloadReportData(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#downloadReportData");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ReportsApi;

public class ReportsApiExample {
    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        Long id = 789; // Long | id

        try {
            File result = apiInstance.downloadReportData(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#downloadReportData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
ReportsApi *apiInstance = [[ReportsApi alloc] init];
Long *id = 789; // id (default to null)

// Download report data.
[apiInstance downloadReportDataWith:id
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.ReportsApi()
var id = 789; // {Long} id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.downloadReportData(id, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class downloadReportDataExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ReportsApi();
            var id = 789;  // Long | id (default to null)

            try {
                // Download report data.
                File result = apiInstance.downloadReportData(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ReportsApi.downloadReportData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ReportsApi();
$id = 789; // Long | id

try {
    $result = $api_instance->downloadReportData($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->downloadReportData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ReportsApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ReportsApi->new();
my $id = 789; # Long | id

eval {
    my $result = $api_instance->downloadReportData(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReportsApi->downloadReportData: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ReportsApi()
id = 789 # Long | id (default to null)

try:
    # Download report data.
    api_response = api_instance.download_report_data(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReportsApi->downloadReportData: %s\n" % e)
extern crate ReportsApi;

pub fn main() {
    let id = 789; // Long

    let mut context = ReportsApi::Context::default();
    let result = client.downloadReportData(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
id
Required

Responses


getReport

Get a report.


/api/v1/reports/{reportId}

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/reports/{reportId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ReportsApi;

import java.io.File;
import java.util.*;

public class ReportsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ReportsApi apiInstance = new ReportsApi();
        Long reportId = 789; // Long | reportId

        try {
            ReportResponse result = apiInstance.getReport(reportId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#getReport");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ReportsApi;

public class ReportsApiExample {
    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        Long reportId = 789; // Long | reportId

        try {
            ReportResponse result = apiInstance.getReport(reportId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#getReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
ReportsApi *apiInstance = [[ReportsApi alloc] init];
Long *reportId = 789; // reportId (default to null)

// Get a report.
[apiInstance getReportWith:reportId
              completionHandler: ^(ReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.ReportsApi()
var reportId = 789; // {Long} reportId

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getReport(reportId, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class getReportExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ReportsApi();
            var reportId = 789;  // Long | reportId (default to null)

            try {
                // Get a report.
                ReportResponse result = apiInstance.getReport(reportId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ReportsApi.getReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ReportsApi();
$reportId = 789; // Long | reportId

try {
    $result = $api_instance->getReport($reportId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->getReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ReportsApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ReportsApi->new();
my $reportId = 789; # Long | reportId

eval {
    my $result = $api_instance->getReport(reportId => $reportId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReportsApi->getReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ReportsApi()
reportId = 789 # Long | reportId (default to null)

try:
    # Get a report.
    api_response = api_instance.get_report(reportId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReportsApi->getReport: %s\n" % e)
extern crate ReportsApi;

pub fn main() {
    let reportId = 789; // Long

    let mut context = ReportsApi::Context::default();
    let result = client.getReport(reportId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
reportId*
Long (int64)
reportId
Required

Responses


getReportFile

Get file from report.


/api/v1/reports/{id}/file

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/reports/{id}/file?fileName=fileName_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ReportsApi;

import java.io.File;
import java.util.*;

public class ReportsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ReportsApi apiInstance = new ReportsApi();
        String fileName = fileName_example; // String | fileName
        Long id = 789; // Long | id

        try {
            File result = apiInstance.getReportFile(fileName, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#getReportFile");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ReportsApi;

public class ReportsApiExample {
    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        String fileName = fileName_example; // String | fileName
        Long id = 789; // Long | id

        try {
            File result = apiInstance.getReportFile(fileName, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#getReportFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
ReportsApi *apiInstance = [[ReportsApi alloc] init];
String *fileName = fileName_example; // fileName (default to null)
Long *id = 789; // id (default to null)

// Get file from report.
[apiInstance getReportFileWith:fileName
    id:id
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.ReportsApi()
var fileName = fileName_example; // {String} fileName
var id = 789; // {Long} id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getReportFile(fileName, id, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class getReportFileExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ReportsApi();
            var fileName = fileName_example;  // String | fileName (default to null)
            var id = 789;  // Long | id (default to null)

            try {
                // Get file from report.
                File result = apiInstance.getReportFile(fileName, id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ReportsApi.getReportFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ReportsApi();
$fileName = fileName_example; // String | fileName
$id = 789; // Long | id

try {
    $result = $api_instance->getReportFile($fileName, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->getReportFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ReportsApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ReportsApi->new();
my $fileName = fileName_example; # String | fileName
my $id = 789; # Long | id

eval {
    my $result = $api_instance->getReportFile(fileName => $fileName, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReportsApi->getReportFile: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ReportsApi()
fileName = fileName_example # String | fileName (default to null)
id = 789 # Long | id (default to null)

try:
    # Get file from report.
    api_response = api_instance.get_report_file(fileName, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReportsApi->getReportFile: %s\n" % e)
extern crate ReportsApi;

pub fn main() {
    let fileName = fileName_example; // String
    let id = 789; // Long

    let mut context = ReportsApi::Context::default();
    let result = client.getReportFile(fileName, id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
id
Required
Query parameters
Name Description
fileName*
String
fileName
Required

Responses


getReportMetaData

Get meta data.


/api/v1/reports/{id}/meta

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/reports/{id}/meta"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ReportsApi;

import java.io.File;
import java.util.*;

public class ReportsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ReportsApi apiInstance = new ReportsApi();
        Long id = 789; // Long | id

        try {
            File result = apiInstance.getReportMetaData(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#getReportMetaData");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ReportsApi;

public class ReportsApiExample {
    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        Long id = 789; // Long | id

        try {
            File result = apiInstance.getReportMetaData(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#getReportMetaData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
ReportsApi *apiInstance = [[ReportsApi alloc] init];
Long *id = 789; // id (default to null)

// Get meta data.
[apiInstance getReportMetaDataWith:id
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.ReportsApi()
var id = 789; // {Long} id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getReportMetaData(id, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class getReportMetaDataExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ReportsApi();
            var id = 789;  // Long | id (default to null)

            try {
                // Get meta data.
                File result = apiInstance.getReportMetaData(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ReportsApi.getReportMetaData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ReportsApi();
$id = 789; // Long | id

try {
    $result = $api_instance->getReportMetaData($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->getReportMetaData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ReportsApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ReportsApi->new();
my $id = 789; # Long | id

eval {
    my $result = $api_instance->getReportMetaData(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReportsApi->getReportMetaData: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ReportsApi()
id = 789 # Long | id (default to null)

try:
    # Get meta data.
    api_response = api_instance.get_report_meta_data(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReportsApi->getReportMetaData: %s\n" % e)
extern crate ReportsApi;

pub fn main() {
    let id = 789; // Long

    let mut context = ReportsApi::Context::default();
    let result = client.getReportMetaData(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
id
Required

Responses


getReports

Get reports for a test.


/api/v1/reports

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/reports?testId=789"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ReportsApi;

import java.io.File;
import java.util.*;

public class ReportsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ReportsApi apiInstance = new ReportsApi();
        Long testId = 789; // Long | testId

        try {
            array[ReportResponse] result = apiInstance.getReports(testId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#getReports");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ReportsApi;

public class ReportsApiExample {
    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        Long testId = 789; // Long | testId

        try {
            array[ReportResponse] result = apiInstance.getReports(testId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#getReports");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
ReportsApi *apiInstance = [[ReportsApi alloc] init];
Long *testId = 789; // testId (default to null)

// Get reports for a test.
[apiInstance getReportsWith:testId
              completionHandler: ^(array[ReportResponse] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.ReportsApi()
var testId = 789; // {Long} testId

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getReports(testId, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class getReportsExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ReportsApi();
            var testId = 789;  // Long | testId (default to null)

            try {
                // Get reports for a test.
                array[ReportResponse] result = apiInstance.getReports(testId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ReportsApi.getReports: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ReportsApi();
$testId = 789; // Long | testId

try {
    $result = $api_instance->getReports($testId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->getReports: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ReportsApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ReportsApi->new();
my $testId = 789; # Long | testId

eval {
    my $result = $api_instance->getReports(testId => $testId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReportsApi->getReports: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ReportsApi()
testId = 789 # Long | testId (default to null)

try:
    # Get reports for a test.
    api_response = api_instance.get_reports(testId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReportsApi->getReports: %s\n" % e)
extern crate ReportsApi;

pub fn main() {
    let testId = 789; // Long

    let mut context = ReportsApi::Context::default();
    let result = client.getReports(testId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
testId*
Long (int64)
testId
Required

Responses


viewData

View report data.


/api/v1/reports/{id}/{didx}/{aidx}/{idx}/{tag}

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/reports/{id}/{didx}/{aidx}/{idx}/{tag}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ReportsApi;

import java.io.File;
import java.util.*;

public class ReportsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ReportsApi apiInstance = new ReportsApi();
        Integer aidx = 56; // Integer | aidx
        Integer didx = 56; // Integer | didx
        Long id = 789; // Long | id
        Integer idx = 56; // Integer | idx
        String tag = tag_example; // String | tag

        try {
            File result = apiInstance.viewData(aidx, didx, id, idx, tag);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#viewData");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ReportsApi;

public class ReportsApiExample {
    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        Integer aidx = 56; // Integer | aidx
        Integer didx = 56; // Integer | didx
        Long id = 789; // Long | id
        Integer idx = 56; // Integer | idx
        String tag = tag_example; // String | tag

        try {
            File result = apiInstance.viewData(aidx, didx, id, idx, tag);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#viewData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
ReportsApi *apiInstance = [[ReportsApi alloc] init];
Integer *aidx = 56; // aidx (default to null)
Integer *didx = 56; // didx (default to null)
Long *id = 789; // id (default to null)
Integer *idx = 56; // idx (default to null)
String *tag = tag_example; // tag (default to null)

// View report data.
[apiInstance viewDataWith:aidx
    didx:didx
    id:id
    idx:idx
    tag:tag
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.ReportsApi()
var aidx = 56; // {Integer} aidx
var didx = 56; // {Integer} didx
var id = 789; // {Long} id
var idx = 56; // {Integer} idx
var tag = tag_example; // {String} tag

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.viewData(aidx, didx, id, idx, tag, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class viewDataExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ReportsApi();
            var aidx = 56;  // Integer | aidx (default to null)
            var didx = 56;  // Integer | didx (default to null)
            var id = 789;  // Long | id (default to null)
            var idx = 56;  // Integer | idx (default to null)
            var tag = tag_example;  // String | tag (default to null)

            try {
                // View report data.
                File result = apiInstance.viewData(aidx, didx, id, idx, tag);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ReportsApi.viewData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ReportsApi();
$aidx = 56; // Integer | aidx
$didx = 56; // Integer | didx
$id = 789; // Long | id
$idx = 56; // Integer | idx
$tag = tag_example; // String | tag

try {
    $result = $api_instance->viewData($aidx, $didx, $id, $idx, $tag);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->viewData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ReportsApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ReportsApi->new();
my $aidx = 56; # Integer | aidx
my $didx = 56; # Integer | didx
my $id = 789; # Long | id
my $idx = 56; # Integer | idx
my $tag = tag_example; # String | tag

eval {
    my $result = $api_instance->viewData(aidx => $aidx, didx => $didx, id => $id, idx => $idx, tag => $tag);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReportsApi->viewData: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ReportsApi()
aidx = 56 # Integer | aidx (default to null)
didx = 56 # Integer | didx (default to null)
id = 789 # Long | id (default to null)
idx = 56 # Integer | idx (default to null)
tag = tag_example # String | tag (default to null)

try:
    # View report data.
    api_response = api_instance.view_data(aidx, didx, id, idx, tag)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReportsApi->viewData: %s\n" % e)
extern crate ReportsApi;

pub fn main() {
    let aidx = 56; // Integer
    let didx = 56; // Integer
    let id = 789; // Long
    let idx = 56; // Integer
    let tag = tag_example; // String

    let mut context = ReportsApi::Context::default();
    let result = client.viewData(aidx, didx, id, idx, tag, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
aidx*
Integer (int32)
aidx
Required
didx*
Integer (int32)
didx
Required
id*
Long (int64)
id
Required
idx*
Integer (int32)
idx
Required
tag*
String
tag
Required

Responses


Test

addDefense

Add defense.


/api/v1/tests/{testId}/defense

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: application/json,application/xml" \
 "http://localhost:8082/api/v1/tests/{testId}/defense" \
 -d '{
  "name" : "name",
  "parameters" : "parameters"
}' \
 -d '<DefenseRequest>
  <name>aeiou</name>
  <parameters>aeiou</parameters>
</DefenseRequest>'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TestApi;

import java.io.File;
import java.util.*;

public class TestApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TestApi apiInstance = new TestApi();
        Long testId = 789; // Long | The test id.
        DefenseRequest defenseRequest = ; // DefenseRequest | 

        try {
            TestResponse result = apiInstance.addDefense(testId, defenseRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestApi#addDefense");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TestApi;

public class TestApiExample {
    public static void main(String[] args) {
        TestApi apiInstance = new TestApi();
        Long testId = 789; // Long | The test id.
        DefenseRequest defenseRequest = ; // DefenseRequest | 

        try {
            TestResponse result = apiInstance.addDefense(testId, defenseRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestApi#addDefense");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
TestApi *apiInstance = [[TestApi alloc] init];
Long *testId = 789; // The test id. (default to null)
DefenseRequest *defenseRequest = ; // 

// Add defense.
[apiInstance addDefenseWith:testId
    defenseRequest:defenseRequest
              completionHandler: ^(TestResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.TestApi()
var testId = 789; // {Long} The test id.
var defenseRequest = ; // {DefenseRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addDefense(testId, defenseRequest, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class addDefenseExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TestApi();
            var testId = 789;  // Long | The test id. (default to null)
            var defenseRequest = new DefenseRequest(); // DefenseRequest | 

            try {
                // Add defense.
                TestResponse result = apiInstance.addDefense(testId, defenseRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TestApi.addDefense: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TestApi();
$testId = 789; // Long | The test id.
$defenseRequest = ; // DefenseRequest | 

try {
    $result = $api_instance->addDefense($testId, $defenseRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TestApi->addDefense: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TestApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TestApi->new();
my $testId = 789; # Long | The test id.
my $defenseRequest = WWW::OPenAPIClient::Object::DefenseRequest->new(); # DefenseRequest | 

eval {
    my $result = $api_instance->addDefense(testId => $testId, defenseRequest => $defenseRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TestApi->addDefense: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TestApi()
testId = 789 # Long | The test id. (default to null)
defenseRequest =  # DefenseRequest | 

try:
    # Add defense.
    api_response = api_instance.add_defense(testId, defenseRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TestApi->addDefense: %s\n" % e)
extern crate TestApi;

pub fn main() {
    let testId = 789; // Long
    let defenseRequest = ; // DefenseRequest

    let mut context = TestApi::Context::default();
    let result = client.addDefense(testId, defenseRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
testId*
Long (int64)
The test id.
Required
Body parameters
Name Description
defenseRequest *

The defense object

Responses


addFilter

Add a filter.


/api/v1/tests/{id}/filter

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: application/json,application/xml" \
 "http://localhost:8082/api/v1/tests/{id}/filter" \
 -d '{
  "name" : "name",
  "type" : "adversarial_attacks",
  "parameters" : "parameters",
  "enabled" : true
}' \
 -d '<FilterRequest>
  <enabled>true</enabled>
  <name>aeiou</name>
  <parameters>aeiou</parameters>
  <type>aeiou</type>
</FilterRequest>'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TestApi;

import java.io.File;
import java.util.*;

public class TestApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TestApi apiInstance = new TestApi();
        Long id = 789; // Long | The test id.
        FilterRequest attackRequest = ; // FilterRequest | 

        try {
            TestResponse result = apiInstance.addFilter(id, attackRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestApi#addFilter");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TestApi;

public class TestApiExample {
    public static void main(String[] args) {
        TestApi apiInstance = new TestApi();
        Long id = 789; // Long | The test id.
        FilterRequest attackRequest = ; // FilterRequest | 

        try {
            TestResponse result = apiInstance.addFilter(id, attackRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestApi#addFilter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
TestApi *apiInstance = [[TestApi alloc] init];
Long *id = 789; // The test id. (default to null)
FilterRequest *attackRequest = ; // 

// Add a filter.
[apiInstance addFilterWith:id
    attackRequest:attackRequest
              completionHandler: ^(TestResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.TestApi()
var id = 789; // {Long} The test id.
var attackRequest = ; // {FilterRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addFilter(id, attackRequest, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class addFilterExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TestApi();
            var id = 789;  // Long | The test id. (default to null)
            var attackRequest = new FilterRequest(); // FilterRequest | 

            try {
                // Add a filter.
                TestResponse result = apiInstance.addFilter(id, attackRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TestApi.addFilter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TestApi();
$id = 789; // Long | The test id.
$attackRequest = ; // FilterRequest | 

try {
    $result = $api_instance->addFilter($id, $attackRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TestApi->addFilter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TestApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TestApi->new();
my $id = 789; # Long | The test id.
my $attackRequest = WWW::OPenAPIClient::Object::FilterRequest->new(); # FilterRequest | 

eval {
    my $result = $api_instance->addFilter(id => $id, attackRequest => $attackRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TestApi->addFilter: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TestApi()
id = 789 # Long | The test id. (default to null)
attackRequest =  # FilterRequest | 

try:
    # Add a filter.
    api_response = api_instance.add_filter(id, attackRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TestApi->addFilter: %s\n" % e)
extern crate TestApi;

pub fn main() {
    let id = 789; // Long
    let attackRequest = ; // FilterRequest

    let mut context = TestApi::Context::default();
    let result = client.addFilter(id, attackRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The test id.
Required
Body parameters
Name Description
attackRequest *

attackRequest

Responses


addTest

Add a new test.


/api/v1/tests

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: application/json,application/xml" \
 "http://localhost:8082/api/v1/tests" \
 -d '{
  "testSettings" : {
    "configured" : true,
    "storeIntermediateData" : true,
    "detectionTestSettings" : {
      "id" : 7,
      "params" : "{}",
      "poisonedDatasetSetting" : {
        "selectionType" : "COUNT",
        "endIdx" : 7,
        "indexes" : [ 1, 1 ],
        "startIdx" : 6,
        "batchSize" : 4,
        "shuffle" : true,
        "workers" : 7,
        "fraction" : 1.2315135,
        "numItems" : 1
      },
      "passDeviations" : 9.301444
    },
    "testType" : "Crafted",
    "hpoId" : 5,
    "epsExplorationParams" : "{}",
    "epsExploration" : true,
    "passFailCriteria" : [ {
      "metricName" : "metricName",
      "above" : true,
      "passVal" : 2.027123,
      "enabled" : true
    }, {
      "metricName" : "metricName",
      "above" : true,
      "passVal" : 2.027123,
      "enabled" : true
    } ],
    "datasetSetting" : {
      "selectionType" : "COUNT",
      "endIdx" : 7,
      "indexes" : [ 1, 1 ],
      "startIdx" : 6,
      "batchSize" : 4,
      "shuffle" : true,
      "workers" : 7,
      "fraction" : 1.2315135,
      "numItems" : 1
    },
    "approximateRobustness" : true,
    "storeCompositeImages" : true,
    "overlayImageOnSegMap" : true,
    "batchWiseHPO" : true,
    "hpoParams" : "{}",
    "metrics" : {
      "key" : [ {
        "uid" : "uid",
        "name" : "name",
        "params" : "{}",
        "enabled" : true
      }, {
        "uid" : "uid",
        "name" : "name",
        "params" : "{}",
        "enabled" : true
      } ]
    },
    "optimalParameterization" : true,
    "craftedSettings" : {
      "toClass" : "toClass",
      "regions" : [ {
        "y1" : 5,
        "x1" : 1,
        "y2" : 2,
        "x2" : 5
      }, {
        "y1" : 5,
        "x1" : 1,
        "y2" : 2,
        "x2" : 5
      } ],
      "itemIdx" : 6,
      "params" : "{}",
      "fromClass" : "fromClass"
    },
    "passPercentage" : 5.637377,
    "arParams" : "{}"
  },
  "defense" : {
    "defenseParameters" : "defenseParameters",
    "name" : "name",
    "testId" : 5,
    "filters" : [ {
      "paper_link" : "paper_link",
      "codebase_name" : "codebase_name",
      "name" : "name",
      "id" : 1,
      "type" : "type",
      "parameters" : "parameters",
      "enabled" : true,
      "tasks" : [ "tasks", "tasks" ],
      "group" : [ "group", "group" ]
    }, {
      "paper_link" : "paper_link",
      "codebase_name" : "codebase_name",
      "name" : "name",
      "id" : 1,
      "type" : "type",
      "parameters" : "parameters",
      "enabled" : true,
      "tasks" : [ "tasks", "tasks" ],
      "group" : [ "group", "group" ]
    } ],
    "id" : 4
  },
  "profileId" : 6,
  "name" : "name",
  "description" : "description",
  "projectId" : 1,
  "pipelineId" : 0
}' \
 -d '<TestRequest>
  <description>aeiou</description>
  <name>aeiou</name>
  <pipelineId>123456789</pipelineId>
  <profileId>123456789</profileId>
  <projectId>123456789</projectId>
</TestRequest>'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TestApi;

import java.io.File;
import java.util.*;

public class TestApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TestApi apiInstance = new TestApi();
        TestRequest test = ; // TestRequest | 

        try {
            TestResponse result = apiInstance.addTest(test);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestApi#addTest");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TestApi;

public class TestApiExample {
    public static void main(String[] args) {
        TestApi apiInstance = new TestApi();
        TestRequest test = ; // TestRequest | 

        try {
            TestResponse result = apiInstance.addTest(test);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestApi#addTest");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
TestApi *apiInstance = [[TestApi alloc] init];
TestRequest *test = ; // 

// Add a new test.
[apiInstance addTestWith:test
              completionHandler: ^(TestResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.TestApi()
var test = ; // {TestRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addTest(test, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class addTestExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TestApi();
            var test = new TestRequest(); // TestRequest | 

            try {
                // Add a new test.
                TestResponse result = apiInstance.addTest(test);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TestApi.addTest: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TestApi();
$test = ; // TestRequest | 

try {
    $result = $api_instance->addTest($test);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TestApi->addTest: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TestApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TestApi->new();
my $test = WWW::OPenAPIClient::Object::TestRequest->new(); # TestRequest | 

eval {
    my $result = $api_instance->addTest(test => $test);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TestApi->addTest: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TestApi()
test =  # TestRequest | 

try:
    # Add a new test.
    api_response = api_instance.add_test(test)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TestApi->addTest: %s\n" % e)
extern crate TestApi;

pub fn main() {
    let test = ; // TestRequest

    let mut context = TestApi::Context::default();
    let result = client.addTest(test, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
test *

test

Responses


deleteTest

Delete a test.


/api/v1/tests/{id}

Usage and SDK Samples

curl -X DELETE \
-H "Authorization: [[apiKey]]" \
 "http://localhost:8082/api/v1/tests/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TestApi;

import java.io.File;
import java.util.*;

public class TestApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TestApi apiInstance = new TestApi();
        Long id = 789; // Long | id

        try {
            apiInstance.deleteTest(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestApi#deleteTest");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TestApi;

public class TestApiExample {
    public static void main(String[] args) {
        TestApi apiInstance = new TestApi();
        Long id = 789; // Long | id

        try {
            apiInstance.deleteTest(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestApi#deleteTest");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
TestApi *apiInstance = [[TestApi alloc] init];
Long *id = 789; // id (default to null)

// Delete a test.
[apiInstance deleteTestWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.TestApi()
var id = 789; // {Long} id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteTest(id, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class deleteTestExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TestApi();
            var id = 789;  // Long | id (default to null)

            try {
                // Delete a test.
                apiInstance.deleteTest(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling TestApi.deleteTest: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TestApi();
$id = 789; // Long | id

try {
    $api_instance->deleteTest($id);
} catch (Exception $e) {
    echo 'Exception when calling TestApi->deleteTest: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TestApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TestApi->new();
my $id = 789; # Long | id

eval {
    $api_instance->deleteTest(id => $id);
};
if ($@) {
    warn "Exception when calling TestApi->deleteTest: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TestApi()
id = 789 # Long | id (default to null)

try:
    # Delete a test.
    api_instance.delete_test(id)
except ApiException as e:
    print("Exception when calling TestApi->deleteTest: %s\n" % e)
extern crate TestApi;

pub fn main() {
    let id = 789; // Long

    let mut context = TestApi::Context::default();
    let result = client.deleteTest(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
id
Required

Responses


getDefenses

Get defenses.


/api/v1/tests/{testId}/defenses

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/tests/{testId}/defenses"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TestApi;

import java.io.File;
import java.util.*;

public class TestApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TestApi apiInstance = new TestApi();
        Long testId = 789; // Long | testId

        try {
            array[DefenseResponse] result = apiInstance.getDefenses(testId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestApi#getDefenses");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TestApi;

public class TestApiExample {
    public static void main(String[] args) {
        TestApi apiInstance = new TestApi();
        Long testId = 789; // Long | testId

        try {
            array[DefenseResponse] result = apiInstance.getDefenses(testId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestApi#getDefenses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
TestApi *apiInstance = [[TestApi alloc] init];
Long *testId = 789; // testId (default to null)

// Get defenses.
[apiInstance getDefensesWith:testId
              completionHandler: ^(array[DefenseResponse] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.TestApi()
var testId = 789; // {Long} testId

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDefenses(testId, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class getDefensesExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TestApi();
            var testId = 789;  // Long | testId (default to null)

            try {
                // Get defenses.
                array[DefenseResponse] result = apiInstance.getDefenses(testId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TestApi.getDefenses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TestApi();
$testId = 789; // Long | testId

try {
    $result = $api_instance->getDefenses($testId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TestApi->getDefenses: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TestApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TestApi->new();
my $testId = 789; # Long | testId

eval {
    my $result = $api_instance->getDefenses(testId => $testId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TestApi->getDefenses: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TestApi()
testId = 789 # Long | testId (default to null)

try:
    # Get defenses.
    api_response = api_instance.get_defenses(testId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TestApi->getDefenses: %s\n" % e)
extern crate TestApi;

pub fn main() {
    let testId = 789; // Long

    let mut context = TestApi::Context::default();
    let result = client.getDefenses(testId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
testId*
Long (int64)
testId
Required

Responses


getStatus

Get test status.


/api/v1/tests/{testId}/status

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/tests/{testId}/status"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TestApi;

import java.io.File;
import java.util.*;

public class TestApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TestApi apiInstance = new TestApi();
        Long testId = 789; // Long | testId

        try {
            TestResponse result = apiInstance.getStatus(testId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestApi#getStatus");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TestApi;

public class TestApiExample {
    public static void main(String[] args) {
        TestApi apiInstance = new TestApi();
        Long testId = 789; // Long | testId

        try {
            TestResponse result = apiInstance.getStatus(testId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestApi#getStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
TestApi *apiInstance = [[TestApi alloc] init];
Long *testId = 789; // testId (default to null)

// Get test status.
[apiInstance getStatusWith:testId
              completionHandler: ^(TestResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.TestApi()
var testId = 789; // {Long} testId

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getStatus(testId, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class getStatusExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TestApi();
            var testId = 789;  // Long | testId (default to null)

            try {
                // Get test status.
                TestResponse result = apiInstance.getStatus(testId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TestApi.getStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TestApi();
$testId = 789; // Long | testId

try {
    $result = $api_instance->getStatus($testId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TestApi->getStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TestApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TestApi->new();
my $testId = 789; # Long | testId

eval {
    my $result = $api_instance->getStatus(testId => $testId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TestApi->getStatus: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TestApi()
testId = 789 # Long | testId (default to null)

try:
    # Get test status.
    api_response = api_instance.get_status(testId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TestApi->getStatus: %s\n" % e)
extern crate TestApi;

pub fn main() {
    let testId = 789; // Long

    let mut context = TestApi::Context::default();
    let result = client.getStatus(testId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
testId*
Long (int64)
testId
Required

Responses


getTests

Get tests for a project.


/api/v1/tests

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/tests?projectId=789"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TestApi;

import java.io.File;
import java.util.*;

public class TestApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TestApi apiInstance = new TestApi();
        Long projectId = 789; // Long | The project id.

        try {
            array[TestResponse] result = apiInstance.getTests(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestApi#getTests");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TestApi;

public class TestApiExample {
    public static void main(String[] args) {
        TestApi apiInstance = new TestApi();
        Long projectId = 789; // Long | The project id.

        try {
            array[TestResponse] result = apiInstance.getTests(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestApi#getTests");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
TestApi *apiInstance = [[TestApi alloc] init];
Long *projectId = 789; // The project id. (default to null)

// Get tests for a project.
[apiInstance getTestsWith:projectId
              completionHandler: ^(array[TestResponse] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.TestApi()
var projectId = 789; // {Long} The project id.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTests(projectId, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class getTestsExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TestApi();
            var projectId = 789;  // Long | The project id. (default to null)

            try {
                // Get tests for a project.
                array[TestResponse] result = apiInstance.getTests(projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TestApi.getTests: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TestApi();
$projectId = 789; // Long | The project id.

try {
    $result = $api_instance->getTests($projectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TestApi->getTests: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TestApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TestApi->new();
my $projectId = 789; # Long | The project id.

eval {
    my $result = $api_instance->getTests(projectId => $projectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TestApi->getTests: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TestApi()
projectId = 789 # Long | The project id. (default to null)

try:
    # Get tests for a project.
    api_response = api_instance.get_tests(projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TestApi->getTests: %s\n" % e)
extern crate TestApi;

pub fn main() {
    let projectId = 789; // Long

    let mut context = TestApi::Context::default();
    let result = client.getTests(projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
projectId*
Long (int64)
The project id.
Required

Responses


removeDefense

Remove defense.


/api/v1/tests/{testId}/defense/{id}

Usage and SDK Samples

curl -X DELETE \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/tests/{testId}/defense/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TestApi;

import java.io.File;
import java.util.*;

public class TestApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TestApi apiInstance = new TestApi();
        Long id = 789; // Long | The defense id.
        Long testId = 789; // Long | The test id.

        try {
            TestResponse result = apiInstance.removeDefense(id, testId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestApi#removeDefense");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TestApi;

public class TestApiExample {
    public static void main(String[] args) {
        TestApi apiInstance = new TestApi();
        Long id = 789; // Long | The defense id.
        Long testId = 789; // Long | The test id.

        try {
            TestResponse result = apiInstance.removeDefense(id, testId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestApi#removeDefense");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
TestApi *apiInstance = [[TestApi alloc] init];
Long *id = 789; // The defense id. (default to null)
Long *testId = 789; // The test id. (default to null)

// Remove defense.
[apiInstance removeDefenseWith:id
    testId:testId
              completionHandler: ^(TestResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.TestApi()
var id = 789; // {Long} The defense id.
var testId = 789; // {Long} The test id.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.removeDefense(id, testId, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class removeDefenseExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TestApi();
            var id = 789;  // Long | The defense id. (default to null)
            var testId = 789;  // Long | The test id. (default to null)

            try {
                // Remove defense.
                TestResponse result = apiInstance.removeDefense(id, testId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TestApi.removeDefense: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TestApi();
$id = 789; // Long | The defense id.
$testId = 789; // Long | The test id.

try {
    $result = $api_instance->removeDefense($id, $testId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TestApi->removeDefense: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TestApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TestApi->new();
my $id = 789; # Long | The defense id.
my $testId = 789; # Long | The test id.

eval {
    my $result = $api_instance->removeDefense(id => $id, testId => $testId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TestApi->removeDefense: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TestApi()
id = 789 # Long | The defense id. (default to null)
testId = 789 # Long | The test id. (default to null)

try:
    # Remove defense.
    api_response = api_instance.remove_defense(id, testId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TestApi->removeDefense: %s\n" % e)
extern crate TestApi;

pub fn main() {
    let id = 789; // Long
    let testId = 789; // Long

    let mut context = TestApi::Context::default();
    let result = client.removeDefense(id, testId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The defense id.
Required
testId*
Long (int64)
The test id.
Required

Responses


removeFilter

Remove a filter.


/api/v1/tests/{testId}/filter/{id}

Usage and SDK Samples

curl -X DELETE \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/tests/{testId}/filter/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TestApi;

import java.io.File;
import java.util.*;

public class TestApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TestApi apiInstance = new TestApi();
        Long id = 789; // Long | The filter id.
        Long testId = 789; // Long | The test id.

        try {
            TestResponse result = apiInstance.removeFilter(id, testId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestApi#removeFilter");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TestApi;

public class TestApiExample {
    public static void main(String[] args) {
        TestApi apiInstance = new TestApi();
        Long id = 789; // Long | The filter id.
        Long testId = 789; // Long | The test id.

        try {
            TestResponse result = apiInstance.removeFilter(id, testId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestApi#removeFilter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
TestApi *apiInstance = [[TestApi alloc] init];
Long *id = 789; // The filter id. (default to null)
Long *testId = 789; // The test id. (default to null)

// Remove a filter.
[apiInstance removeFilterWith:id
    testId:testId
              completionHandler: ^(TestResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.TestApi()
var id = 789; // {Long} The filter id.
var testId = 789; // {Long} The test id.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.removeFilter(id, testId, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class removeFilterExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TestApi();
            var id = 789;  // Long | The filter id. (default to null)
            var testId = 789;  // Long | The test id. (default to null)

            try {
                // Remove a filter.
                TestResponse result = apiInstance.removeFilter(id, testId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TestApi.removeFilter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TestApi();
$id = 789; // Long | The filter id.
$testId = 789; // Long | The test id.

try {
    $result = $api_instance->removeFilter($id, $testId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TestApi->removeFilter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TestApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TestApi->new();
my $id = 789; # Long | The filter id.
my $testId = 789; # Long | The test id.

eval {
    my $result = $api_instance->removeFilter(id => $id, testId => $testId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TestApi->removeFilter: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TestApi()
id = 789 # Long | The filter id. (default to null)
testId = 789 # Long | The test id. (default to null)

try:
    # Remove a filter.
    api_response = api_instance.remove_filter(id, testId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TestApi->removeFilter: %s\n" % e)
extern crate TestApi;

pub fn main() {
    let id = 789; // Long
    let testId = 789; // Long

    let mut context = TestApi::Context::default();
    let result = client.removeFilter(id, testId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The filter id.
Required
testId*
Long (int64)
The test id.
Required

Responses


startTest

Start a test.


/api/v1/tests/{testId}/start

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 "http://localhost:8082/api/v1/tests/{testId}/start"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TestApi;

import java.io.File;
import java.util.*;

public class TestApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TestApi apiInstance = new TestApi();
        Long testId = 789; // Long | The test id.

        try {
            apiInstance.startTest(testId);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestApi#startTest");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TestApi;

public class TestApiExample {
    public static void main(String[] args) {
        TestApi apiInstance = new TestApi();
        Long testId = 789; // Long | The test id.

        try {
            apiInstance.startTest(testId);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestApi#startTest");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
TestApi *apiInstance = [[TestApi alloc] init];
Long *testId = 789; // The test id. (default to null)

// Start a test.
[apiInstance startTestWith:testId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.TestApi()
var testId = 789; // {Long} The test id.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.startTest(testId, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class startTestExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TestApi();
            var testId = 789;  // Long | The test id. (default to null)

            try {
                // Start a test.
                apiInstance.startTest(testId);
            } catch (Exception e) {
                Debug.Print("Exception when calling TestApi.startTest: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TestApi();
$testId = 789; // Long | The test id.

try {
    $api_instance->startTest($testId);
} catch (Exception $e) {
    echo 'Exception when calling TestApi->startTest: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TestApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TestApi->new();
my $testId = 789; # Long | The test id.

eval {
    $api_instance->startTest(testId => $testId);
};
if ($@) {
    warn "Exception when calling TestApi->startTest: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TestApi()
testId = 789 # Long | The test id. (default to null)

try:
    # Start a test.
    api_instance.start_test(testId)
except ApiException as e:
    print("Exception when calling TestApi->startTest: %s\n" % e)
extern crate TestApi;

pub fn main() {
    let testId = 789; // Long

    let mut context = TestApi::Context::default();
    let result = client.startTest(testId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
testId*
Long (int64)
The test id.
Required

Responses


stopTest

Stop all the running jobs in a test.


/api/v1/tests/{id}/stop

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 "http://localhost:8082/api/v1/tests/{id}/stop"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TestApi;

import java.io.File;
import java.util.*;

public class TestApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TestApi apiInstance = new TestApi();
        Long id = 789; // Long | id

        try {
            apiInstance.stopTest(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestApi#stopTest");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TestApi;

public class TestApiExample {
    public static void main(String[] args) {
        TestApi apiInstance = new TestApi();
        Long id = 789; // Long | id

        try {
            apiInstance.stopTest(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestApi#stopTest");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
TestApi *apiInstance = [[TestApi alloc] init];
Long *id = 789; // id (default to null)

// Stop all the running jobs in a test.
[apiInstance stopTestWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.TestApi()
var id = 789; // {Long} id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.stopTest(id, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class stopTestExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TestApi();
            var id = 789;  // Long | id (default to null)

            try {
                // Stop all the running jobs in a test.
                apiInstance.stopTest(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling TestApi.stopTest: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TestApi();
$id = 789; // Long | id

try {
    $api_instance->stopTest($id);
} catch (Exception $e) {
    echo 'Exception when calling TestApi->stopTest: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TestApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TestApi->new();
my $id = 789; # Long | id

eval {
    $api_instance->stopTest(id => $id);
};
if ($@) {
    warn "Exception when calling TestApi->stopTest: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TestApi()
id = 789 # Long | id (default to null)

try:
    # Stop all the running jobs in a test.
    api_instance.stop_test(id)
except ApiException as e:
    print("Exception when calling TestApi->stopTest: %s\n" % e)
extern crate TestApi;

pub fn main() {
    let id = 789; // Long

    let mut context = TestApi::Context::default();
    let result = client.stopTest(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
id
Required

Responses


updateStatus

Update test status - can only be called by worker instance.


/api/v1/tests/{testId}/status

Usage and SDK Samples

curl -X PUT \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: application/json,application/xml" \
 "http://localhost:8082/api/v1/tests/{testId}/status?runId=789&taskId=789" \
 -d '{
  "elapsed" : 0,
  "workerId" : "workerId",
  "eta" : 6,
  "max" : 1,
  "progress" : 5,
  "message" : "message",
  "status" : "CANCELLED"
}' \
 -d '<StatusRequest>
  <elapsed>123</elapsed>
  <eta>123</eta>
  <max>123</max>
  <message>aeiou</message>
  <progress>123</progress>
  <status>aeiou</status>
  <workerId>aeiou</workerId>
</StatusRequest>'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TestApi;

import java.io.File;
import java.util.*;

public class TestApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TestApi apiInstance = new TestApi();
        Long runId = 789; // Long | runId
        Long taskId = 789; // Long | taskId
        Long testId = 789; // Long | testId
        StatusRequest status = ; // StatusRequest | 

        try {
            'Boolean' result = apiInstance.updateStatus(runId, taskId, testId, status);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestApi#updateStatus");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TestApi;

public class TestApiExample {
    public static void main(String[] args) {
        TestApi apiInstance = new TestApi();
        Long runId = 789; // Long | runId
        Long taskId = 789; // Long | taskId
        Long testId = 789; // Long | testId
        StatusRequest status = ; // StatusRequest | 

        try {
            'Boolean' result = apiInstance.updateStatus(runId, taskId, testId, status);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestApi#updateStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
TestApi *apiInstance = [[TestApi alloc] init];
Long *runId = 789; // runId (default to null)
Long *taskId = 789; // taskId (default to null)
Long *testId = 789; // testId (default to null)
StatusRequest *status = ; // 

// Update test status - can only be called by worker instance.
[apiInstance updateStatusWith:runId
    taskId:taskId
    testId:testId
    status:status
              completionHandler: ^('Boolean' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.TestApi()
var runId = 789; // {Long} runId
var taskId = 789; // {Long} taskId
var testId = 789; // {Long} testId
var status = ; // {StatusRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateStatus(runId, taskId, testId, status, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class updateStatusExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TestApi();
            var runId = 789;  // Long | runId (default to null)
            var taskId = 789;  // Long | taskId (default to null)
            var testId = 789;  // Long | testId (default to null)
            var status = new StatusRequest(); // StatusRequest | 

            try {
                // Update test status - can only be called by worker instance.
                'Boolean' result = apiInstance.updateStatus(runId, taskId, testId, status);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TestApi.updateStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TestApi();
$runId = 789; // Long | runId
$taskId = 789; // Long | taskId
$testId = 789; // Long | testId
$status = ; // StatusRequest | 

try {
    $result = $api_instance->updateStatus($runId, $taskId, $testId, $status);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TestApi->updateStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TestApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TestApi->new();
my $runId = 789; # Long | runId
my $taskId = 789; # Long | taskId
my $testId = 789; # Long | testId
my $status = WWW::OPenAPIClient::Object::StatusRequest->new(); # StatusRequest | 

eval {
    my $result = $api_instance->updateStatus(runId => $runId, taskId => $taskId, testId => $testId, status => $status);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TestApi->updateStatus: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TestApi()
runId = 789 # Long | runId (default to null)
taskId = 789 # Long | taskId (default to null)
testId = 789 # Long | testId (default to null)
status =  # StatusRequest | 

try:
    # Update test status - can only be called by worker instance.
    api_response = api_instance.update_status(runId, taskId, testId, status)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TestApi->updateStatus: %s\n" % e)
extern crate TestApi;

pub fn main() {
    let runId = 789; // Long
    let taskId = 789; // Long
    let testId = 789; // Long
    let status = ; // StatusRequest

    let mut context = TestApi::Context::default();
    let result = client.updateStatus(runId, taskId, testId, status, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
testId*
Long (int64)
testId
Required
Body parameters
Name Description
status *

status

Query parameters
Name Description
runId*
Long (int64)
runId
Required
taskId*
Long (int64)
taskId
Required

Responses


updateTest

Update test.


/api/v1/tests/{id}

Usage and SDK Samples

curl -X PUT \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: application/json,application/xml" \
 "http://localhost:8082/api/v1/tests/{id}" \
 -d '{
  "testSettings" : {
    "configured" : true,
    "storeIntermediateData" : true,
    "detectionTestSettings" : {
      "id" : 7,
      "params" : "{}",
      "poisonedDatasetSetting" : {
        "selectionType" : "COUNT",
        "endIdx" : 7,
        "indexes" : [ 1, 1 ],
        "startIdx" : 6,
        "batchSize" : 4,
        "shuffle" : true,
        "workers" : 7,
        "fraction" : 1.2315135,
        "numItems" : 1
      },
      "passDeviations" : 9.301444
    },
    "testType" : "Crafted",
    "hpoId" : 5,
    "epsExplorationParams" : "{}",
    "epsExploration" : true,
    "passFailCriteria" : [ {
      "metricName" : "metricName",
      "above" : true,
      "passVal" : 2.027123,
      "enabled" : true
    }, {
      "metricName" : "metricName",
      "above" : true,
      "passVal" : 2.027123,
      "enabled" : true
    } ],
    "datasetSetting" : {
      "selectionType" : "COUNT",
      "endIdx" : 7,
      "indexes" : [ 1, 1 ],
      "startIdx" : 6,
      "batchSize" : 4,
      "shuffle" : true,
      "workers" : 7,
      "fraction" : 1.2315135,
      "numItems" : 1
    },
    "approximateRobustness" : true,
    "storeCompositeImages" : true,
    "overlayImageOnSegMap" : true,
    "batchWiseHPO" : true,
    "hpoParams" : "{}",
    "metrics" : {
      "key" : [ {
        "uid" : "uid",
        "name" : "name",
        "params" : "{}",
        "enabled" : true
      }, {
        "uid" : "uid",
        "name" : "name",
        "params" : "{}",
        "enabled" : true
      } ]
    },
    "optimalParameterization" : true,
    "craftedSettings" : {
      "toClass" : "toClass",
      "regions" : [ {
        "y1" : 5,
        "x1" : 1,
        "y2" : 2,
        "x2" : 5
      }, {
        "y1" : 5,
        "x1" : 1,
        "y2" : 2,
        "x2" : 5
      } ],
      "itemIdx" : 6,
      "params" : "{}",
      "fromClass" : "fromClass"
    },
    "passPercentage" : 5.637377,
    "arParams" : "{}"
  },
  "defense" : {
    "defenseParameters" : "defenseParameters",
    "name" : "name",
    "testId" : 5,
    "filters" : [ {
      "paper_link" : "paper_link",
      "codebase_name" : "codebase_name",
      "name" : "name",
      "id" : 1,
      "type" : "type",
      "parameters" : "parameters",
      "enabled" : true,
      "tasks" : [ "tasks", "tasks" ],
      "group" : [ "group", "group" ]
    }, {
      "paper_link" : "paper_link",
      "codebase_name" : "codebase_name",
      "name" : "name",
      "id" : 1,
      "type" : "type",
      "parameters" : "parameters",
      "enabled" : true,
      "tasks" : [ "tasks", "tasks" ],
      "group" : [ "group", "group" ]
    } ],
    "id" : 4
  },
  "profileId" : 6,
  "name" : "name",
  "description" : "description",
  "projectId" : 1,
  "pipelineId" : 0
}' \
 -d '<TestRequest>
  <description>aeiou</description>
  <name>aeiou</name>
  <pipelineId>123456789</pipelineId>
  <profileId>123456789</profileId>
  <projectId>123456789</projectId>
</TestRequest>'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TestApi;

import java.io.File;
import java.util.*;

public class TestApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TestApi apiInstance = new TestApi();
        Long id = 789; // Long | The test ID.
        TestRequest testRequest = ; // TestRequest | 

        try {
            TestResponse result = apiInstance.updateTest(id, testRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestApi#updateTest");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TestApi;

public class TestApiExample {
    public static void main(String[] args) {
        TestApi apiInstance = new TestApi();
        Long id = 789; // Long | The test ID.
        TestRequest testRequest = ; // TestRequest | 

        try {
            TestResponse result = apiInstance.updateTest(id, testRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestApi#updateTest");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
TestApi *apiInstance = [[TestApi alloc] init];
Long *id = 789; // The test ID. (default to null)
TestRequest *testRequest = ; // 

// Update test.
[apiInstance updateTestWith:id
    testRequest:testRequest
              completionHandler: ^(TestResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.TestApi()
var id = 789; // {Long} The test ID.
var testRequest = ; // {TestRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateTest(id, testRequest, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class updateTestExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TestApi();
            var id = 789;  // Long | The test ID. (default to null)
            var testRequest = new TestRequest(); // TestRequest | 

            try {
                // Update test.
                TestResponse result = apiInstance.updateTest(id, testRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TestApi.updateTest: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TestApi();
$id = 789; // Long | The test ID.
$testRequest = ; // TestRequest | 

try {
    $result = $api_instance->updateTest($id, $testRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TestApi->updateTest: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TestApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TestApi->new();
my $id = 789; # Long | The test ID.
my $testRequest = WWW::OPenAPIClient::Object::TestRequest->new(); # TestRequest | 

eval {
    my $result = $api_instance->updateTest(id => $id, testRequest => $testRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TestApi->updateTest: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TestApi()
id = 789 # Long | The test ID. (default to null)
testRequest =  # TestRequest | 

try:
    # Update test.
    api_response = api_instance.update_test(id, testRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TestApi->updateTest: %s\n" % e)
extern crate TestApi;

pub fn main() {
    let id = 789; // Long
    let testRequest = ; // TestRequest

    let mut context = TestApi::Context::default();
    let result = client.updateTest(id, testRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The test ID.
Required
Body parameters
Name Description
testRequest *

testRequest

Responses


updateTestRun

Update test run.


/api/v1/tests/testrun/{id}

Usage and SDK Samples

curl -X PUT \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: application/json,application/xml" \
 "http://localhost:8082/api/v1/tests/testrun/{id}" \
 -d '{
  "name" : "name"
}' \
 -d '<TestRunRequest>
  <name>aeiou</name>
</TestRunRequest>'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TestApi;

import java.io.File;
import java.util.*;

public class TestApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TestApi apiInstance = new TestApi();
        Long id = 789; // Long | The test run ID.
        TestRunRequest request = ; // TestRunRequest | 

        try {
            TestRunResponse result = apiInstance.updateTestRun(id, request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestApi#updateTestRun");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TestApi;

public class TestApiExample {
    public static void main(String[] args) {
        TestApi apiInstance = new TestApi();
        Long id = 789; // Long | The test run ID.
        TestRunRequest request = ; // TestRunRequest | 

        try {
            TestRunResponse result = apiInstance.updateTestRun(id, request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestApi#updateTestRun");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
TestApi *apiInstance = [[TestApi alloc] init];
Long *id = 789; // The test run ID. (default to null)
TestRunRequest *request = ; // 

// Update test run.
[apiInstance updateTestRunWith:id
    request:request
              completionHandler: ^(TestRunResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.TestApi()
var id = 789; // {Long} The test run ID.
var request = ; // {TestRunRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateTestRun(id, request, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class updateTestRunExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TestApi();
            var id = 789;  // Long | The test run ID. (default to null)
            var request = new TestRunRequest(); // TestRunRequest | 

            try {
                // Update test run.
                TestRunResponse result = apiInstance.updateTestRun(id, request);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TestApi.updateTestRun: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TestApi();
$id = 789; // Long | The test run ID.
$request = ; // TestRunRequest | 

try {
    $result = $api_instance->updateTestRun($id, $request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TestApi->updateTestRun: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TestApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TestApi->new();
my $id = 789; # Long | The test run ID.
my $request = WWW::OPenAPIClient::Object::TestRunRequest->new(); # TestRunRequest | 

eval {
    my $result = $api_instance->updateTestRun(id => $id, request => $request);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TestApi->updateTestRun: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TestApi()
id = 789 # Long | The test run ID. (default to null)
request =  # TestRunRequest | 

try:
    # Update test run.
    api_response = api_instance.update_test_run(id, request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TestApi->updateTestRun: %s\n" % e)
extern crate TestApi;

pub fn main() {
    let id = 789; // Long
    let request = ; // TestRunRequest

    let mut context = TestApi::Context::default();
    let result = client.updateTestRun(id, request, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The test run ID.
Required
Body parameters
Name Description
request *

request

Responses


TestProfiles

addProfile

Add a profile to an organization using the provided test id as a template.


/api/v1/profiles/{testId}

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/profiles/{testId}?id=789&name=name_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TestProfilesApi;

import java.io.File;
import java.util.*;

public class TestProfilesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TestProfilesApi apiInstance = new TestProfilesApi();
        Long id = 789; // Long | The organization ID.
        String name = name_example; // String | The profile name.
        Long testId = 789; // Long | The test ID from which the settings will be copied.

        try {
            TestProfileResponse result = apiInstance.addProfile(id, name, testId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestProfilesApi#addProfile");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TestProfilesApi;

public class TestProfilesApiExample {
    public static void main(String[] args) {
        TestProfilesApi apiInstance = new TestProfilesApi();
        Long id = 789; // Long | The organization ID.
        String name = name_example; // String | The profile name.
        Long testId = 789; // Long | The test ID from which the settings will be copied.

        try {
            TestProfileResponse result = apiInstance.addProfile(id, name, testId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestProfilesApi#addProfile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
TestProfilesApi *apiInstance = [[TestProfilesApi alloc] init];
Long *id = 789; // The organization ID. (default to null)
String *name = name_example; // The profile name. (default to null)
Long *testId = 789; // The test ID from which the settings will be copied. (default to null)

// Add a profile to an organization using the provided test id as a template.
[apiInstance addProfileWith:id
    name:name
    testId:testId
              completionHandler: ^(TestProfileResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.TestProfilesApi()
var id = 789; // {Long} The organization ID.
var name = name_example; // {String} The profile name.
var testId = 789; // {Long} The test ID from which the settings will be copied.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addProfile(id, name, testId, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class addProfileExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TestProfilesApi();
            var id = 789;  // Long | The organization ID. (default to null)
            var name = name_example;  // String | The profile name. (default to null)
            var testId = 789;  // Long | The test ID from which the settings will be copied. (default to null)

            try {
                // Add a profile to an organization using the provided test id as a template.
                TestProfileResponse result = apiInstance.addProfile(id, name, testId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TestProfilesApi.addProfile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TestProfilesApi();
$id = 789; // Long | The organization ID.
$name = name_example; // String | The profile name.
$testId = 789; // Long | The test ID from which the settings will be copied.

try {
    $result = $api_instance->addProfile($id, $name, $testId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TestProfilesApi->addProfile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TestProfilesApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TestProfilesApi->new();
my $id = 789; # Long | The organization ID.
my $name = name_example; # String | The profile name.
my $testId = 789; # Long | The test ID from which the settings will be copied.

eval {
    my $result = $api_instance->addProfile(id => $id, name => $name, testId => $testId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TestProfilesApi->addProfile: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TestProfilesApi()
id = 789 # Long | The organization ID. (default to null)
name = name_example # String | The profile name. (default to null)
testId = 789 # Long | The test ID from which the settings will be copied. (default to null)

try:
    # Add a profile to an organization using the provided test id as a template.
    api_response = api_instance.add_profile(id, name, testId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TestProfilesApi->addProfile: %s\n" % e)
extern crate TestProfilesApi;

pub fn main() {
    let id = 789; // Long
    let name = name_example; // String
    let testId = 789; // Long

    let mut context = TestProfilesApi::Context::default();
    let result = client.addProfile(id, name, testId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
testId*
Long (int64)
The test ID from which the settings will be copied.
Required
Query parameters
Name Description
id*
Long (int64)
The organization ID.
Required
name*
String
The profile name.
Required

Responses


addTestProfileDefense

Add a defense to the profile


/api/v1/profiles/{id}/adddefense

Usage and SDK Samples

curl -X PUT \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: application/json,application/xml" \
 "http://localhost:8082/api/v1/profiles/{id}/adddefense" \
 -d '{
  "name" : "name",
  "parameters" : "parameters"
}' \
 -d '<DefenseRequest>
  <name>aeiou</name>
  <parameters>aeiou</parameters>
</DefenseRequest>'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TestProfilesApi;

import java.io.File;
import java.util.*;

public class TestProfilesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TestProfilesApi apiInstance = new TestProfilesApi();
        Long id = 789; // Long | The profile ID.
        DefenseRequest defense = ; // DefenseRequest | 

        try {
            TestProfileResponse result = apiInstance.addTestProfileDefense(id, defense);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestProfilesApi#addTestProfileDefense");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TestProfilesApi;

public class TestProfilesApiExample {
    public static void main(String[] args) {
        TestProfilesApi apiInstance = new TestProfilesApi();
        Long id = 789; // Long | The profile ID.
        DefenseRequest defense = ; // DefenseRequest | 

        try {
            TestProfileResponse result = apiInstance.addTestProfileDefense(id, defense);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestProfilesApi#addTestProfileDefense");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
TestProfilesApi *apiInstance = [[TestProfilesApi alloc] init];
Long *id = 789; // The profile ID. (default to null)
DefenseRequest *defense = ; // 

// Add a defense to the profile
[apiInstance addTestProfileDefenseWith:id
    defense:defense
              completionHandler: ^(TestProfileResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.TestProfilesApi()
var id = 789; // {Long} The profile ID.
var defense = ; // {DefenseRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addTestProfileDefense(id, defense, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class addTestProfileDefenseExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TestProfilesApi();
            var id = 789;  // Long | The profile ID. (default to null)
            var defense = new DefenseRequest(); // DefenseRequest | 

            try {
                // Add a defense to the profile
                TestProfileResponse result = apiInstance.addTestProfileDefense(id, defense);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TestProfilesApi.addTestProfileDefense: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TestProfilesApi();
$id = 789; // Long | The profile ID.
$defense = ; // DefenseRequest | 

try {
    $result = $api_instance->addTestProfileDefense($id, $defense);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TestProfilesApi->addTestProfileDefense: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TestProfilesApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TestProfilesApi->new();
my $id = 789; # Long | The profile ID.
my $defense = WWW::OPenAPIClient::Object::DefenseRequest->new(); # DefenseRequest | 

eval {
    my $result = $api_instance->addTestProfileDefense(id => $id, defense => $defense);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TestProfilesApi->addTestProfileDefense: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TestProfilesApi()
id = 789 # Long | The profile ID. (default to null)
defense =  # DefenseRequest | 

try:
    # Add a defense to the profile
    api_response = api_instance.add_test_profile_defense(id, defense)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TestProfilesApi->addTestProfileDefense: %s\n" % e)
extern crate TestProfilesApi;

pub fn main() {
    let id = 789; // Long
    let defense = ; // DefenseRequest

    let mut context = TestProfilesApi::Context::default();
    let result = client.addTestProfileDefense(id, defense, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The profile ID.
Required
Body parameters
Name Description
defense *

The defense object

Responses


addTestProfileFilter

Add a filter to the profile


/api/v1/profiles/{id}/addfilter

Usage and SDK Samples

curl -X PUT \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: application/json,application/xml" \
 "http://localhost:8082/api/v1/profiles/{id}/addfilter" \
 -d '{
  "name" : "name",
  "type" : "adversarial_attacks",
  "parameters" : "parameters",
  "enabled" : true
}' \
 -d '<FilterRequest>
  <enabled>true</enabled>
  <name>aeiou</name>
  <parameters>aeiou</parameters>
  <type>aeiou</type>
</FilterRequest>'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TestProfilesApi;

import java.io.File;
import java.util.*;

public class TestProfilesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TestProfilesApi apiInstance = new TestProfilesApi();
        Long id = 789; // Long | The profile ID.
        FilterRequest filter = ; // FilterRequest | 

        try {
            TestProfileResponse result = apiInstance.addTestProfileFilter(id, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestProfilesApi#addTestProfileFilter");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TestProfilesApi;

public class TestProfilesApiExample {
    public static void main(String[] args) {
        TestProfilesApi apiInstance = new TestProfilesApi();
        Long id = 789; // Long | The profile ID.
        FilterRequest filter = ; // FilterRequest | 

        try {
            TestProfileResponse result = apiInstance.addTestProfileFilter(id, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestProfilesApi#addTestProfileFilter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
TestProfilesApi *apiInstance = [[TestProfilesApi alloc] init];
Long *id = 789; // The profile ID. (default to null)
FilterRequest *filter = ; // 

// Add a filter to the profile
[apiInstance addTestProfileFilterWith:id
    filter:filter
              completionHandler: ^(TestProfileResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.TestProfilesApi()
var id = 789; // {Long} The profile ID.
var filter = ; // {FilterRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addTestProfileFilter(id, filter, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class addTestProfileFilterExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TestProfilesApi();
            var id = 789;  // Long | The profile ID. (default to null)
            var filter = new FilterRequest(); // FilterRequest | 

            try {
                // Add a filter to the profile
                TestProfileResponse result = apiInstance.addTestProfileFilter(id, filter);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TestProfilesApi.addTestProfileFilter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TestProfilesApi();
$id = 789; // Long | The profile ID.
$filter = ; // FilterRequest | 

try {
    $result = $api_instance->addTestProfileFilter($id, $filter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TestProfilesApi->addTestProfileFilter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TestProfilesApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TestProfilesApi->new();
my $id = 789; # Long | The profile ID.
my $filter = WWW::OPenAPIClient::Object::FilterRequest->new(); # FilterRequest | 

eval {
    my $result = $api_instance->addTestProfileFilter(id => $id, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TestProfilesApi->addTestProfileFilter: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TestProfilesApi()
id = 789 # Long | The profile ID. (default to null)
filter =  # FilterRequest | 

try:
    # Add a filter to the profile
    api_response = api_instance.add_test_profile_filter(id, filter)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TestProfilesApi->addTestProfileFilter: %s\n" % e)
extern crate TestProfilesApi;

pub fn main() {
    let id = 789; // Long
    let filter = ; // FilterRequest

    let mut context = TestProfilesApi::Context::default();
    let result = client.addTestProfileFilter(id, filter, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The profile ID.
Required
Body parameters
Name Description
filter *

The filter to add.

Responses


copyProfile

Make a copy of a profile. To copy to a different organization, extra permissions are required.


/api/v1/profiles/{id}/copy

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/profiles/{id}/copy?orgId=789"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TestProfilesApi;

import java.io.File;
import java.util.*;

public class TestProfilesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TestProfilesApi apiInstance = new TestProfilesApi();
        Long id = 789; // Long | The profile ID.
        Long orgId = 789; // Long | Optional destination organization ID to copy to.

        try {
            TestProfileResponse result = apiInstance.copyProfile(id, orgId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestProfilesApi#copyProfile");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TestProfilesApi;

public class TestProfilesApiExample {
    public static void main(String[] args) {
        TestProfilesApi apiInstance = new TestProfilesApi();
        Long id = 789; // Long | The profile ID.
        Long orgId = 789; // Long | Optional destination organization ID to copy to.

        try {
            TestProfileResponse result = apiInstance.copyProfile(id, orgId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestProfilesApi#copyProfile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
TestProfilesApi *apiInstance = [[TestProfilesApi alloc] init];
Long *id = 789; // The profile ID. (default to null)
Long *orgId = 789; // Optional destination organization ID to copy to. (optional) (default to null)

// Make a copy of a profile. To copy to a different organization, extra permissions are required.
[apiInstance copyProfileWith:id
    orgId:orgId
              completionHandler: ^(TestProfileResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.TestProfilesApi()
var id = 789; // {Long} The profile ID.
var opts = {
  'orgId': 789 // {Long} Optional destination organization ID to copy to.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.copyProfile(id, opts, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class copyProfileExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TestProfilesApi();
            var id = 789;  // Long | The profile ID. (default to null)
            var orgId = 789;  // Long | Optional destination organization ID to copy to. (optional)  (default to null)

            try {
                // Make a copy of a profile. To copy to a different organization, extra permissions are required.
                TestProfileResponse result = apiInstance.copyProfile(id, orgId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TestProfilesApi.copyProfile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TestProfilesApi();
$id = 789; // Long | The profile ID.
$orgId = 789; // Long | Optional destination organization ID to copy to.

try {
    $result = $api_instance->copyProfile($id, $orgId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TestProfilesApi->copyProfile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TestProfilesApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TestProfilesApi->new();
my $id = 789; # Long | The profile ID.
my $orgId = 789; # Long | Optional destination organization ID to copy to.

eval {
    my $result = $api_instance->copyProfile(id => $id, orgId => $orgId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TestProfilesApi->copyProfile: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TestProfilesApi()
id = 789 # Long | The profile ID. (default to null)
orgId = 789 # Long | Optional destination organization ID to copy to. (optional) (default to null)

try:
    # Make a copy of a profile. To copy to a different organization, extra permissions are required.
    api_response = api_instance.copy_profile(id, orgId=orgId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TestProfilesApi->copyProfile: %s\n" % e)
extern crate TestProfilesApi;

pub fn main() {
    let id = 789; // Long
    let orgId = 789; // Long

    let mut context = TestProfilesApi::Context::default();
    let result = client.copyProfile(id, orgId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The profile ID.
Required
Query parameters
Name Description
orgId
Long (int64)
Optional destination organization ID to copy to.

Responses


createTestProfile

Create a new test profile


/api/v1/profiles

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: application/json,application/xml" \
 "http://localhost:8082/api/v1/profiles?orgId=789" \
 -d '{
  "settings" : {
    "configured" : true,
    "storeIntermediateData" : true,
    "detectionTestSettings" : {
      "id" : 7,
      "params" : "{}",
      "poisonedDatasetSetting" : {
        "selectionType" : "COUNT",
        "endIdx" : 7,
        "indexes" : [ 1, 1 ],
        "startIdx" : 6,
        "batchSize" : 4,
        "shuffle" : true,
        "workers" : 7,
        "fraction" : 1.2315135,
        "numItems" : 1
      },
      "passDeviations" : 9.301444
    },
    "testType" : "Crafted",
    "hpoId" : 3,
    "defenses" : [ {
      "defenseParameters" : "defenseParameters",
      "name" : "name",
      "testId" : 5,
      "filters" : [ {
        "paper_link" : "paper_link",
        "codebase_name" : "codebase_name",
        "name" : "name",
        "id" : 1,
        "type" : "type",
        "parameters" : "parameters",
        "enabled" : true,
        "tasks" : [ "tasks", "tasks" ],
        "group" : [ "group", "group" ]
      }, {
        "paper_link" : "paper_link",
        "codebase_name" : "codebase_name",
        "name" : "name",
        "id" : 1,
        "type" : "type",
        "parameters" : "parameters",
        "enabled" : true,
        "tasks" : [ "tasks", "tasks" ],
        "group" : [ "group", "group" ]
      } ],
      "id" : 4
    }, {
      "defenseParameters" : "defenseParameters",
      "name" : "name",
      "testId" : 5,
      "filters" : [ {
        "paper_link" : "paper_link",
        "codebase_name" : "codebase_name",
        "name" : "name",
        "id" : 1,
        "type" : "type",
        "parameters" : "parameters",
        "enabled" : true,
        "tasks" : [ "tasks", "tasks" ],
        "group" : [ "group", "group" ]
      }, {
        "paper_link" : "paper_link",
        "codebase_name" : "codebase_name",
        "name" : "name",
        "id" : 1,
        "type" : "type",
        "parameters" : "parameters",
        "enabled" : true,
        "tasks" : [ "tasks", "tasks" ],
        "group" : [ "group", "group" ]
      } ],
      "id" : 4
    } ],
    "epsExplorationParams" : "{}",
    "epsExploration" : true,
    "passFailCriteria" : [ {
      "metricName" : "metricName",
      "above" : true,
      "passVal" : 2.027123,
      "enabled" : true
    }, {
      "metricName" : "metricName",
      "above" : true,
      "passVal" : 2.027123,
      "enabled" : true
    } ],
    "datasetSetting" : {
      "selectionType" : "COUNT",
      "endIdx" : 7,
      "indexes" : [ 1, 1 ],
      "startIdx" : 6,
      "batchSize" : 4,
      "shuffle" : true,
      "workers" : 7,
      "fraction" : 1.2315135,
      "numItems" : 1
    },
    "approximateRobustness" : true,
    "storeCompositeImages" : true,
    "overlayImageOnSegMap" : true,
    "batchWiseHPO" : true,
    "hpoParams" : "{}",
    "metrics" : {
      "key" : [ {
        "uid" : "uid",
        "name" : "name",
        "params" : "{}",
        "enabled" : true
      }, {
        "uid" : "uid",
        "name" : "name",
        "params" : "{}",
        "enabled" : true
      } ]
    },
    "optimalParameterization" : true,
    "craftedSettings" : {
      "toClass" : "toClass",
      "regions" : [ {
        "y1" : 5,
        "x1" : 1,
        "y2" : 2,
        "x2" : 5
      }, {
        "y1" : 5,
        "x1" : 1,
        "y2" : 2,
        "x2" : 5
      } ],
      "itemIdx" : 6,
      "params" : "{}",
      "fromClass" : "fromClass"
    },
    "passPercentage" : 4.145608,
    "tasks" : [ "tasks", "tasks" ],
    "arParams" : "{}"
  },
  "name" : "name",
  "description" : "description",
  "id" : 0
}' \
 -d '<TestProfileRequest>
  <description>aeiou</description>
  <id>123456789</id>
  <name>aeiou</name>
</TestProfileRequest>'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TestProfilesApi;

import java.io.File;
import java.util.*;

public class TestProfilesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TestProfilesApi apiInstance = new TestProfilesApi();
        Long orgId = 789; // Long | The organization ID.
        TestProfileRequest profile = ; // TestProfileRequest | 

        try {
            TestProfileResponse result = apiInstance.createTestProfile(orgId, profile);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestProfilesApi#createTestProfile");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TestProfilesApi;

public class TestProfilesApiExample {
    public static void main(String[] args) {
        TestProfilesApi apiInstance = new TestProfilesApi();
        Long orgId = 789; // Long | The organization ID.
        TestProfileRequest profile = ; // TestProfileRequest | 

        try {
            TestProfileResponse result = apiInstance.createTestProfile(orgId, profile);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestProfilesApi#createTestProfile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
TestProfilesApi *apiInstance = [[TestProfilesApi alloc] init];
Long *orgId = 789; // The organization ID. (default to null)
TestProfileRequest *profile = ; // 

// Create a new test profile
[apiInstance createTestProfileWith:orgId
    profile:profile
              completionHandler: ^(TestProfileResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.TestProfilesApi()
var orgId = 789; // {Long} The organization ID.
var profile = ; // {TestProfileRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createTestProfile(orgId, profile, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class createTestProfileExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TestProfilesApi();
            var orgId = 789;  // Long | The organization ID. (default to null)
            var profile = new TestProfileRequest(); // TestProfileRequest | 

            try {
                // Create a new test profile
                TestProfileResponse result = apiInstance.createTestProfile(orgId, profile);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TestProfilesApi.createTestProfile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TestProfilesApi();
$orgId = 789; // Long | The organization ID.
$profile = ; // TestProfileRequest | 

try {
    $result = $api_instance->createTestProfile($orgId, $profile);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TestProfilesApi->createTestProfile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TestProfilesApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TestProfilesApi->new();
my $orgId = 789; # Long | The organization ID.
my $profile = WWW::OPenAPIClient::Object::TestProfileRequest->new(); # TestProfileRequest | 

eval {
    my $result = $api_instance->createTestProfile(orgId => $orgId, profile => $profile);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TestProfilesApi->createTestProfile: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TestProfilesApi()
orgId = 789 # Long | The organization ID. (default to null)
profile =  # TestProfileRequest | 

try:
    # Create a new test profile
    api_response = api_instance.create_test_profile(orgId, profile)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TestProfilesApi->createTestProfile: %s\n" % e)
extern crate TestProfilesApi;

pub fn main() {
    let orgId = 789; // Long
    let profile = ; // TestProfileRequest

    let mut context = TestProfilesApi::Context::default();
    let result = client.createTestProfile(orgId, profile, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
profile *

The profile object.

Query parameters
Name Description
orgId*
Long (int64)
The organization ID.
Required

Responses


deleteProfile

Delete a profile by ID.


/api/v1/profiles/{id}

Usage and SDK Samples

curl -X DELETE \
-H "Authorization: [[apiKey]]" \
 "http://localhost:8082/api/v1/profiles/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TestProfilesApi;

import java.io.File;
import java.util.*;

public class TestProfilesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TestProfilesApi apiInstance = new TestProfilesApi();
        Long id = 789; // Long | The profile ID.

        try {
            apiInstance.deleteProfile(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestProfilesApi#deleteProfile");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TestProfilesApi;

public class TestProfilesApiExample {
    public static void main(String[] args) {
        TestProfilesApi apiInstance = new TestProfilesApi();
        Long id = 789; // Long | The profile ID.

        try {
            apiInstance.deleteProfile(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestProfilesApi#deleteProfile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
TestProfilesApi *apiInstance = [[TestProfilesApi alloc] init];
Long *id = 789; // The profile ID. (default to null)

// Delete a profile by ID.
[apiInstance deleteProfileWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.TestProfilesApi()
var id = 789; // {Long} The profile ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteProfile(id, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class deleteProfileExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TestProfilesApi();
            var id = 789;  // Long | The profile ID. (default to null)

            try {
                // Delete a profile by ID.
                apiInstance.deleteProfile(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling TestProfilesApi.deleteProfile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TestProfilesApi();
$id = 789; // Long | The profile ID.

try {
    $api_instance->deleteProfile($id);
} catch (Exception $e) {
    echo 'Exception when calling TestProfilesApi->deleteProfile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TestProfilesApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TestProfilesApi->new();
my $id = 789; # Long | The profile ID.

eval {
    $api_instance->deleteProfile(id => $id);
};
if ($@) {
    warn "Exception when calling TestProfilesApi->deleteProfile: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TestProfilesApi()
id = 789 # Long | The profile ID. (default to null)

try:
    # Delete a profile by ID.
    api_instance.delete_profile(id)
except ApiException as e:
    print("Exception when calling TestProfilesApi->deleteProfile: %s\n" % e)
extern crate TestProfilesApi;

pub fn main() {
    let id = 789; // Long

    let mut context = TestProfilesApi::Context::default();
    let result = client.deleteProfile(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The profile ID.
Required

Responses


getTestProfile

Get the test profile.


/api/v1/profiles/{id}

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/profiles/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TestProfilesApi;

import java.io.File;
import java.util.*;

public class TestProfilesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TestProfilesApi apiInstance = new TestProfilesApi();
        Long id = 789; // Long | The profile ID.

        try {
            TestProfileResponse result = apiInstance.getTestProfile(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestProfilesApi#getTestProfile");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TestProfilesApi;

public class TestProfilesApiExample {
    public static void main(String[] args) {
        TestProfilesApi apiInstance = new TestProfilesApi();
        Long id = 789; // Long | The profile ID.

        try {
            TestProfileResponse result = apiInstance.getTestProfile(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestProfilesApi#getTestProfile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
TestProfilesApi *apiInstance = [[TestProfilesApi alloc] init];
Long *id = 789; // The profile ID. (default to null)

// Get the test profile.
[apiInstance getTestProfileWith:id
              completionHandler: ^(TestProfileResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.TestProfilesApi()
var id = 789; // {Long} The profile ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTestProfile(id, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class getTestProfileExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TestProfilesApi();
            var id = 789;  // Long | The profile ID. (default to null)

            try {
                // Get the test profile.
                TestProfileResponse result = apiInstance.getTestProfile(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TestProfilesApi.getTestProfile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TestProfilesApi();
$id = 789; // Long | The profile ID.

try {
    $result = $api_instance->getTestProfile($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TestProfilesApi->getTestProfile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TestProfilesApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TestProfilesApi->new();
my $id = 789; # Long | The profile ID.

eval {
    my $result = $api_instance->getTestProfile(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TestProfilesApi->getTestProfile: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TestProfilesApi()
id = 789 # Long | The profile ID. (default to null)

try:
    # Get the test profile.
    api_response = api_instance.get_test_profile(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TestProfilesApi->getTestProfile: %s\n" % e)
extern crate TestProfilesApi;

pub fn main() {
    let id = 789; // Long

    let mut context = TestProfilesApi::Context::default();
    let result = client.getTestProfile(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The profile ID.
Required

Responses


getTestProfiles

Get the profiles available for this user.


/api/v1/profiles

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/profiles"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TestProfilesApi;

import java.io.File;
import java.util.*;

public class TestProfilesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TestProfilesApi apiInstance = new TestProfilesApi();

        try {
            array[TestProfileResponse] result = apiInstance.getTestProfiles();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestProfilesApi#getTestProfiles");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TestProfilesApi;

public class TestProfilesApiExample {
    public static void main(String[] args) {
        TestProfilesApi apiInstance = new TestProfilesApi();

        try {
            array[TestProfileResponse] result = apiInstance.getTestProfiles();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestProfilesApi#getTestProfiles");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
TestProfilesApi *apiInstance = [[TestProfilesApi alloc] init];

// Get the profiles available for this user.
[apiInstance getTestProfilesWithCompletionHandler: 
              ^(array[TestProfileResponse] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.TestProfilesApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTestProfiles(callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class getTestProfilesExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TestProfilesApi();

            try {
                // Get the profiles available for this user.
                array[TestProfileResponse] result = apiInstance.getTestProfiles();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TestProfilesApi.getTestProfiles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TestProfilesApi();

try {
    $result = $api_instance->getTestProfiles();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TestProfilesApi->getTestProfiles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TestProfilesApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TestProfilesApi->new();

eval {
    my $result = $api_instance->getTestProfiles();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TestProfilesApi->getTestProfiles: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TestProfilesApi()

try:
    # Get the profiles available for this user.
    api_response = api_instance.get_test_profiles()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TestProfilesApi->getTestProfiles: %s\n" % e)
extern crate TestProfilesApi;

pub fn main() {

    let mut context = TestProfilesApi::Context::default();
    let result = client.getTestProfiles(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


removeTestProfileDefense

Remove defense from test profile.


/api/v1/profiles/{id}/defense/{defenseId}

Usage and SDK Samples

curl -X DELETE \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/profiles/{id}/defense/{defenseId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TestProfilesApi;

import java.io.File;
import java.util.*;

public class TestProfilesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TestProfilesApi apiInstance = new TestProfilesApi();
        Long defenseId = 789; // Long | The defense ID.
        Long id = 789; // Long | The profile ID.

        try {
            TestProfileResponse result = apiInstance.removeTestProfileDefense(defenseId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestProfilesApi#removeTestProfileDefense");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TestProfilesApi;

public class TestProfilesApiExample {
    public static void main(String[] args) {
        TestProfilesApi apiInstance = new TestProfilesApi();
        Long defenseId = 789; // Long | The defense ID.
        Long id = 789; // Long | The profile ID.

        try {
            TestProfileResponse result = apiInstance.removeTestProfileDefense(defenseId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestProfilesApi#removeTestProfileDefense");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
TestProfilesApi *apiInstance = [[TestProfilesApi alloc] init];
Long *defenseId = 789; // The defense ID. (default to null)
Long *id = 789; // The profile ID. (default to null)

// Remove defense from test profile.
[apiInstance removeTestProfileDefenseWith:defenseId
    id:id
              completionHandler: ^(TestProfileResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.TestProfilesApi()
var defenseId = 789; // {Long} The defense ID.
var id = 789; // {Long} The profile ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.removeTestProfileDefense(defenseId, id, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class removeTestProfileDefenseExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TestProfilesApi();
            var defenseId = 789;  // Long | The defense ID. (default to null)
            var id = 789;  // Long | The profile ID. (default to null)

            try {
                // Remove defense from test profile.
                TestProfileResponse result = apiInstance.removeTestProfileDefense(defenseId, id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TestProfilesApi.removeTestProfileDefense: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TestProfilesApi();
$defenseId = 789; // Long | The defense ID.
$id = 789; // Long | The profile ID.

try {
    $result = $api_instance->removeTestProfileDefense($defenseId, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TestProfilesApi->removeTestProfileDefense: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TestProfilesApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TestProfilesApi->new();
my $defenseId = 789; # Long | The defense ID.
my $id = 789; # Long | The profile ID.

eval {
    my $result = $api_instance->removeTestProfileDefense(defenseId => $defenseId, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TestProfilesApi->removeTestProfileDefense: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TestProfilesApi()
defenseId = 789 # Long | The defense ID. (default to null)
id = 789 # Long | The profile ID. (default to null)

try:
    # Remove defense from test profile.
    api_response = api_instance.remove_test_profile_defense(defenseId, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TestProfilesApi->removeTestProfileDefense: %s\n" % e)
extern crate TestProfilesApi;

pub fn main() {
    let defenseId = 789; // Long
    let id = 789; // Long

    let mut context = TestProfilesApi::Context::default();
    let result = client.removeTestProfileDefense(defenseId, id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
defenseId*
Long (int64)
The defense ID.
Required
id*
Long (int64)
The profile ID.
Required

Responses


updateTestProfile

Update profile by ID.


/api/v1/profiles/{id}

Usage and SDK Samples

curl -X PUT \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: application/json,application/xml" \
 "http://localhost:8082/api/v1/profiles/{id}" \
 -d '{
  "settings" : {
    "configured" : true,
    "storeIntermediateData" : true,
    "detectionTestSettings" : {
      "id" : 7,
      "params" : "{}",
      "poisonedDatasetSetting" : {
        "selectionType" : "COUNT",
        "endIdx" : 7,
        "indexes" : [ 1, 1 ],
        "startIdx" : 6,
        "batchSize" : 4,
        "shuffle" : true,
        "workers" : 7,
        "fraction" : 1.2315135,
        "numItems" : 1
      },
      "passDeviations" : 9.301444
    },
    "testType" : "Crafted",
    "hpoId" : 3,
    "defenses" : [ {
      "defenseParameters" : "defenseParameters",
      "name" : "name",
      "testId" : 5,
      "filters" : [ {
        "paper_link" : "paper_link",
        "codebase_name" : "codebase_name",
        "name" : "name",
        "id" : 1,
        "type" : "type",
        "parameters" : "parameters",
        "enabled" : true,
        "tasks" : [ "tasks", "tasks" ],
        "group" : [ "group", "group" ]
      }, {
        "paper_link" : "paper_link",
        "codebase_name" : "codebase_name",
        "name" : "name",
        "id" : 1,
        "type" : "type",
        "parameters" : "parameters",
        "enabled" : true,
        "tasks" : [ "tasks", "tasks" ],
        "group" : [ "group", "group" ]
      } ],
      "id" : 4
    }, {
      "defenseParameters" : "defenseParameters",
      "name" : "name",
      "testId" : 5,
      "filters" : [ {
        "paper_link" : "paper_link",
        "codebase_name" : "codebase_name",
        "name" : "name",
        "id" : 1,
        "type" : "type",
        "parameters" : "parameters",
        "enabled" : true,
        "tasks" : [ "tasks", "tasks" ],
        "group" : [ "group", "group" ]
      }, {
        "paper_link" : "paper_link",
        "codebase_name" : "codebase_name",
        "name" : "name",
        "id" : 1,
        "type" : "type",
        "parameters" : "parameters",
        "enabled" : true,
        "tasks" : [ "tasks", "tasks" ],
        "group" : [ "group", "group" ]
      } ],
      "id" : 4
    } ],
    "epsExplorationParams" : "{}",
    "epsExploration" : true,
    "passFailCriteria" : [ {
      "metricName" : "metricName",
      "above" : true,
      "passVal" : 2.027123,
      "enabled" : true
    }, {
      "metricName" : "metricName",
      "above" : true,
      "passVal" : 2.027123,
      "enabled" : true
    } ],
    "datasetSetting" : {
      "selectionType" : "COUNT",
      "endIdx" : 7,
      "indexes" : [ 1, 1 ],
      "startIdx" : 6,
      "batchSize" : 4,
      "shuffle" : true,
      "workers" : 7,
      "fraction" : 1.2315135,
      "numItems" : 1
    },
    "approximateRobustness" : true,
    "storeCompositeImages" : true,
    "overlayImageOnSegMap" : true,
    "batchWiseHPO" : true,
    "hpoParams" : "{}",
    "metrics" : {
      "key" : [ {
        "uid" : "uid",
        "name" : "name",
        "params" : "{}",
        "enabled" : true
      }, {
        "uid" : "uid",
        "name" : "name",
        "params" : "{}",
        "enabled" : true
      } ]
    },
    "optimalParameterization" : true,
    "craftedSettings" : {
      "toClass" : "toClass",
      "regions" : [ {
        "y1" : 5,
        "x1" : 1,
        "y2" : 2,
        "x2" : 5
      }, {
        "y1" : 5,
        "x1" : 1,
        "y2" : 2,
        "x2" : 5
      } ],
      "itemIdx" : 6,
      "params" : "{}",
      "fromClass" : "fromClass"
    },
    "passPercentage" : 4.145608,
    "tasks" : [ "tasks", "tasks" ],
    "arParams" : "{}"
  },
  "name" : "name",
  "description" : "description",
  "id" : 0
}' \
 -d '<TestProfileRequest>
  <description>aeiou</description>
  <id>123456789</id>
  <name>aeiou</name>
</TestProfileRequest>'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TestProfilesApi;

import java.io.File;
import java.util.*;

public class TestProfilesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TestProfilesApi apiInstance = new TestProfilesApi();
        Long id = 789; // Long | The profile ID.
        TestProfileRequest profile = ; // TestProfileRequest | 

        try {
            TestProfileResponse result = apiInstance.updateTestProfile(id, profile);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestProfilesApi#updateTestProfile");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TestProfilesApi;

public class TestProfilesApiExample {
    public static void main(String[] args) {
        TestProfilesApi apiInstance = new TestProfilesApi();
        Long id = 789; // Long | The profile ID.
        TestProfileRequest profile = ; // TestProfileRequest | 

        try {
            TestProfileResponse result = apiInstance.updateTestProfile(id, profile);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestProfilesApi#updateTestProfile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
TestProfilesApi *apiInstance = [[TestProfilesApi alloc] init];
Long *id = 789; // The profile ID. (default to null)
TestProfileRequest *profile = ; // 

// Update profile by ID.
[apiInstance updateTestProfileWith:id
    profile:profile
              completionHandler: ^(TestProfileResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.TestProfilesApi()
var id = 789; // {Long} The profile ID.
var profile = ; // {TestProfileRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateTestProfile(id, profile, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class updateTestProfileExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TestProfilesApi();
            var id = 789;  // Long | The profile ID. (default to null)
            var profile = new TestProfileRequest(); // TestProfileRequest | 

            try {
                // Update profile by ID.
                TestProfileResponse result = apiInstance.updateTestProfile(id, profile);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TestProfilesApi.updateTestProfile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TestProfilesApi();
$id = 789; // Long | The profile ID.
$profile = ; // TestProfileRequest | 

try {
    $result = $api_instance->updateTestProfile($id, $profile);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TestProfilesApi->updateTestProfile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TestProfilesApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TestProfilesApi->new();
my $id = 789; # Long | The profile ID.
my $profile = WWW::OPenAPIClient::Object::TestProfileRequest->new(); # TestProfileRequest | 

eval {
    my $result = $api_instance->updateTestProfile(id => $id, profile => $profile);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TestProfilesApi->updateTestProfile: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TestProfilesApi()
id = 789 # Long | The profile ID. (default to null)
profile =  # TestProfileRequest | 

try:
    # Update profile by ID.
    api_response = api_instance.update_test_profile(id, profile)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TestProfilesApi->updateTestProfile: %s\n" % e)
extern crate TestProfilesApi;

pub fn main() {
    let id = 789; // Long
    let profile = ; // TestProfileRequest

    let mut context = TestProfilesApi::Context::default();
    let result = client.updateTestProfile(id, profile, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The profile ID.
Required
Body parameters
Name Description
profile *

The profile update request.

Responses


Transform

addTransform

Add a transform to an organization.


/api/v1/transforms

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/transforms?id=789&name=name_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TransformApi;

import java.io.File;
import java.util.*;

public class TransformApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TransformApi apiInstance = new TransformApi();
        Long id = 789; // Long | The organization ID.
        String name = name_example; // String | The transform name.

        try {
            TransformDefinition result = apiInstance.addTransform(id, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransformApi#addTransform");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TransformApi;

public class TransformApiExample {
    public static void main(String[] args) {
        TransformApi apiInstance = new TransformApi();
        Long id = 789; // Long | The organization ID.
        String name = name_example; // String | The transform name.

        try {
            TransformDefinition result = apiInstance.addTransform(id, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransformApi#addTransform");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
TransformApi *apiInstance = [[TransformApi alloc] init];
Long *id = 789; // The organization ID. (default to null)
String *name = name_example; // The transform name. (default to null)

// Add a transform to an organization.
[apiInstance addTransformWith:id
    name:name
              completionHandler: ^(TransformDefinition output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.TransformApi()
var id = 789; // {Long} The organization ID.
var name = name_example; // {String} The transform name.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addTransform(id, name, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class addTransformExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TransformApi();
            var id = 789;  // Long | The organization ID. (default to null)
            var name = name_example;  // String | The transform name. (default to null)

            try {
                // Add a transform to an organization.
                TransformDefinition result = apiInstance.addTransform(id, name);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TransformApi.addTransform: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TransformApi();
$id = 789; // Long | The organization ID.
$name = name_example; // String | The transform name.

try {
    $result = $api_instance->addTransform($id, $name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransformApi->addTransform: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TransformApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TransformApi->new();
my $id = 789; # Long | The organization ID.
my $name = name_example; # String | The transform name.

eval {
    my $result = $api_instance->addTransform(id => $id, name => $name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransformApi->addTransform: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TransformApi()
id = 789 # Long | The organization ID. (default to null)
name = name_example # String | The transform name. (default to null)

try:
    # Add a transform to an organization.
    api_response = api_instance.add_transform(id, name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransformApi->addTransform: %s\n" % e)
extern crate TransformApi;

pub fn main() {
    let id = 789; // Long
    let name = name_example; // String

    let mut context = TransformApi::Context::default();
    let result = client.addTransform(id, name, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
id*
Long (int64)
The organization ID.
Required
name*
String
The transform name.
Required

Responses


deleteTransform

Delete a transform by ID.


/api/v1/transforms/{id}

Usage and SDK Samples

curl -X DELETE \
-H "Authorization: [[apiKey]]" \
 "http://localhost:8082/api/v1/transforms/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TransformApi;

import java.io.File;
import java.util.*;

public class TransformApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TransformApi apiInstance = new TransformApi();
        Long id = 789; // Long | The transform ID.

        try {
            apiInstance.deleteTransform(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransformApi#deleteTransform");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TransformApi;

public class TransformApiExample {
    public static void main(String[] args) {
        TransformApi apiInstance = new TransformApi();
        Long id = 789; // Long | The transform ID.

        try {
            apiInstance.deleteTransform(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransformApi#deleteTransform");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
TransformApi *apiInstance = [[TransformApi alloc] init];
Long *id = 789; // The transform ID. (default to null)

// Delete a transform by ID.
[apiInstance deleteTransformWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.TransformApi()
var id = 789; // {Long} The transform ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteTransform(id, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class deleteTransformExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TransformApi();
            var id = 789;  // Long | The transform ID. (default to null)

            try {
                // Delete a transform by ID.
                apiInstance.deleteTransform(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling TransformApi.deleteTransform: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TransformApi();
$id = 789; // Long | The transform ID.

try {
    $api_instance->deleteTransform($id);
} catch (Exception $e) {
    echo 'Exception when calling TransformApi->deleteTransform: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TransformApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TransformApi->new();
my $id = 789; # Long | The transform ID.

eval {
    $api_instance->deleteTransform(id => $id);
};
if ($@) {
    warn "Exception when calling TransformApi->deleteTransform: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TransformApi()
id = 789 # Long | The transform ID. (default to null)

try:
    # Delete a transform by ID.
    api_instance.delete_transform(id)
except ApiException as e:
    print("Exception when calling TransformApi->deleteTransform: %s\n" % e)
extern crate TransformApi;

pub fn main() {
    let id = 789; // Long

    let mut context = TransformApi::Context::default();
    let result = client.deleteTransform(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The transform ID.
Required

Responses


downloadFile

Download transform file.


/api/v1/transforms/{id}/data

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/transforms/{id}/data"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TransformApi;

import java.io.File;
import java.util.*;

public class TransformApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TransformApi apiInstance = new TransformApi();
        Long id = 789; // Long | The transform ID.

        try {
            File result = apiInstance.downloadFile(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransformApi#downloadFile");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TransformApi;

public class TransformApiExample {
    public static void main(String[] args) {
        TransformApi apiInstance = new TransformApi();
        Long id = 789; // Long | The transform ID.

        try {
            File result = apiInstance.downloadFile(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransformApi#downloadFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
TransformApi *apiInstance = [[TransformApi alloc] init];
Long *id = 789; // The transform ID. (default to null)

// Download transform file.
[apiInstance downloadFileWith:id
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.TransformApi()
var id = 789; // {Long} The transform ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.downloadFile(id, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class downloadFileExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TransformApi();
            var id = 789;  // Long | The transform ID. (default to null)

            try {
                // Download transform file.
                File result = apiInstance.downloadFile(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TransformApi.downloadFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TransformApi();
$id = 789; // Long | The transform ID.

try {
    $result = $api_instance->downloadFile($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransformApi->downloadFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TransformApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TransformApi->new();
my $id = 789; # Long | The transform ID.

eval {
    my $result = $api_instance->downloadFile(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransformApi->downloadFile: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TransformApi()
id = 789 # Long | The transform ID. (default to null)

try:
    # Download transform file.
    api_response = api_instance.download_file(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransformApi->downloadFile: %s\n" % e)
extern crate TransformApi;

pub fn main() {
    let id = 789; // Long

    let mut context = TransformApi::Context::default();
    let result = client.downloadFile(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The transform ID.
Required

Responses


getTransform

Get a transform by ID.


/api/v1/transforms/{id}

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/transforms/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TransformApi;

import java.io.File;
import java.util.*;

public class TransformApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TransformApi apiInstance = new TransformApi();
        Long id = 789; // Long | The transform ID.

        try {
            TransformDefinition result = apiInstance.getTransform(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransformApi#getTransform");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TransformApi;

public class TransformApiExample {
    public static void main(String[] args) {
        TransformApi apiInstance = new TransformApi();
        Long id = 789; // Long | The transform ID.

        try {
            TransformDefinition result = apiInstance.getTransform(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransformApi#getTransform");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
TransformApi *apiInstance = [[TransformApi alloc] init];
Long *id = 789; // The transform ID. (default to null)

// Get a transform by ID.
[apiInstance getTransformWith:id
              completionHandler: ^(TransformDefinition output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.TransformApi()
var id = 789; // {Long} The transform ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTransform(id, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class getTransformExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TransformApi();
            var id = 789;  // Long | The transform ID. (default to null)

            try {
                // Get a transform by ID.
                TransformDefinition result = apiInstance.getTransform(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TransformApi.getTransform: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TransformApi();
$id = 789; // Long | The transform ID.

try {
    $result = $api_instance->getTransform($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransformApi->getTransform: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TransformApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TransformApi->new();
my $id = 789; # Long | The transform ID.

eval {
    my $result = $api_instance->getTransform(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransformApi->getTransform: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TransformApi()
id = 789 # Long | The transform ID. (default to null)

try:
    # Get a transform by ID.
    api_response = api_instance.get_transform(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransformApi->getTransform: %s\n" % e)
extern crate TransformApi;

pub fn main() {
    let id = 789; // Long

    let mut context = TransformApi::Context::default();
    let result = client.getTransform(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The transform ID.
Required

Responses


getTransforms

Get the transforms available for this user.


/api/v1/transforms

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/transforms"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TransformApi;

import java.io.File;
import java.util.*;

public class TransformApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TransformApi apiInstance = new TransformApi();

        try {
            array[TransformDefinition] result = apiInstance.getTransforms();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransformApi#getTransforms");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TransformApi;

public class TransformApiExample {
    public static void main(String[] args) {
        TransformApi apiInstance = new TransformApi();

        try {
            array[TransformDefinition] result = apiInstance.getTransforms();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransformApi#getTransforms");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
TransformApi *apiInstance = [[TransformApi alloc] init];

// Get the transforms available for this user.
[apiInstance getTransformsWithCompletionHandler: 
              ^(array[TransformDefinition] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.TransformApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTransforms(callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class getTransformsExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TransformApi();

            try {
                // Get the transforms available for this user.
                array[TransformDefinition] result = apiInstance.getTransforms();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TransformApi.getTransforms: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TransformApi();

try {
    $result = $api_instance->getTransforms();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransformApi->getTransforms: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TransformApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TransformApi->new();

eval {
    my $result = $api_instance->getTransforms();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransformApi->getTransforms: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TransformApi()

try:
    # Get the transforms available for this user.
    api_response = api_instance.get_transforms()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransformApi->getTransforms: %s\n" % e)
extern crate TransformApi;

pub fn main() {

    let mut context = TransformApi::Context::default();
    let result = client.getTransforms(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


updateTransform

Update transform by ID.


/api/v1/transforms/{id}

Usage and SDK Samples

curl -X PUT \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: application/json,application/xml" \
 "http://localhost:8082/api/v1/transforms/{id}" \
 -d '{
  "apply_mapping" : {
    "key" : {
      "key" : "{}"
    }
  },
  "codebase_name" : "codebase_name",
  "converted_target_format" : "converted_target_format",
  "name" : "name",
  "description" : "description",
  "id" : 0,
  "params" : [ {
    "key" : "{}"
  }, {
    "key" : "{}"
  } ],
  "enabled" : true,
  "tasks" : [ "tasks", "tasks" ],
  "target_format" : [ "target_format", "target_format" ]
}' \
 -d '<TransformDefinition>
  <apply_mapping>UNDEFINED_EXAMPLE_VALUE</apply_mapping>
  <codebase_name>aeiou</codebase_name>
  <converted_target_format>aeiou</converted_target_format>
  <description>aeiou</description>
  <enabled>true</enabled>
  <id>123456789</id>
  <name>aeiou</name>
  <params>UNDEFINED_EXAMPLE_VALUE</params>
  <target_format>aeiou</target_format>
  <tasks>aeiou</tasks>
</TransformDefinition>'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TransformApi;

import java.io.File;
import java.util.*;

public class TransformApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TransformApi apiInstance = new TransformApi();
        Long id = 789; // Long | The transform ID.
        TransformDefinition model = ; // TransformDefinition | 

        try {
            TransformDefinition result = apiInstance.updateTransform(id, model);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransformApi#updateTransform");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TransformApi;

public class TransformApiExample {
    public static void main(String[] args) {
        TransformApi apiInstance = new TransformApi();
        Long id = 789; // Long | The transform ID.
        TransformDefinition model = ; // TransformDefinition | 

        try {
            TransformDefinition result = apiInstance.updateTransform(id, model);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransformApi#updateTransform");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
TransformApi *apiInstance = [[TransformApi alloc] init];
Long *id = 789; // The transform ID. (default to null)
TransformDefinition *model = ; // 

// Update transform by ID.
[apiInstance updateTransformWith:id
    model:model
              completionHandler: ^(TransformDefinition output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.TransformApi()
var id = 789; // {Long} The transform ID.
var model = ; // {TransformDefinition} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateTransform(id, model, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class updateTransformExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TransformApi();
            var id = 789;  // Long | The transform ID. (default to null)
            var model = new TransformDefinition(); // TransformDefinition | 

            try {
                // Update transform by ID.
                TransformDefinition result = apiInstance.updateTransform(id, model);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TransformApi.updateTransform: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TransformApi();
$id = 789; // Long | The transform ID.
$model = ; // TransformDefinition | 

try {
    $result = $api_instance->updateTransform($id, $model);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransformApi->updateTransform: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TransformApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TransformApi->new();
my $id = 789; # Long | The transform ID.
my $model = WWW::OPenAPIClient::Object::TransformDefinition->new(); # TransformDefinition | 

eval {
    my $result = $api_instance->updateTransform(id => $id, model => $model);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransformApi->updateTransform: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TransformApi()
id = 789 # Long | The transform ID. (default to null)
model =  # TransformDefinition | 

try:
    # Update transform by ID.
    api_response = api_instance.update_transform(id, model)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransformApi->updateTransform: %s\n" % e)
extern crate TransformApi;

pub fn main() {
    let id = 789; // Long
    let model = ; // TransformDefinition

    let mut context = TransformApi::Context::default();
    let result = client.updateTransform(id, model, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The transform ID.
Required
Body parameters
Name Description
model *

The transform update request.

Responses


uploadFile

Upload the data file for the transform.


/api/v1/transforms/{id}

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: multipart/form-data" \
 "http://localhost:8082/api/v1/transforms/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TransformApi;

import java.io.File;
import java.util.*;

public class TransformApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TransformApi apiInstance = new TransformApi();
        Long id = 789; // Long | The transform ID.
        File file = BINARY_DATA_HERE; // File | 

        try {
            TransformDefinition result = apiInstance.uploadFile(id, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransformApi#uploadFile");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TransformApi;

public class TransformApiExample {
    public static void main(String[] args) {
        TransformApi apiInstance = new TransformApi();
        Long id = 789; // Long | The transform ID.
        File file = BINARY_DATA_HERE; // File | 

        try {
            TransformDefinition result = apiInstance.uploadFile(id, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransformApi#uploadFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
TransformApi *apiInstance = [[TransformApi alloc] init];
Long *id = 789; // The transform ID. (default to null)
File *file = BINARY_DATA_HERE; //  (optional) (default to null)

// Upload the data file for the transform.
[apiInstance uploadFileWith:id
    file:file
              completionHandler: ^(TransformDefinition output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.TransformApi()
var id = 789; // {Long} The transform ID.
var opts = {
  'file': BINARY_DATA_HERE // {File} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.uploadFile(id, opts, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class uploadFileExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TransformApi();
            var id = 789;  // Long | The transform ID. (default to null)
            var file = BINARY_DATA_HERE;  // File |  (optional)  (default to null)

            try {
                // Upload the data file for the transform.
                TransformDefinition result = apiInstance.uploadFile(id, file);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TransformApi.uploadFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TransformApi();
$id = 789; // Long | The transform ID.
$file = BINARY_DATA_HERE; // File | 

try {
    $result = $api_instance->uploadFile($id, $file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransformApi->uploadFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TransformApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TransformApi->new();
my $id = 789; # Long | The transform ID.
my $file = BINARY_DATA_HERE; # File | 

eval {
    my $result = $api_instance->uploadFile(id => $id, file => $file);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransformApi->uploadFile: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TransformApi()
id = 789 # Long | The transform ID. (default to null)
file = BINARY_DATA_HERE # File |  (optional) (default to null)

try:
    # Upload the data file for the transform.
    api_response = api_instance.upload_file(id, file=file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransformApi->uploadFile: %s\n" % e)
extern crate TransformApi;

pub fn main() {
    let id = 789; // Long
    let file = BINARY_DATA_HERE; // File

    let mut context = TransformApi::Context::default();
    let result = client.uploadFile(id, file, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The transform ID.
Required
Form parameters
Name Description
file
File (binary)

Responses


Users

deleteUser

Delete a user.


/api/v1/users/{id}

Usage and SDK Samples

curl -X DELETE \
-H "Authorization: [[apiKey]]" \
 "http://localhost:8082/api/v1/users/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UsersApi;

import java.io.File;
import java.util.*;

public class UsersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UsersApi apiInstance = new UsersApi();
        Long id = 789; // Long | id

        try {
            apiInstance.deleteUser(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#deleteUser");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UsersApi;

public class UsersApiExample {
    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        Long id = 789; // Long | id

        try {
            apiInstance.deleteUser(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#deleteUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
UsersApi *apiInstance = [[UsersApi alloc] init];
Long *id = 789; // id (default to null)

// Delete a user.
[apiInstance deleteUserWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.UsersApi()
var id = 789; // {Long} id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteUser(id, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class deleteUserExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new UsersApi();
            var id = 789;  // Long | id (default to null)

            try {
                // Delete a user.
                apiInstance.deleteUser(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling UsersApi.deleteUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UsersApi();
$id = 789; // Long | id

try {
    $api_instance->deleteUser($id);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->deleteUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UsersApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UsersApi->new();
my $id = 789; # Long | id

eval {
    $api_instance->deleteUser(id => $id);
};
if ($@) {
    warn "Exception when calling UsersApi->deleteUser: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UsersApi()
id = 789 # Long | id (default to null)

try:
    # Delete a user.
    api_instance.delete_user(id)
except ApiException as e:
    print("Exception when calling UsersApi->deleteUser: %s\n" % e)
extern crate UsersApi;

pub fn main() {
    let id = 789; // Long

    let mut context = UsersApi::Context::default();
    let result = client.deleteUser(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
id
Required

Responses


getLoggedInUser

Get the currently logged-in user.


/api/v1/users/me

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/users/me"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UsersApi;

import java.io.File;
import java.util.*;

public class UsersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UsersApi apiInstance = new UsersApi();

        try {
            UserResponse result = apiInstance.getLoggedInUser();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getLoggedInUser");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UsersApi;

public class UsersApiExample {
    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();

        try {
            UserResponse result = apiInstance.getLoggedInUser();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getLoggedInUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
UsersApi *apiInstance = [[UsersApi alloc] init];

// Get the currently logged-in user.
[apiInstance getLoggedInUserWithCompletionHandler: 
              ^(UserResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.UsersApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getLoggedInUser(callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class getLoggedInUserExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new UsersApi();

            try {
                // Get the currently logged-in user.
                UserResponse result = apiInstance.getLoggedInUser();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UsersApi.getLoggedInUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UsersApi();

try {
    $result = $api_instance->getLoggedInUser();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->getLoggedInUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UsersApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UsersApi->new();

eval {
    my $result = $api_instance->getLoggedInUser();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->getLoggedInUser: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UsersApi()

try:
    # Get the currently logged-in user.
    api_response = api_instance.get_logged_in_user()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->getLoggedInUser: %s\n" % e)
extern crate UsersApi;

pub fn main() {

    let mut context = UsersApi::Context::default();
    let result = client.getLoggedInUser(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getUser

Get a user.


/api/v1/users/{id}

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/users/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UsersApi;

import java.io.File;
import java.util.*;

public class UsersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UsersApi apiInstance = new UsersApi();
        Long id = 789; // Long | id

        try {
            UserResponse result = apiInstance.getUser(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getUser");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UsersApi;

public class UsersApiExample {
    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        Long id = 789; // Long | id

        try {
            UserResponse result = apiInstance.getUser(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
UsersApi *apiInstance = [[UsersApi alloc] init];
Long *id = 789; // id (default to null)

// Get a user.
[apiInstance getUserWith:id
              completionHandler: ^(UserResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.UsersApi()
var id = 789; // {Long} id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUser(id, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class getUserExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new UsersApi();
            var id = 789;  // Long | id (default to null)

            try {
                // Get a user.
                UserResponse result = apiInstance.getUser(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UsersApi.getUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UsersApi();
$id = 789; // Long | id

try {
    $result = $api_instance->getUser($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->getUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UsersApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UsersApi->new();
my $id = 789; # Long | id

eval {
    my $result = $api_instance->getUser(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->getUser: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UsersApi()
id = 789 # Long | id (default to null)

try:
    # Get a user.
    api_response = api_instance.get_user(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->getUser: %s\n" % e)
extern crate UsersApi;

pub fn main() {
    let id = 789; // Long

    let mut context = UsersApi::Context::default();
    let result = client.getUser(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
id
Required

Responses


getUserLogs

Get user logs.


/api/v1/users/{id}/logs

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/users/{id}/logs"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UsersApi;

import java.io.File;
import java.util.*;

public class UsersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UsersApi apiInstance = new UsersApi();
        Long id = 789; // Long | id

        try {
            array[LogEntryResponse] result = apiInstance.getUserLogs(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getUserLogs");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UsersApi;

public class UsersApiExample {
    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        Long id = 789; // Long | id

        try {
            array[LogEntryResponse] result = apiInstance.getUserLogs(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getUserLogs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
UsersApi *apiInstance = [[UsersApi alloc] init];
Long *id = 789; // id (default to null)

// Get user logs.
[apiInstance getUserLogsWith:id
              completionHandler: ^(array[LogEntryResponse] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.UsersApi()
var id = 789; // {Long} id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserLogs(id, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class getUserLogsExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new UsersApi();
            var id = 789;  // Long | id (default to null)

            try {
                // Get user logs.
                array[LogEntryResponse] result = apiInstance.getUserLogs(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UsersApi.getUserLogs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UsersApi();
$id = 789; // Long | id

try {
    $result = $api_instance->getUserLogs($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->getUserLogs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UsersApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UsersApi->new();
my $id = 789; # Long | id

eval {
    my $result = $api_instance->getUserLogs(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->getUserLogs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UsersApi()
id = 789 # Long | id (default to null)

try:
    # Get user logs.
    api_response = api_instance.get_user_logs(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->getUserLogs: %s\n" % e)
extern crate UsersApi;

pub fn main() {
    let id = 789; // Long

    let mut context = UsersApi::Context::default();
    let result = client.getUserLogs(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
id
Required

Responses


getUsers

Get all users (access rights required).


/api/v1/users

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/users"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UsersApi;

import java.io.File;
import java.util.*;

public class UsersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UsersApi apiInstance = new UsersApi();

        try {
            array[UserResponse] result = apiInstance.getUsers();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getUsers");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UsersApi;

public class UsersApiExample {
    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();

        try {
            array[UserResponse] result = apiInstance.getUsers();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getUsers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
UsersApi *apiInstance = [[UsersApi alloc] init];

// Get all users (access rights required).
[apiInstance getUsersWithCompletionHandler: 
              ^(array[UserResponse] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.UsersApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUsers(callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class getUsersExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new UsersApi();

            try {
                // Get all users (access rights required).
                array[UserResponse] result = apiInstance.getUsers();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UsersApi.getUsers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UsersApi();

try {
    $result = $api_instance->getUsers();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->getUsers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UsersApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UsersApi->new();

eval {
    my $result = $api_instance->getUsers();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->getUsers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UsersApi()

try:
    # Get all users (access rights required).
    api_response = api_instance.get_users()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->getUsers: %s\n" % e)
extern crate UsersApi;

pub fn main() {

    let mut context = UsersApi::Context::default();
    let result = client.getUsers(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


sendFeedback

Send user feedback.


/api/v1/users/feedback

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 -H "Content-Type: application/json,application/xml" \
 "http://localhost:8082/api/v1/users/feedback" \
 -d '{
  "feedback" : "feedback",
  "roles" : "roles",
  "organizations" : [ 0, 0 ],
  "jsonSettings" : "jsonSettings",
  "licenseAccepted" : true
}' \
 -d '<UserRequest>
  <feedback>aeiou</feedback>
  <jsonSettings>aeiou</jsonSettings>
  <licenseAccepted>true</licenseAccepted>
  <organizations>123456789</organizations>
  <roles>aeiou</roles>
</UserRequest>'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UsersApi;

import java.io.File;
import java.util.*;

public class UsersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UsersApi apiInstance = new UsersApi();
        UserRequest userRequest = ; // UserRequest | 

        try {
            apiInstance.sendFeedback(userRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#sendFeedback");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UsersApi;

public class UsersApiExample {
    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        UserRequest userRequest = ; // UserRequest | 

        try {
            apiInstance.sendFeedback(userRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#sendFeedback");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
UsersApi *apiInstance = [[UsersApi alloc] init];
UserRequest *userRequest = ; // 

// Send user feedback.
[apiInstance sendFeedbackWith:userRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.UsersApi()
var userRequest = ; // {UserRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.sendFeedback(userRequest, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class sendFeedbackExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new UsersApi();
            var userRequest = new UserRequest(); // UserRequest | 

            try {
                // Send user feedback.
                apiInstance.sendFeedback(userRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling UsersApi.sendFeedback: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UsersApi();
$userRequest = ; // UserRequest | 

try {
    $api_instance->sendFeedback($userRequest);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->sendFeedback: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UsersApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UsersApi->new();
my $userRequest = WWW::OPenAPIClient::Object::UserRequest->new(); # UserRequest | 

eval {
    $api_instance->sendFeedback(userRequest => $userRequest);
};
if ($@) {
    warn "Exception when calling UsersApi->sendFeedback: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UsersApi()
userRequest =  # UserRequest | 

try:
    # Send user feedback.
    api_instance.send_feedback(userRequest)
except ApiException as e:
    print("Exception when calling UsersApi->sendFeedback: %s\n" % e)
extern crate UsersApi;

pub fn main() {
    let userRequest = ; // UserRequest

    let mut context = UsersApi::Context::default();
    let result = client.sendFeedback(userRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
userRequest *

The user request.

Responses


updateProfile

Update profile of currently authenticated user.


/api/v1/users

Usage and SDK Samples

curl -X PUT \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: application/json,application/xml" \
 "http://localhost:8082/api/v1/users" \
 -d '{
  "feedback" : "feedback",
  "roles" : "roles",
  "organizations" : [ 0, 0 ],
  "jsonSettings" : "jsonSettings",
  "licenseAccepted" : true
}' \
 -d '<UserRequest>
  <feedback>aeiou</feedback>
  <jsonSettings>aeiou</jsonSettings>
  <licenseAccepted>true</licenseAccepted>
  <organizations>123456789</organizations>
  <roles>aeiou</roles>
</UserRequest>'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UsersApi;

import java.io.File;
import java.util.*;

public class UsersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UsersApi apiInstance = new UsersApi();
        UserRequest userRequest = ; // UserRequest | 

        try {
            UserResponse result = apiInstance.updateProfile(userRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#updateProfile");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UsersApi;

public class UsersApiExample {
    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        UserRequest userRequest = ; // UserRequest | 

        try {
            UserResponse result = apiInstance.updateProfile(userRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#updateProfile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
UsersApi *apiInstance = [[UsersApi alloc] init];
UserRequest *userRequest = ; // 

// Update profile of currently authenticated user.
[apiInstance updateProfileWith:userRequest
              completionHandler: ^(UserResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.UsersApi()
var userRequest = ; // {UserRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateProfile(userRequest, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class updateProfileExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new UsersApi();
            var userRequest = new UserRequest(); // UserRequest | 

            try {
                // Update profile of currently authenticated user.
                UserResponse result = apiInstance.updateProfile(userRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UsersApi.updateProfile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UsersApi();
$userRequest = ; // UserRequest | 

try {
    $result = $api_instance->updateProfile($userRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->updateProfile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UsersApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UsersApi->new();
my $userRequest = WWW::OPenAPIClient::Object::UserRequest->new(); # UserRequest | 

eval {
    my $result = $api_instance->updateProfile(userRequest => $userRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->updateProfile: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UsersApi()
userRequest =  # UserRequest | 

try:
    # Update profile of currently authenticated user.
    api_response = api_instance.update_profile(userRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->updateProfile: %s\n" % e)
extern crate UsersApi;

pub fn main() {
    let userRequest = ; // UserRequest

    let mut context = UsersApi::Context::default();
    let result = client.updateProfile(userRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
userRequest *

The user update request.

Responses


updateUser

Update user by user id - (admin permission required)


/api/v1/users/{id}

Usage and SDK Samples

curl -X PUT \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: application/json,application/xml" \
 "http://localhost:8082/api/v1/users/{id}" \
 -d '{
  "feedback" : "feedback",
  "roles" : "roles",
  "organizations" : [ 0, 0 ],
  "jsonSettings" : "jsonSettings",
  "licenseAccepted" : true
}' \
 -d '<UserRequest>
  <feedback>aeiou</feedback>
  <jsonSettings>aeiou</jsonSettings>
  <licenseAccepted>true</licenseAccepted>
  <organizations>123456789</organizations>
  <roles>aeiou</roles>
</UserRequest>'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UsersApi;

import java.io.File;
import java.util.*;

public class UsersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UsersApi apiInstance = new UsersApi();
        Long id = 789; // Long | The user ID.
        UserRequest userRequest = ; // UserRequest | 

        try {
            UserResponse result = apiInstance.updateUser(id, userRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#updateUser");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UsersApi;

public class UsersApiExample {
    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        Long id = 789; // Long | The user ID.
        UserRequest userRequest = ; // UserRequest | 

        try {
            UserResponse result = apiInstance.updateUser(id, userRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#updateUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
UsersApi *apiInstance = [[UsersApi alloc] init];
Long *id = 789; // The user ID. (default to null)
UserRequest *userRequest = ; // 

// Update user by user id - (admin permission required)
[apiInstance updateUserWith:id
    userRequest:userRequest
              completionHandler: ^(UserResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.UsersApi()
var id = 789; // {Long} The user ID.
var userRequest = ; // {UserRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateUser(id, userRequest, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class updateUserExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new UsersApi();
            var id = 789;  // Long | The user ID. (default to null)
            var userRequest = new UserRequest(); // UserRequest | 

            try {
                // Update user by user id - (admin permission required)
                UserResponse result = apiInstance.updateUser(id, userRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UsersApi.updateUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UsersApi();
$id = 789; // Long | The user ID.
$userRequest = ; // UserRequest | 

try {
    $result = $api_instance->updateUser($id, $userRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->updateUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UsersApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UsersApi->new();
my $id = 789; # Long | The user ID.
my $userRequest = WWW::OPenAPIClient::Object::UserRequest->new(); # UserRequest | 

eval {
    my $result = $api_instance->updateUser(id => $id, userRequest => $userRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->updateUser: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UsersApi()
id = 789 # Long | The user ID. (default to null)
userRequest =  # UserRequest | 

try:
    # Update user by user id - (admin permission required)
    api_response = api_instance.update_user(id, userRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->updateUser: %s\n" % e)
extern crate UsersApi;

pub fn main() {
    let id = 789; // Long
    let userRequest = ; // UserRequest

    let mut context = UsersApi::Context::default();
    let result = client.updateUser(id, userRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
The user ID.
Required
Body parameters
Name Description
userRequest *

userRequest

Responses


Versions

getPlatformVersion

Get platform version


/api/v1/versions

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/versions"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VersionsApi;

import java.io.File;
import java.util.*;

public class VersionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        VersionsApi apiInstance = new VersionsApi();

        try {
            'String' result = apiInstance.getPlatformVersion();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VersionsApi#getPlatformVersion");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VersionsApi;

public class VersionsApiExample {
    public static void main(String[] args) {
        VersionsApi apiInstance = new VersionsApi();

        try {
            'String' result = apiInstance.getPlatformVersion();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VersionsApi#getPlatformVersion");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
VersionsApi *apiInstance = [[VersionsApi alloc] init];

// Get platform version
[apiInstance getPlatformVersionWithCompletionHandler: 
              ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.VersionsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPlatformVersion(callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class getPlatformVersionExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new VersionsApi();

            try {
                // Get platform version
                'String' result = apiInstance.getPlatformVersion();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VersionsApi.getPlatformVersion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VersionsApi();

try {
    $result = $api_instance->getPlatformVersion();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VersionsApi->getPlatformVersion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VersionsApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VersionsApi->new();

eval {
    my $result = $api_instance->getPlatformVersion();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VersionsApi->getPlatformVersion: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.VersionsApi()

try:
    # Get platform version
    api_response = api_instance.get_platform_version()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VersionsApi->getPlatformVersion: %s\n" % e)
extern crate VersionsApi;

pub fn main() {

    let mut context = VersionsApi::Context::default();
    let result = client.getPlatformVersion(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


Webhooks

createWebhook

Create a webhook for a test.


/api/v1/webhooks/test/{testId}

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: application/json,application/xml" \
 "http://localhost:8082/api/v1/webhooks/test/{testId}" \
 -d '{
  "settings" : {
    "contentType" : "contentType",
    "events" : [ "events", "events" ]
  },
  "secret" : "secret",
  "enabled" : true,
  "url" : "url"
}' \
 -d '<WebhookRequest>
  <enabled>true</enabled>
  <secret>aeiou</secret>
  <url>aeiou</url>
</WebhookRequest>'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.WebhooksApi;

import java.io.File;
import java.util.*;

public class WebhooksApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        WebhooksApi apiInstance = new WebhooksApi();
        Long testId = 789; // Long | The test ID.
        WebhookRequest hook = ; // WebhookRequest | 

        try {
            WebhookResponse result = apiInstance.createWebhook(testId, hook);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhooksApi#createWebhook");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.WebhooksApi;

public class WebhooksApiExample {
    public static void main(String[] args) {
        WebhooksApi apiInstance = new WebhooksApi();
        Long testId = 789; // Long | The test ID.
        WebhookRequest hook = ; // WebhookRequest | 

        try {
            WebhookResponse result = apiInstance.createWebhook(testId, hook);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhooksApi#createWebhook");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
WebhooksApi *apiInstance = [[WebhooksApi alloc] init];
Long *testId = 789; // The test ID. (default to null)
WebhookRequest *hook = ; // 

// Create a webhook for a test.
[apiInstance createWebhookWith:testId
    hook:hook
              completionHandler: ^(WebhookResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.WebhooksApi()
var testId = 789; // {Long} The test ID.
var hook = ; // {WebhookRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createWebhook(testId, hook, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class createWebhookExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new WebhooksApi();
            var testId = 789;  // Long | The test ID. (default to null)
            var hook = new WebhookRequest(); // WebhookRequest | 

            try {
                // Create a webhook for a test.
                WebhookResponse result = apiInstance.createWebhook(testId, hook);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling WebhooksApi.createWebhook: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\WebhooksApi();
$testId = 789; // Long | The test ID.
$hook = ; // WebhookRequest | 

try {
    $result = $api_instance->createWebhook($testId, $hook);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebhooksApi->createWebhook: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::WebhooksApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::WebhooksApi->new();
my $testId = 789; # Long | The test ID.
my $hook = WWW::OPenAPIClient::Object::WebhookRequest->new(); # WebhookRequest | 

eval {
    my $result = $api_instance->createWebhook(testId => $testId, hook => $hook);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebhooksApi->createWebhook: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.WebhooksApi()
testId = 789 # Long | The test ID. (default to null)
hook =  # WebhookRequest | 

try:
    # Create a webhook for a test.
    api_response = api_instance.create_webhook(testId, hook)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebhooksApi->createWebhook: %s\n" % e)
extern crate WebhooksApi;

pub fn main() {
    let testId = 789; // Long
    let hook = ; // WebhookRequest

    let mut context = WebhooksApi::Context::default();
    let result = client.createWebhook(testId, hook, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
testId*
Long (int64)
The test ID.
Required
Body parameters
Name Description
hook *

The test hook object.

Responses


deleteWebhook

Delete a webhook.


/api/v1/webhooks/{hookId}

Usage and SDK Samples

curl -X DELETE \
-H "Authorization: [[apiKey]]" \
 "http://localhost:8082/api/v1/webhooks/{hookId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.WebhooksApi;

import java.io.File;
import java.util.*;

public class WebhooksApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        WebhooksApi apiInstance = new WebhooksApi();
        Long hookId = 789; // Long | The hook ID.

        try {
            apiInstance.deleteWebhook(hookId);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhooksApi#deleteWebhook");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.WebhooksApi;

public class WebhooksApiExample {
    public static void main(String[] args) {
        WebhooksApi apiInstance = new WebhooksApi();
        Long hookId = 789; // Long | The hook ID.

        try {
            apiInstance.deleteWebhook(hookId);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhooksApi#deleteWebhook");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
WebhooksApi *apiInstance = [[WebhooksApi alloc] init];
Long *hookId = 789; // The hook ID. (default to null)

// Delete a webhook.
[apiInstance deleteWebhookWith:hookId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.WebhooksApi()
var hookId = 789; // {Long} The hook ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteWebhook(hookId, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class deleteWebhookExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new WebhooksApi();
            var hookId = 789;  // Long | The hook ID. (default to null)

            try {
                // Delete a webhook.
                apiInstance.deleteWebhook(hookId);
            } catch (Exception e) {
                Debug.Print("Exception when calling WebhooksApi.deleteWebhook: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\WebhooksApi();
$hookId = 789; // Long | The hook ID.

try {
    $api_instance->deleteWebhook($hookId);
} catch (Exception $e) {
    echo 'Exception when calling WebhooksApi->deleteWebhook: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::WebhooksApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::WebhooksApi->new();
my $hookId = 789; # Long | The hook ID.

eval {
    $api_instance->deleteWebhook(hookId => $hookId);
};
if ($@) {
    warn "Exception when calling WebhooksApi->deleteWebhook: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.WebhooksApi()
hookId = 789 # Long | The hook ID. (default to null)

try:
    # Delete a webhook.
    api_instance.delete_webhook(hookId)
except ApiException as e:
    print("Exception when calling WebhooksApi->deleteWebhook: %s\n" % e)
extern crate WebhooksApi;

pub fn main() {
    let hookId = 789; // Long

    let mut context = WebhooksApi::Context::default();
    let result = client.deleteWebhook(hookId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
hookId*
Long (int64)
The hook ID.
Required

Responses


getWebhook

Get a webhook.


/api/v1/webhooks/{webhookId}

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/webhooks/{webhookId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.WebhooksApi;

import java.io.File;
import java.util.*;

public class WebhooksApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        WebhooksApi apiInstance = new WebhooksApi();
        Long webhookId = 789; // Long | The Webhook ID.

        try {
            WebhookResponse result = apiInstance.getWebhook(webhookId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhooksApi#getWebhook");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.WebhooksApi;

public class WebhooksApiExample {
    public static void main(String[] args) {
        WebhooksApi apiInstance = new WebhooksApi();
        Long webhookId = 789; // Long | The Webhook ID.

        try {
            WebhookResponse result = apiInstance.getWebhook(webhookId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhooksApi#getWebhook");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
WebhooksApi *apiInstance = [[WebhooksApi alloc] init];
Long *webhookId = 789; // The Webhook ID. (default to null)

// Get a webhook.
[apiInstance getWebhookWith:webhookId
              completionHandler: ^(WebhookResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.WebhooksApi()
var webhookId = 789; // {Long} The Webhook ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getWebhook(webhookId, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class getWebhookExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new WebhooksApi();
            var webhookId = 789;  // Long | The Webhook ID. (default to null)

            try {
                // Get a webhook.
                WebhookResponse result = apiInstance.getWebhook(webhookId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling WebhooksApi.getWebhook: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\WebhooksApi();
$webhookId = 789; // Long | The Webhook ID.

try {
    $result = $api_instance->getWebhook($webhookId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebhooksApi->getWebhook: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::WebhooksApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::WebhooksApi->new();
my $webhookId = 789; # Long | The Webhook ID.

eval {
    my $result = $api_instance->getWebhook(webhookId => $webhookId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebhooksApi->getWebhook: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.WebhooksApi()
webhookId = 789 # Long | The Webhook ID. (default to null)

try:
    # Get a webhook.
    api_response = api_instance.get_webhook(webhookId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebhooksApi->getWebhook: %s\n" % e)
extern crate WebhooksApi;

pub fn main() {
    let webhookId = 789; // Long

    let mut context = WebhooksApi::Context::default();
    let result = client.getWebhook(webhookId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
webhookId*
Long (int64)
The Webhook ID.
Required

Responses


getWebhooks

Get all webhooks defined for a test.


/api/v1/webhooks/test/{testId}

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 "http://localhost:8082/api/v1/webhooks/test/{testId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.WebhooksApi;

import java.io.File;
import java.util.*;

public class WebhooksApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        WebhooksApi apiInstance = new WebhooksApi();
        Long testId = 789; // Long | The test ID.

        try {
            array[WebhookResponse] result = apiInstance.getWebhooks(testId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhooksApi#getWebhooks");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.WebhooksApi;

public class WebhooksApiExample {
    public static void main(String[] args) {
        WebhooksApi apiInstance = new WebhooksApi();
        Long testId = 789; // Long | The test ID.

        try {
            array[WebhookResponse] result = apiInstance.getWebhooks(testId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhooksApi#getWebhooks");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
WebhooksApi *apiInstance = [[WebhooksApi alloc] init];
Long *testId = 789; // The test ID. (default to null)

// Get all webhooks defined for a test.
[apiInstance getWebhooksWith:testId
              completionHandler: ^(array[WebhookResponse] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.WebhooksApi()
var testId = 789; // {Long} The test ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getWebhooks(testId, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class getWebhooksExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new WebhooksApi();
            var testId = 789;  // Long | The test ID. (default to null)

            try {
                // Get all webhooks defined for a test.
                array[WebhookResponse] result = apiInstance.getWebhooks(testId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling WebhooksApi.getWebhooks: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\WebhooksApi();
$testId = 789; // Long | The test ID.

try {
    $result = $api_instance->getWebhooks($testId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebhooksApi->getWebhooks: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::WebhooksApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::WebhooksApi->new();
my $testId = 789; # Long | The test ID.

eval {
    my $result = $api_instance->getWebhooks(testId => $testId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebhooksApi->getWebhooks: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.WebhooksApi()
testId = 789 # Long | The test ID. (default to null)

try:
    # Get all webhooks defined for a test.
    api_response = api_instance.get_webhooks(testId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebhooksApi->getWebhooks: %s\n" % e)
extern crate WebhooksApi;

pub fn main() {
    let testId = 789; // Long

    let mut context = WebhooksApi::Context::default();
    let result = client.getWebhooks(testId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
testId*
Long (int64)
The test ID.
Required

Responses


updateWebhook

Update a webhook.


/api/v1/webhooks/{hookId}

Usage and SDK Samples

curl -X PUT \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json,application/xml" \
 -H "Content-Type: application/json,application/xml" \
 "http://localhost:8082/api/v1/webhooks/{hookId}" \
 -d '{
  "settings" : {
    "contentType" : "contentType",
    "events" : [ "events", "events" ]
  },
  "secret" : "secret",
  "enabled" : true,
  "url" : "url"
}' \
 -d '<WebhookRequest>
  <enabled>true</enabled>
  <secret>aeiou</secret>
  <url>aeiou</url>
</WebhookRequest>'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.WebhooksApi;

import java.io.File;
import java.util.*;

public class WebhooksApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        // Create an instance of the API class
        WebhooksApi apiInstance = new WebhooksApi();
        Long hookId = 789; // Long | The hook ID.
        WebhookRequest hook = ; // WebhookRequest | 

        try {
            WebhookResponse result = apiInstance.updateWebhook(hookId, hook);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhooksApi#updateWebhook");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.WebhooksApi;

public class WebhooksApiExample {
    public static void main(String[] args) {
        WebhooksApi apiInstance = new WebhooksApi();
        Long hookId = 789; // Long | The hook ID.
        WebhookRequest hook = ; // WebhookRequest | 

        try {
            WebhookResponse result = apiInstance.updateWebhook(hookId, hook);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhooksApi#updateWebhook");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
WebhooksApi *apiInstance = [[WebhooksApi alloc] init];
Long *hookId = 789; // The hook ID. (default to null)
WebhookRequest *hook = ; // 

// Update a webhook.
[apiInstance updateWebhookWith:hookId
    hook:hook
              completionHandler: ^(WebhookResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var GuardAiPlatformApi = require('guard_ai_platform_api');
var defaultClient = GuardAiPlatformApi.ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new GuardAiPlatformApi.WebhooksApi()
var hookId = 789; // {Long} The hook ID.
var hook = ; // {WebhookRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateWebhook(hookId, hook, callback);
using System;
using System.Diagnostics;
using guardai_api.Api;
using guardai_api.Client;
using guardai_api.Model;

namespace Example
{
    public class updateWebhookExample
    {
        public void main()
        {
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new WebhooksApi();
            var hookId = 789;  // Long | The hook ID. (default to null)
            var hook = new WebhookRequest(); // WebhookRequest | 

            try {
                // Update a webhook.
                WebhookResponse result = apiInstance.updateWebhook(hookId, hook);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling WebhooksApi.updateWebhook: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\WebhooksApi();
$hookId = 789; // Long | The hook ID.
$hook = ; // WebhookRequest | 

try {
    $result = $api_instance->updateWebhook($hookId, $hook);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebhooksApi->updateWebhook: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::WebhooksApi;

# Configure API key authorization: JWT
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::WebhooksApi->new();
my $hookId = 789; # Long | The hook ID.
my $hook = WWW::OPenAPIClient::Object::WebhookRequest->new(); # WebhookRequest | 

eval {
    my $result = $api_instance->updateWebhook(hookId => $hookId, hook => $hook);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebhooksApi->updateWebhook: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.WebhooksApi()
hookId = 789 # Long | The hook ID. (default to null)
hook =  # WebhookRequest | 

try:
    # Update a webhook.
    api_response = api_instance.update_webhook(hookId, hook)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebhooksApi->updateWebhook: %s\n" % e)
extern crate WebhooksApi;

pub fn main() {
    let hookId = 789; // Long
    let hook = ; // WebhookRequest

    let mut context = WebhooksApi::Context::default();
    let result = client.updateWebhook(hookId, hook, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
hookId*
Long (int64)
The hook ID.
Required
Body parameters
Name Description
hook *

The test hook object.

Responses