Cydarm API

Acl

createAcl

Creates an ACL.


/acl

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/acl"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AclApi;

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

public class AclApiExample {

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

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

        AclApi apiInstance = new AclApi();
        Acl body = ; // Acl | The ACL to create
        try {
            acl result = apiInstance.createAcl(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AclApi#createAcl");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AclApi;

public class AclApiExample {

    public static void main(String[] args) {
        AclApi apiInstance = new AclApi();
        Acl body = ; // Acl | The ACL to create
        try {
            acl result = apiInstance.createAcl(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AclApi#createAcl");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
Acl *body = ; // The ACL to create

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

// Creates an ACL.
[apiInstance createAclWith:body
              completionHandler: ^(acl output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.AclApi()
var body = ; // {{Acl}} The ACL to create

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

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

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

            var apiInstance = new AclApi();
            var body = new Acl(); // Acl | The ACL to create

            try
            {
                // Creates an ACL.
                acl result = apiInstance.createAcl(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AclApi.createAcl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAclApi();
$body = ; // Acl | The ACL to create

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

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

my $api_instance = WWW::SwaggerClient::AclApi->new();
my $body = WWW::SwaggerClient::Object::Acl->new(); # Acl | The ACL to create

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AclApi()
body =  # Acl | The ACL to create

try: 
    # Creates an ACL.
    api_response = api_instance.create_acl(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AclApi->createAcl: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - The ACL already exists.

Status: 201 - The request has succeeded and the new ACL has been created.

Status: default - Internal Server Error


deleteAcl

Deletes an ACL.


/acl/{aclUuid}

Usage and SDK Samples

curl -X DELETE\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/acl/{aclUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AclApi;

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

public class AclApiExample {

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

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

        AclApi apiInstance = new AclApi();
        String aclUuid = aclUuid_example; // String | The UUID of the ACL to delete.
        try {
            apiInstance.deleteAcl(aclUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling AclApi#deleteAcl");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AclApi;

public class AclApiExample {

    public static void main(String[] args) {
        AclApi apiInstance = new AclApi();
        String aclUuid = aclUuid_example; // String | The UUID of the ACL to delete.
        try {
            apiInstance.deleteAcl(aclUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling AclApi#deleteAcl");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *aclUuid = aclUuid_example; // The UUID of the ACL to delete.

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

// Deletes an ACL.
[apiInstance deleteAclWith:aclUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.AclApi()
var aclUuid = aclUuid_example; // {{String}} The UUID of the ACL to delete.

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

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

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

            var apiInstance = new AclApi();
            var aclUuid = aclUuid_example;  // String | The UUID of the ACL to delete.

            try
            {
                // Deletes an ACL.
                apiInstance.deleteAcl(aclUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AclApi.deleteAcl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAclApi();
$aclUuid = aclUuid_example; // String | The UUID of the ACL to delete.

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

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

my $api_instance = WWW::SwaggerClient::AclApi->new();
my $aclUuid = aclUuid_example; # String | The UUID of the ACL to delete.

eval { 
    $api_instance->deleteAcl(aclUuid => $aclUuid);
};
if ($@) {
    warn "Exception when calling AclApi->deleteAcl: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AclApi()
aclUuid = aclUuid_example # String | The UUID of the ACL to delete.

try: 
    # Deletes an ACL.
    api_instance.delete_acl(aclUuid)
except ApiException as e:
    print("Exception when calling AclApi->deleteAcl: %s\n" % e)

Parameters

Path parameters
Name Description
aclUuid*
String
The UUID of the ACL to delete.
Required

Responses

Status: 204 - The ACL was deleted successfully.

Status: default - Internal Server Error


getAcl

Gets an ACL.


/acl/{aclUuid}

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/acl/{aclUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AclApi;

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

public class AclApiExample {

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

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

        AclApi apiInstance = new AclApi();
        String aclUuid = aclUuid_example; // String | The UUID of the ACL to retrieve.
        try {
            acl result = apiInstance.getAcl(aclUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AclApi#getAcl");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AclApi;

public class AclApiExample {

    public static void main(String[] args) {
        AclApi apiInstance = new AclApi();
        String aclUuid = aclUuid_example; // String | The UUID of the ACL to retrieve.
        try {
            acl result = apiInstance.getAcl(aclUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AclApi#getAcl");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *aclUuid = aclUuid_example; // The UUID of the ACL to retrieve.

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

// Gets an ACL.
[apiInstance getAclWith:aclUuid
              completionHandler: ^(acl output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.AclApi()
var aclUuid = aclUuid_example; // {{String}} The UUID of the ACL to retrieve.

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

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

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

            var apiInstance = new AclApi();
            var aclUuid = aclUuid_example;  // String | The UUID of the ACL to retrieve.

            try
            {
                // Gets an ACL.
                acl result = apiInstance.getAcl(aclUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AclApi.getAcl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAclApi();
$aclUuid = aclUuid_example; // String | The UUID of the ACL to retrieve.

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

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

my $api_instance = WWW::SwaggerClient::AclApi->new();
my $aclUuid = aclUuid_example; # String | The UUID of the ACL to retrieve.

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AclApi()
aclUuid = aclUuid_example # String | The UUID of the ACL to retrieve.

try: 
    # Gets an ACL.
    api_response = api_instance.get_acl(aclUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AclApi->getAcl: %s\n" % e)

Parameters

Path parameters
Name Description
aclUuid*
String
The UUID of the ACL to retrieve.
Required

Responses

Status: 200 - Fetched ACL and transmitted in the message body.

Status: default - Internal Server Error


getAcls

Gets a list of ACLs.


/acl

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/acl"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AclApi;

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

public class AclApiExample {

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

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

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

public class AclApiExample {

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

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

// Gets a list of ACLs.
[apiInstance getAclsWithCompletionHandler: 
              ^(array[acl] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.AclApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAcls(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new AclApi();

            try
            {
                // Gets a list of ACLs.
                array[acl] result = apiInstance.getAcls();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AclApi.getAcls: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

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

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

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AclApi()

try: 
    # Gets a list of ACLs.
    api_response = api_instance.get_acls()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AclApi->getAcls: %s\n" % e)

Parameters

Responses

Status: 200 - Fetched list of ACLs and transmitted in the message body.

Status: default - Internal Server Error


getDefaultAclForSession

Gets the default ACL for the current session.


/acl/session/{sessionUuid}

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/acl/session/{sessionUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AclApi;

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

public class AclApiExample {

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

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

        AclApi apiInstance = new AclApi();
        String sessionUuid = sessionUuid_example; // String | The UUID of the session to retrieve.
        try {
            acl result = apiInstance.getDefaultAclForSession(sessionUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AclApi#getDefaultAclForSession");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AclApi;

public class AclApiExample {

    public static void main(String[] args) {
        AclApi apiInstance = new AclApi();
        String sessionUuid = sessionUuid_example; // String | The UUID of the session to retrieve.
        try {
            acl result = apiInstance.getDefaultAclForSession(sessionUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AclApi#getDefaultAclForSession");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *sessionUuid = sessionUuid_example; // The UUID of the session to retrieve.

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

// Gets the default ACL for the current session.
[apiInstance getDefaultAclForSessionWith:sessionUuid
              completionHandler: ^(acl output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.AclApi()
var sessionUuid = sessionUuid_example; // {{String}} The UUID of the session to retrieve.

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

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

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

            var apiInstance = new AclApi();
            var sessionUuid = sessionUuid_example;  // String | The UUID of the session to retrieve.

            try
            {
                // Gets the default ACL for the current session.
                acl result = apiInstance.getDefaultAclForSession(sessionUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AclApi.getDefaultAclForSession: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAclApi();
$sessionUuid = sessionUuid_example; // String | The UUID of the session to retrieve.

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

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

my $api_instance = WWW::SwaggerClient::AclApi->new();
my $sessionUuid = sessionUuid_example; # String | The UUID of the session to retrieve.

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AclApi()
sessionUuid = sessionUuid_example # String | The UUID of the session to retrieve.

try: 
    # Gets the default ACL for the current session.
    api_response = api_instance.get_default_acl_for_session(sessionUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AclApi->getDefaultAclForSession: %s\n" % e)

Parameters

Path parameters
Name Description
sessionUuid*
String
The UUID of the session to retrieve.
Required

Responses

Status: 200 - Fetched default ACL and transmitted in the message body.

Status: default - Internal Server Error


searchAcl

Searches for ACLs.


/acl/search

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/acl/search"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AclApi;

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

public class AclApiExample {

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

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

        AclApi apiInstance = new AclApi();
        Acl body = ; // Acl | The ACL to search for
        try {
            acl result = apiInstance.searchAcl(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AclApi#searchAcl");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AclApi;

public class AclApiExample {

    public static void main(String[] args) {
        AclApi apiInstance = new AclApi();
        Acl body = ; // Acl | The ACL to search for
        try {
            acl result = apiInstance.searchAcl(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AclApi#searchAcl");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
Acl *body = ; // The ACL to search for

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

// Searches for ACLs.
[apiInstance searchAclWith:body
              completionHandler: ^(acl output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.AclApi()
var body = ; // {{Acl}} The ACL to search for

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

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

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

            var apiInstance = new AclApi();
            var body = new Acl(); // Acl | The ACL to search for

            try
            {
                // Searches for ACLs.
                acl result = apiInstance.searchAcl(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AclApi.searchAcl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAclApi();
$body = ; // Acl | The ACL to search for

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

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

my $api_instance = WWW::SwaggerClient::AclApi->new();
my $body = WWW::SwaggerClient::Object::Acl->new(); # Acl | The ACL to search for

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AclApi()
body =  # Acl | The ACL to search for

try: 
    # Searches for ACLs.
    api_response = api_instance.search_acl(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AclApi->searchAcl: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - The ACL exists.

Status: 404 - The ACL does not exist.

Status: default - Internal Server Error


Actuator

actuatorHeartbeat

Sets the actuator's last heartbeat time


/actuator/{actuatorId}/heartbeat

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/actuator/{actuatorId}/heartbeat"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ActuatorApi;

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

public class ActuatorApiExample {

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

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

        ActuatorApi apiInstance = new ActuatorApi();
        String actuatorId = actuatorId_example; // String | The id of the actuator
        try {
            apiInstance.actuatorHeartbeat(actuatorId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActuatorApi#actuatorHeartbeat");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ActuatorApi;

public class ActuatorApiExample {

    public static void main(String[] args) {
        ActuatorApi apiInstance = new ActuatorApi();
        String actuatorId = actuatorId_example; // String | The id of the actuator
        try {
            apiInstance.actuatorHeartbeat(actuatorId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActuatorApi#actuatorHeartbeat");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *actuatorId = actuatorId_example; // The id of the actuator

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

[apiInstance actuatorHeartbeatWith:actuatorId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.ActuatorApi()
var actuatorId = actuatorId_example; // {{String}} The id of the actuator

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

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

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

            var apiInstance = new ActuatorApi();
            var actuatorId = actuatorId_example;  // String | The id of the actuator

            try
            {
                apiInstance.actuatorHeartbeat(actuatorId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ActuatorApi.actuatorHeartbeat: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiActuatorApi();
$actuatorId = actuatorId_example; // String | The id of the actuator

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

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

my $api_instance = WWW::SwaggerClient::ActuatorApi->new();
my $actuatorId = actuatorId_example; # String | The id of the actuator

eval { 
    $api_instance->actuatorHeartbeat(actuatorId => $actuatorId);
};
if ($@) {
    warn "Exception when calling ActuatorApi->actuatorHeartbeat: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ActuatorApi()
actuatorId = actuatorId_example # String | The id of the actuator

try: 
    api_instance.actuator_heartbeat(actuatorId)
except ApiException as e:
    print("Exception when calling ActuatorApi->actuatorHeartbeat: %s\n" % e)

Parameters

Path parameters
Name Description
actuatorId*
String
The id of the actuator
Required

Responses

Status: 204 - The actuator heartbeat has been updated successfully.

Status: default - Internal Server Error


createActuator

Creates an actuator


/actuator

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/actuator"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ActuatorApi;

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

public class ActuatorApiExample {

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

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

        ActuatorApi apiInstance = new ActuatorApi();
        CreateActuatorRequest body = ; // CreateActuatorRequest | The actuator to create.
        try {
            createResponse result = apiInstance.createActuator(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActuatorApi#createActuator");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ActuatorApi;

public class ActuatorApiExample {

    public static void main(String[] args) {
        ActuatorApi apiInstance = new ActuatorApi();
        CreateActuatorRequest body = ; // CreateActuatorRequest | The actuator to create.
        try {
            createResponse result = apiInstance.createActuator(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActuatorApi#createActuator");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
CreateActuatorRequest *body = ; // The actuator to create.

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

[apiInstance createActuatorWith:body
              completionHandler: ^(createResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.ActuatorApi()
var body = ; // {{CreateActuatorRequest}} The actuator to create.

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

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

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

            var apiInstance = new ActuatorApi();
            var body = new CreateActuatorRequest(); // CreateActuatorRequest | The actuator to create.

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

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

$api_instance = new Swagger\Client\ApiActuatorApi();
$body = ; // CreateActuatorRequest | The actuator to create.

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

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

my $api_instance = WWW::SwaggerClient::ActuatorApi->new();
my $body = WWW::SwaggerClient::Object::CreateActuatorRequest->new(); # CreateActuatorRequest | The actuator to create.

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ActuatorApi()
body =  # CreateActuatorRequest | The actuator to create.

try: 
    api_response = api_instance.create_actuator(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ActuatorApi->createActuator: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - The actuator has been created successfully.

Status: default - Internal Server Error


getActuator

Gets specified actuator


/actuator/{actuatorId}

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/actuator/{actuatorId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ActuatorApi;

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

public class ActuatorApiExample {

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

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

        ActuatorApi apiInstance = new ActuatorApi();
        String actuatorId = actuatorId_example; // String | The id of the actuator
        try {
            actuator result = apiInstance.getActuator(actuatorId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActuatorApi#getActuator");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ActuatorApi;

public class ActuatorApiExample {

    public static void main(String[] args) {
        ActuatorApi apiInstance = new ActuatorApi();
        String actuatorId = actuatorId_example; // String | The id of the actuator
        try {
            actuator result = apiInstance.getActuator(actuatorId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActuatorApi#getActuator");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *actuatorId = actuatorId_example; // The id of the actuator

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

[apiInstance getActuatorWith:actuatorId
              completionHandler: ^(actuator output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.ActuatorApi()
var actuatorId = actuatorId_example; // {{String}} The id of the actuator

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

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

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

            var apiInstance = new ActuatorApi();
            var actuatorId = actuatorId_example;  // String | The id of the actuator

            try
            {
                actuator result = apiInstance.getActuator(actuatorId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ActuatorApi.getActuator: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiActuatorApi();
$actuatorId = actuatorId_example; // String | The id of the actuator

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

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

my $api_instance = WWW::SwaggerClient::ActuatorApi->new();
my $actuatorId = actuatorId_example; # String | The id of the actuator

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ActuatorApi()
actuatorId = actuatorId_example # String | The id of the actuator

try: 
    api_response = api_instance.get_actuator(actuatorId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ActuatorApi->getActuator: %s\n" % e)

Parameters

Path parameters
Name Description
actuatorId*
String
The id of the actuator
Required

Responses

Status: 200 - Fetched the actuators and transmitted in the message body.

Status: default - Internal Server Error


getActuators

Gets all actuators


/actuator

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/actuator"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ActuatorApi;

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

public class ActuatorApiExample {

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

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

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

public class ActuatorApiExample {

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

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

[apiInstance getActuatorsWithCompletionHandler: 
              ^(array[actuator] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.ActuatorApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getActuators(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new ActuatorApi();

            try
            {
                array[actuator] result = apiInstance.getActuators();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ActuatorApi.getActuators: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

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

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

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ActuatorApi()

try: 
    api_response = api_instance.get_actuators()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ActuatorApi->getActuators: %s\n" % e)

Parameters

Responses

Status: 200 - Fetched the list of actuators s and transmitted in the message body.

Status: default - Internal Server Error


updateActuator

Updates the specified actuator


/actuator/{actuatorId}

Usage and SDK Samples

curl -X PUT\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/actuator/{actuatorId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ActuatorApi;

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

public class ActuatorApiExample {

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

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

        ActuatorApi apiInstance = new ActuatorApi();
        UpdateActuatorRequest body = ; // UpdateActuatorRequest | The updated actuator request.
        String actuatorId = actuatorId_example; // String | The id of the actuator to update.
        try {
            actuator result = apiInstance.updateActuator(body, actuatorId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActuatorApi#updateActuator");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ActuatorApi;

public class ActuatorApiExample {

    public static void main(String[] args) {
        ActuatorApi apiInstance = new ActuatorApi();
        UpdateActuatorRequest body = ; // UpdateActuatorRequest | The updated actuator request.
        String actuatorId = actuatorId_example; // String | The id of the actuator to update.
        try {
            actuator result = apiInstance.updateActuator(body, actuatorId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActuatorApi#updateActuator");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
UpdateActuatorRequest *body = ; // The updated actuator request.
String *actuatorId = actuatorId_example; // The id of the actuator to update.

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

[apiInstance updateActuatorWith:body
    actuatorId:actuatorId
              completionHandler: ^(actuator output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.ActuatorApi()
var body = ; // {{UpdateActuatorRequest}} The updated actuator request.
var actuatorId = actuatorId_example; // {{String}} The id of the actuator to update.

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

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

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

            var apiInstance = new ActuatorApi();
            var body = new UpdateActuatorRequest(); // UpdateActuatorRequest | The updated actuator request.
            var actuatorId = actuatorId_example;  // String | The id of the actuator to update.

            try
            {
                actuator result = apiInstance.updateActuator(body, actuatorId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ActuatorApi.updateActuator: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiActuatorApi();
$body = ; // UpdateActuatorRequest | The updated actuator request.
$actuatorId = actuatorId_example; // String | The id of the actuator to update.

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

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

my $api_instance = WWW::SwaggerClient::ActuatorApi->new();
my $body = WWW::SwaggerClient::Object::UpdateActuatorRequest->new(); # UpdateActuatorRequest | The updated actuator request.
my $actuatorId = actuatorId_example; # String | The id of the actuator to update.

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ActuatorApi()
body =  # UpdateActuatorRequest | The updated actuator request.
actuatorId = actuatorId_example # String | The id of the actuator to update.

try: 
    api_response = api_instance.update_actuator(body, actuatorId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ActuatorApi->updateActuator: %s\n" % e)

Parameters

Path parameters
Name Description
actuatorId*
String
The id of the actuator to update.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - Updated the actuator

Status: default - Internal Server Error


Auth

deleteTotpConfig

Delete user TOTP information


/auth/totp/{userUuid}

Usage and SDK Samples

curl -X DELETE\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/auth/totp/{userUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthApi;

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

public class AuthApiExample {

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

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

        AuthApi apiInstance = new AuthApi();
        String userUuid = userUuid_example; // String | The UUID of the user to delete TOTP config.
        try {
            apiInstance.deleteTotpConfig(userUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#deleteTotpConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthApi;

public class AuthApiExample {

    public static void main(String[] args) {
        AuthApi apiInstance = new AuthApi();
        String userUuid = userUuid_example; // String | The UUID of the user to delete TOTP config.
        try {
            apiInstance.deleteTotpConfig(userUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#deleteTotpConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *userUuid = userUuid_example; // The UUID of the user to delete TOTP config.

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

[apiInstance deleteTotpConfigWith:userUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.AuthApi()
var userUuid = userUuid_example; // {{String}} The UUID of the user to delete TOTP config.

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

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

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

            var apiInstance = new AuthApi();
            var userUuid = userUuid_example;  // String | The UUID of the user to delete TOTP config.

            try
            {
                apiInstance.deleteTotpConfig(userUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthApi.deleteTotpConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAuthApi();
$userUuid = userUuid_example; // String | The UUID of the user to delete TOTP config.

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

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

my $api_instance = WWW::SwaggerClient::AuthApi->new();
my $userUuid = userUuid_example; # String | The UUID of the user to delete TOTP config.

eval { 
    $api_instance->deleteTotpConfig(userUuid => $userUuid);
};
if ($@) {
    warn "Exception when calling AuthApi->deleteTotpConfig: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AuthApi()
userUuid = userUuid_example # String | The UUID of the user to delete TOTP config.

try: 
    api_instance.delete_totp_config(userUuid)
except ApiException as e:
    print("Exception when calling AuthApi->deleteTotpConfig: %s\n" % e)

Parameters

Path parameters
Name Description
userUuid*
String
The UUID of the user to delete TOTP config.
Required

Responses

Status: 204 - The resource was deleted successfully.

Status: 400 - User has TOTP enrolled

Status: default - Internal Server Error


doAuthRefresh

Refresh session authorization


/auth/refresh

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/auth/refresh"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthApi;

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

public class AuthApiExample {

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

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

        AuthApi apiInstance = new AuthApi();
        String xCydarmAuthz = xCydarmAuthz_example; // String | The Cydarm-derived JWT to refresh, as a token
        try {
            sessionDetails result = apiInstance.doAuthRefresh(xCydarmAuthz);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#doAuthRefresh");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthApi;

public class AuthApiExample {

    public static void main(String[] args) {
        AuthApi apiInstance = new AuthApi();
        String xCydarmAuthz = xCydarmAuthz_example; // String | The Cydarm-derived JWT to refresh, as a token
        try {
            sessionDetails result = apiInstance.doAuthRefresh(xCydarmAuthz);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#doAuthRefresh");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *xCydarmAuthz = xCydarmAuthz_example; // The Cydarm-derived JWT to refresh, as a token

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

[apiInstance doAuthRefreshWith:xCydarmAuthz
              completionHandler: ^(sessionDetails output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.AuthApi()
var xCydarmAuthz = xCydarmAuthz_example; // {{String}} The Cydarm-derived JWT to refresh, as a token

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

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

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

            var apiInstance = new AuthApi();
            var xCydarmAuthz = xCydarmAuthz_example;  // String | The Cydarm-derived JWT to refresh, as a token

            try
            {
                sessionDetails result = apiInstance.doAuthRefresh(xCydarmAuthz);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthApi.doAuthRefresh: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAuthApi();
$xCydarmAuthz = xCydarmAuthz_example; // String | The Cydarm-derived JWT to refresh, as a token

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

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

my $api_instance = WWW::SwaggerClient::AuthApi->new();
my $xCydarmAuthz = xCydarmAuthz_example; # String | The Cydarm-derived JWT to refresh, as a token

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AuthApi()
xCydarmAuthz = xCydarmAuthz_example # String | The Cydarm-derived JWT to refresh, as a token

try: 
    api_response = api_instance.do_auth_refresh(xCydarmAuthz)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->doAuthRefresh: %s\n" % e)

Parameters

Header parameters
Name Description
X-Cydarm-Authz*
String
The Cydarm-derived JWT to refresh, as a token
Required

Responses

Status: 200 - Successfully authenticated.

Name Type Format Description
Access-Token String

Status: 401 - Authentication failed.

Status: default - Internal Server Error


doAuthWithJwt

Creates a session using a JWT from an external source


/auth/jwt

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/auth/jwt"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthApi;

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

public class AuthApiExample {

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

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

        AuthApi apiInstance = new AuthApi();
        String xCydarmAuthz = xCydarmAuthz_example; // String | The external JWT to authenticate with, as a token
        try {
            createResponse result = apiInstance.doAuthWithJwt(xCydarmAuthz);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#doAuthWithJwt");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthApi;

public class AuthApiExample {

    public static void main(String[] args) {
        AuthApi apiInstance = new AuthApi();
        String xCydarmAuthz = xCydarmAuthz_example; // String | The external JWT to authenticate with, as a token
        try {
            createResponse result = apiInstance.doAuthWithJwt(xCydarmAuthz);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#doAuthWithJwt");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *xCydarmAuthz = xCydarmAuthz_example; // The external JWT to authenticate with, as a token

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

[apiInstance doAuthWithJwtWith:xCydarmAuthz
              completionHandler: ^(createResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.AuthApi()
var xCydarmAuthz = xCydarmAuthz_example; // {{String}} The external JWT to authenticate with, as a token

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

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

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

            var apiInstance = new AuthApi();
            var xCydarmAuthz = xCydarmAuthz_example;  // String | The external JWT to authenticate with, as a token

            try
            {
                createResponse result = apiInstance.doAuthWithJwt(xCydarmAuthz);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthApi.doAuthWithJwt: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAuthApi();
$xCydarmAuthz = xCydarmAuthz_example; // String | The external JWT to authenticate with, as a token

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

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

my $api_instance = WWW::SwaggerClient::AuthApi->new();
my $xCydarmAuthz = xCydarmAuthz_example; # String | The external JWT to authenticate with, as a token

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AuthApi()
xCydarmAuthz = xCydarmAuthz_example # String | The external JWT to authenticate with, as a token

try: 
    api_response = api_instance.do_auth_with_jwt(xCydarmAuthz)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->doAuthWithJwt: %s\n" % e)

Parameters

Header parameters
Name Description
X-Cydarm-Authz*
String
The external JWT to authenticate with, as a token
Required

Responses

Status: 200 - Successfully authenticated.

Name Type Format Description
Access-Token String

Status: 401 - Authentication failed.

Status: default - Internal Server Error


doAuthWithPassword

Creates a session by using username and password in the request body


/auth/password

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/auth/password"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthApi;

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

public class AuthApiExample {

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

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

        AuthApi apiInstance = new AuthApi();
        AuthCredentialsRequest body = ; // AuthCredentialsRequest | The base64 encoded user's credentials
        try {
            sessionDetails result = apiInstance.doAuthWithPassword(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#doAuthWithPassword");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthApi;

public class AuthApiExample {

    public static void main(String[] args) {
        AuthApi apiInstance = new AuthApi();
        AuthCredentialsRequest body = ; // AuthCredentialsRequest | The base64 encoded user's credentials
        try {
            sessionDetails result = apiInstance.doAuthWithPassword(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#doAuthWithPassword");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
AuthCredentialsRequest *body = ; // The base64 encoded user's credentials

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

[apiInstance doAuthWithPasswordWith:body
              completionHandler: ^(sessionDetails output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.AuthApi()
var body = ; // {{AuthCredentialsRequest}} The base64 encoded user's credentials

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

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

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

            var apiInstance = new AuthApi();
            var body = new AuthCredentialsRequest(); // AuthCredentialsRequest | The base64 encoded user's credentials

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

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

$api_instance = new Swagger\Client\ApiAuthApi();
$body = ; // AuthCredentialsRequest | The base64 encoded user's credentials

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

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

my $api_instance = WWW::SwaggerClient::AuthApi->new();
my $body = WWW::SwaggerClient::Object::AuthCredentialsRequest->new(); # AuthCredentialsRequest | The base64 encoded user's credentials

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AuthApi()
body =  # AuthCredentialsRequest | The base64 encoded user's credentials

try: 
    api_response = api_instance.do_auth_with_password(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->doAuthWithPassword: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - Successfully authenticated.

Name Type Format Description
Access-Token String

Status: 401 - Authentication failed.

Status: default - Internal Server Error


doAuthWithSamlCallback

Creates a session based on a SAML assertion of an external IdP


/auth/saml

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/auth/saml"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthApi;

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

public class AuthApiExample {

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

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

        AuthApi apiInstance = new AuthApi();
        Auth_saml_body body = ; // Auth_saml_body | 
        try {
            createResponse result = apiInstance.doAuthWithSamlCallback(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#doAuthWithSamlCallback");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthApi;

public class AuthApiExample {

    public static void main(String[] args) {
        AuthApi apiInstance = new AuthApi();
        Auth_saml_body body = ; // Auth_saml_body | 
        try {
            createResponse result = apiInstance.doAuthWithSamlCallback(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#doAuthWithSamlCallback");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
Auth_saml_body *body = ; // 

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

[apiInstance doAuthWithSamlCallbackWith:body
              completionHandler: ^(createResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.AuthApi()
var body = ; // {{Auth_saml_body}} 

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

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

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

            var apiInstance = new AuthApi();
            var body = new Auth_saml_body(); // Auth_saml_body | 

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

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

$api_instance = new Swagger\Client\ApiAuthApi();
$body = ; // Auth_saml_body | 

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

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

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

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AuthApi()
body =  # Auth_saml_body | 

try: 
    api_response = api_instance.do_auth_with_saml_callback(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->doAuthWithSamlCallback: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - Successfully authenticated.

Name Type Format Description
Access-Token String

Status: 401 - Unauthorized

Status: default - Internal Server Error


endSession

Ends the current session


/auth/session/{sessionUuid}

Usage and SDK Samples

curl -X DELETE\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/auth/session/{sessionUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthApi;

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

public class AuthApiExample {

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

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

        AuthApi apiInstance = new AuthApi();
        String sessionUuid = sessionUuid_example; // String | The UUID of the session to end
        try {
            apiInstance.endSession(sessionUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#endSession");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthApi;

public class AuthApiExample {

    public static void main(String[] args) {
        AuthApi apiInstance = new AuthApi();
        String sessionUuid = sessionUuid_example; // String | The UUID of the session to end
        try {
            apiInstance.endSession(sessionUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#endSession");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *sessionUuid = sessionUuid_example; // The UUID of the session to end

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

[apiInstance endSessionWith:sessionUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.AuthApi()
var sessionUuid = sessionUuid_example; // {{String}} The UUID of the session to end

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

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

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

            var apiInstance = new AuthApi();
            var sessionUuid = sessionUuid_example;  // String | The UUID of the session to end

            try
            {
                apiInstance.endSession(sessionUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthApi.endSession: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAuthApi();
$sessionUuid = sessionUuid_example; // String | The UUID of the session to end

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

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

my $api_instance = WWW::SwaggerClient::AuthApi->new();
my $sessionUuid = sessionUuid_example; # String | The UUID of the session to end

eval { 
    $api_instance->endSession(sessionUuid => $sessionUuid);
};
if ($@) {
    warn "Exception when calling AuthApi->endSession: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AuthApi()
sessionUuid = sessionUuid_example # String | The UUID of the session to end

try: 
    api_instance.end_session(sessionUuid)
except ApiException as e:
    print("Exception when calling AuthApi->endSession: %s\n" % e)

Parameters

Path parameters
Name Description
sessionUuid*
String
The UUID of the session to end
Required

Responses

Status: 204 - The resource was deleted successfully.

Status: 401 - Authentication failed.

Status: default - Internal Server Errors


getSamlUrl

Gets a URL for SAML authentication


/auth/saml

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/auth/saml?redirect="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthApi;

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

public class AuthApiExample {

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

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

        AuthApi apiInstance = new AuthApi();
        String redirect = redirect_example; // String | A relay state variable to send
        try {
            user result = apiInstance.getSamlUrl(redirect);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#getSamlUrl");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthApi;

public class AuthApiExample {

    public static void main(String[] args) {
        AuthApi apiInstance = new AuthApi();
        String redirect = redirect_example; // String | A relay state variable to send
        try {
            user result = apiInstance.getSamlUrl(redirect);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#getSamlUrl");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *redirect = redirect_example; // A relay state variable to send (optional)

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

[apiInstance getSamlUrlWith:redirect
              completionHandler: ^(user output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.AuthApi()
var opts = { 
  'redirect': redirect_example // {{String}} A relay state variable to send
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSamlUrl(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new AuthApi();
            var redirect = redirect_example;  // String | A relay state variable to send (optional) 

            try
            {
                user result = apiInstance.getSamlUrl(redirect);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthApi.getSamlUrl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAuthApi();
$redirect = redirect_example; // String | A relay state variable to send

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

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

my $api_instance = WWW::SwaggerClient::AuthApi->new();
my $redirect = redirect_example; # String | A relay state variable to send

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AuthApi()
redirect = redirect_example # String | A relay state variable to send (optional)

try: 
    api_response = api_instance.get_saml_url(redirect=redirect)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->getSamlUrl: %s\n" % e)

Parameters

Query parameters
Name Description
redirect
String
A relay state variable to send

Responses

Status: 200 - Fetched SAML information and transmitted in the message body.

Status: 401 - Authentication failed.

Status: default - Internal Server Error


getSessionInfo

Gets user information for the current session


/auth/session/{sessionUuid}

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/auth/session/{sessionUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthApi;

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

public class AuthApiExample {

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

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

        AuthApi apiInstance = new AuthApi();
        String sessionUuid = sessionUuid_example; // String | The UUID of the session to retrieve
        try {
            user result = apiInstance.getSessionInfo(sessionUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#getSessionInfo");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthApi;

public class AuthApiExample {

    public static void main(String[] args) {
        AuthApi apiInstance = new AuthApi();
        String sessionUuid = sessionUuid_example; // String | The UUID of the session to retrieve
        try {
            user result = apiInstance.getSessionInfo(sessionUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#getSessionInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *sessionUuid = sessionUuid_example; // The UUID of the session to retrieve

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

[apiInstance getSessionInfoWith:sessionUuid
              completionHandler: ^(user output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.AuthApi()
var sessionUuid = sessionUuid_example; // {{String}} The UUID of the session to retrieve

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

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

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

            var apiInstance = new AuthApi();
            var sessionUuid = sessionUuid_example;  // String | The UUID of the session to retrieve

            try
            {
                user result = apiInstance.getSessionInfo(sessionUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthApi.getSessionInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAuthApi();
$sessionUuid = sessionUuid_example; // String | The UUID of the session to retrieve

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

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

my $api_instance = WWW::SwaggerClient::AuthApi->new();
my $sessionUuid = sessionUuid_example; # String | The UUID of the session to retrieve

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AuthApi()
sessionUuid = sessionUuid_example # String | The UUID of the session to retrieve

try: 
    api_response = api_instance.get_session_info(sessionUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->getSessionInfo: %s\n" % e)

Parameters

Path parameters
Name Description
sessionUuid*
String
The UUID of the session to retrieve
Required

Responses

Status: 200 - Fetched user information for the current session and transmitted in the message body.

Status: default - Internal Server Error


getTotpConfig

Gets user TOTP information


/auth/totp/{userUuid}

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/auth/totp/{userUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthApi;

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

public class AuthApiExample {

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

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

        AuthApi apiInstance = new AuthApi();
        String userUuid = userUuid_example; // String | The UUID of the user to retrieve TOTP config.
        try {
            userTotpConfig result = apiInstance.getTotpConfig(userUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#getTotpConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthApi;

public class AuthApiExample {

    public static void main(String[] args) {
        AuthApi apiInstance = new AuthApi();
        String userUuid = userUuid_example; // String | The UUID of the user to retrieve TOTP config.
        try {
            userTotpConfig result = apiInstance.getTotpConfig(userUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#getTotpConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *userUuid = userUuid_example; // The UUID of the user to retrieve TOTP config.

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

[apiInstance getTotpConfigWith:userUuid
              completionHandler: ^(userTotpConfig output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.AuthApi()
var userUuid = userUuid_example; // {{String}} The UUID of the user to retrieve TOTP config.

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

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

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

            var apiInstance = new AuthApi();
            var userUuid = userUuid_example;  // String | The UUID of the user to retrieve TOTP config.

            try
            {
                userTotpConfig result = apiInstance.getTotpConfig(userUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthApi.getTotpConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAuthApi();
$userUuid = userUuid_example; // String | The UUID of the user to retrieve TOTP config.

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

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

my $api_instance = WWW::SwaggerClient::AuthApi->new();
my $userUuid = userUuid_example; # String | The UUID of the user to retrieve TOTP config.

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AuthApi()
userUuid = userUuid_example # String | The UUID of the user to retrieve TOTP config.

try: 
    api_response = api_instance.get_totp_config(userUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->getTotpConfig: %s\n" % e)

Parameters

Path parameters
Name Description
userUuid*
String
The UUID of the user to retrieve TOTP config.
Required

Responses

Status: 200 - Fetched user totp information and transmitted it in the message body.

Status: default - Internal Server Error


initialiseTotpEnrolment

Initialises a TOTP enrolment, returns the secret and QR code


/auth/totp/{userUuid}

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/auth/totp/{userUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthApi;

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

public class AuthApiExample {

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

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

        AuthApi apiInstance = new AuthApi();
        String userUuid = userUuid_example; // String | The UUID of the user to enrol in TOTP.
        try {
            TotpSecret result = apiInstance.initialiseTotpEnrolment(userUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#initialiseTotpEnrolment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthApi;

public class AuthApiExample {

    public static void main(String[] args) {
        AuthApi apiInstance = new AuthApi();
        String userUuid = userUuid_example; // String | The UUID of the user to enrol in TOTP.
        try {
            TotpSecret result = apiInstance.initialiseTotpEnrolment(userUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#initialiseTotpEnrolment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *userUuid = userUuid_example; // The UUID of the user to enrol in TOTP.

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

[apiInstance initialiseTotpEnrolmentWith:userUuid
              completionHandler: ^(TotpSecret output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.AuthApi()
var userUuid = userUuid_example; // {{String}} The UUID of the user to enrol in TOTP.

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

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

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

            var apiInstance = new AuthApi();
            var userUuid = userUuid_example;  // String | The UUID of the user to enrol in TOTP.

            try
            {
                TotpSecret result = apiInstance.initialiseTotpEnrolment(userUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthApi.initialiseTotpEnrolment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAuthApi();
$userUuid = userUuid_example; // String | The UUID of the user to enrol in TOTP.

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

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

my $api_instance = WWW::SwaggerClient::AuthApi->new();
my $userUuid = userUuid_example; # String | The UUID of the user to enrol in TOTP.

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AuthApi()
userUuid = userUuid_example # String | The UUID of the user to enrol in TOTP.

try: 
    api_response = api_instance.initialise_totp_enrolment(userUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->initialiseTotpEnrolment: %s\n" % e)

Parameters

Path parameters
Name Description
userUuid*
String
The UUID of the user to enrol in TOTP.
Required

Responses

Status: 201 - Successfully initialised.

Status: 403 - The request does not have sufficient permissions to enrol the user in TOTP.

Status: 404 - Could not find the requested user or insufficient permissions to find.

Status: default - Internal Server Error


validateTotpEnrolment

Validates an initialised but incomplete TOTP enrolment with the supplied QR code


/auth/totp/{userUuid}

Usage and SDK Samples

curl -X PUT\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/auth/totp/{userUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthApi;

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

public class AuthApiExample {

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

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

        AuthApi apiInstance = new AuthApi();
        TotpCode body = ; // TotpCode | The TOTP code.
        String userUuid = userUuid_example; // String | The UUID of the user to enrol in TOTP.
        try {
            apiInstance.validateTotpEnrolment(body, userUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#validateTotpEnrolment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthApi;

public class AuthApiExample {

    public static void main(String[] args) {
        AuthApi apiInstance = new AuthApi();
        TotpCode body = ; // TotpCode | The TOTP code.
        String userUuid = userUuid_example; // String | The UUID of the user to enrol in TOTP.
        try {
            apiInstance.validateTotpEnrolment(body, userUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#validateTotpEnrolment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
TotpCode *body = ; // The TOTP code.
String *userUuid = userUuid_example; // The UUID of the user to enrol in TOTP.

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

[apiInstance validateTotpEnrolmentWith:body
    userUuid:userUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.AuthApi()
var body = ; // {{TotpCode}} The TOTP code.
var userUuid = userUuid_example; // {{String}} The UUID of the user to enrol in TOTP.

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

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

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

            var apiInstance = new AuthApi();
            var body = new TotpCode(); // TotpCode | The TOTP code.
            var userUuid = userUuid_example;  // String | The UUID of the user to enrol in TOTP.

            try
            {
                apiInstance.validateTotpEnrolment(body, userUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthApi.validateTotpEnrolment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAuthApi();
$body = ; // TotpCode | The TOTP code.
$userUuid = userUuid_example; // String | The UUID of the user to enrol in TOTP.

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

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

my $api_instance = WWW::SwaggerClient::AuthApi->new();
my $body = WWW::SwaggerClient::Object::TotpCode->new(); # TotpCode | The TOTP code.
my $userUuid = userUuid_example; # String | The UUID of the user to enrol in TOTP.

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AuthApi()
body =  # TotpCode | The TOTP code.
userUuid = userUuid_example # String | The UUID of the user to enrol in TOTP.

try: 
    api_instance.validate_totp_enrolment(body, userUuid)
except ApiException as e:
    print("Exception when calling AuthApi->validateTotpEnrolment: %s\n" % e)

Parameters

Path parameters
Name Description
userUuid*
String
The UUID of the user to enrol in TOTP.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - Successfully validated.

Status: 400 - The supplied user has not had their TOTP enrolment initialised.

Status: 401 - The TOTP code was invalid. (Or the validating user is not authenticated).

Status: 403 - The request does not have sufficient permissions to validate user's code.

Status: 404 - Could not find the requested user or insufficient permissions to find.

Status: default - Internal Server Error


Case

addCaseAction

Add an action to a case.


/case/{caseUuid}/action/{actionUuid}

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/case/{caseUuid}/action/{actionUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseApi;

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

public class CaseApiExample {

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

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

        CaseApi apiInstance = new CaseApi();
        String caseUuid = caseUuid_example; // String | The UUID of the case.
        String actionUuid = actionUuid_example; // String | The UUID of the action.
        try {
            playbookActionInstance result = apiInstance.addCaseAction(caseUuid, actionUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#addCaseAction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseApi;

public class CaseApiExample {

    public static void main(String[] args) {
        CaseApi apiInstance = new CaseApi();
        String caseUuid = caseUuid_example; // String | The UUID of the case.
        String actionUuid = actionUuid_example; // String | The UUID of the action.
        try {
            playbookActionInstance result = apiInstance.addCaseAction(caseUuid, actionUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#addCaseAction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *caseUuid = caseUuid_example; // The UUID of the case.
String *actionUuid = actionUuid_example; // The UUID of the action.

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

// Add an action to a case.
[apiInstance addCaseActionWith:caseUuid
    actionUuid:actionUuid
              completionHandler: ^(playbookActionInstance output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseApi()
var caseUuid = caseUuid_example; // {{String}} The UUID of the case.
var actionUuid = actionUuid_example; // {{String}} The UUID of the action.

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

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

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

            var apiInstance = new CaseApi();
            var caseUuid = caseUuid_example;  // String | The UUID of the case.
            var actionUuid = actionUuid_example;  // String | The UUID of the action.

            try
            {
                // Add an action to a case.
                playbookActionInstance result = apiInstance.addCaseAction(caseUuid, actionUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseApi.addCaseAction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCaseApi();
$caseUuid = caseUuid_example; // String | The UUID of the case.
$actionUuid = actionUuid_example; // String | The UUID of the action.

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

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

my $api_instance = WWW::SwaggerClient::CaseApi->new();
my $caseUuid = caseUuid_example; # String | The UUID of the case.
my $actionUuid = actionUuid_example; # String | The UUID of the action.

eval { 
    my $result = $api_instance->addCaseAction(caseUuid => $caseUuid, actionUuid => $actionUuid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CaseApi->addCaseAction: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseApi()
caseUuid = caseUuid_example # String | The UUID of the case.
actionUuid = actionUuid_example # String | The UUID of the action.

try: 
    # Add an action to a case.
    api_response = api_instance.add_case_action(caseUuid, actionUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseApi->addCaseAction: %s\n" % e)

Parameters

Path parameters
Name Description
caseUuid*
String
The UUID of the case.
Required
actionUuid*
String
The UUID of the action.
Required

Responses

Status: 201 - The status of the create case action request

Status: default - Internal Server Error


addCasePlaybookActionTag

Add a tag from a case playbook action.


/case/{caseUuid}/playbook/{casePlaybookUuid}/action-instance/{actionInstanceUuid}/case-tag/{tagUuid}

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/case/{caseUuid}/playbook/{casePlaybookUuid}/action-instance/{actionInstanceUuid}/case-tag/{tagUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseApi;

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

public class CaseApiExample {

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

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

        CaseApi apiInstance = new CaseApi();
        String caseUuid = caseUuid_example; // String | The UUID of the case to add from.
        String casePlaybookUuid = casePlaybookUuid_example; // String | The UUID of the playbook to add.
        String actionInstanceUuid = actionInstanceUuid_example; // String | The UUID of the action instance to update.
        String tagUuid = tagUuid_example; // String | The UUID of the tag to add.
        try {
            apiInstance.addCasePlaybookActionTag(caseUuid, casePlaybookUuid, actionInstanceUuid, tagUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#addCasePlaybookActionTag");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseApi;

public class CaseApiExample {

    public static void main(String[] args) {
        CaseApi apiInstance = new CaseApi();
        String caseUuid = caseUuid_example; // String | The UUID of the case to add from.
        String casePlaybookUuid = casePlaybookUuid_example; // String | The UUID of the playbook to add.
        String actionInstanceUuid = actionInstanceUuid_example; // String | The UUID of the action instance to update.
        String tagUuid = tagUuid_example; // String | The UUID of the tag to add.
        try {
            apiInstance.addCasePlaybookActionTag(caseUuid, casePlaybookUuid, actionInstanceUuid, tagUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#addCasePlaybookActionTag");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *caseUuid = caseUuid_example; // The UUID of the case to add from.
String *casePlaybookUuid = casePlaybookUuid_example; // The UUID of the playbook to add.
String *actionInstanceUuid = actionInstanceUuid_example; // The UUID of the action instance to update.
String *tagUuid = tagUuid_example; // The UUID of the tag to add.

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

// Add a tag from a case playbook action.
[apiInstance addCasePlaybookActionTagWith:caseUuid
    casePlaybookUuid:casePlaybookUuid
    actionInstanceUuid:actionInstanceUuid
    tagUuid:tagUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseApi()
var caseUuid = caseUuid_example; // {{String}} The UUID of the case to add from.
var casePlaybookUuid = casePlaybookUuid_example; // {{String}} The UUID of the playbook to add.
var actionInstanceUuid = actionInstanceUuid_example; // {{String}} The UUID of the action instance to update.
var tagUuid = tagUuid_example; // {{String}} The UUID of the tag to add.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.addCasePlaybookActionTag(caseUuid, casePlaybookUuid, actionInstanceUuid, tagUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new CaseApi();
            var caseUuid = caseUuid_example;  // String | The UUID of the case to add from.
            var casePlaybookUuid = casePlaybookUuid_example;  // String | The UUID of the playbook to add.
            var actionInstanceUuid = actionInstanceUuid_example;  // String | The UUID of the action instance to update.
            var tagUuid = tagUuid_example;  // String | The UUID of the tag to add.

            try
            {
                // Add a tag from a case playbook action.
                apiInstance.addCasePlaybookActionTag(caseUuid, casePlaybookUuid, actionInstanceUuid, tagUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseApi.addCasePlaybookActionTag: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCaseApi();
$caseUuid = caseUuid_example; // String | The UUID of the case to add from.
$casePlaybookUuid = casePlaybookUuid_example; // String | The UUID of the playbook to add.
$actionInstanceUuid = actionInstanceUuid_example; // String | The UUID of the action instance to update.
$tagUuid = tagUuid_example; // String | The UUID of the tag to add.

try {
    $api_instance->addCasePlaybookActionTag($caseUuid, $casePlaybookUuid, $actionInstanceUuid, $tagUuid);
} catch (Exception $e) {
    echo 'Exception when calling CaseApi->addCasePlaybookActionTag: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CaseApi;

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

my $api_instance = WWW::SwaggerClient::CaseApi->new();
my $caseUuid = caseUuid_example; # String | The UUID of the case to add from.
my $casePlaybookUuid = casePlaybookUuid_example; # String | The UUID of the playbook to add.
my $actionInstanceUuid = actionInstanceUuid_example; # String | The UUID of the action instance to update.
my $tagUuid = tagUuid_example; # String | The UUID of the tag to add.

eval { 
    $api_instance->addCasePlaybookActionTag(caseUuid => $caseUuid, casePlaybookUuid => $casePlaybookUuid, actionInstanceUuid => $actionInstanceUuid, tagUuid => $tagUuid);
};
if ($@) {
    warn "Exception when calling CaseApi->addCasePlaybookActionTag: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseApi()
caseUuid = caseUuid_example # String | The UUID of the case to add from.
casePlaybookUuid = casePlaybookUuid_example # String | The UUID of the playbook to add.
actionInstanceUuid = actionInstanceUuid_example # String | The UUID of the action instance to update.
tagUuid = tagUuid_example # String | The UUID of the tag to add.

try: 
    # Add a tag from a case playbook action.
    api_instance.add_case_playbook_action_tag(caseUuid, casePlaybookUuid, actionInstanceUuid, tagUuid)
except ApiException as e:
    print("Exception when calling CaseApi->addCasePlaybookActionTag: %s\n" % e)

Parameters

Path parameters
Name Description
caseUuid*
String
The UUID of the case to add from.
Required
casePlaybookUuid*
String
The UUID of the playbook to add.
Required
actionInstanceUuid*
String
The UUID of the action instance to update.
Required
tagUuid*
String
The UUID of the tag to add.
Required

Responses

Status: 204 - The resource was added successfully.

Status: default - Internal Server Error


addWatcherToCase

Adds a new watcher to a case.


/case/{caseUuid}/watch

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/case/{caseUuid}/watch"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseApi;

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

public class CaseApiExample {

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

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

        CaseApi apiInstance = new CaseApi();
        String caseUuid = caseUuid_example; // String | The case to add user to as new watcher.
        WatcherSettings body = ; // WatcherSettings | The settings to create the watcher with.
        try {
            apiInstance.addWatcherToCase(caseUuid, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#addWatcherToCase");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseApi;

public class CaseApiExample {

    public static void main(String[] args) {
        CaseApi apiInstance = new CaseApi();
        String caseUuid = caseUuid_example; // String | The case to add user to as new watcher.
        WatcherSettings body = ; // WatcherSettings | The settings to create the watcher with.
        try {
            apiInstance.addWatcherToCase(caseUuid, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#addWatcherToCase");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *caseUuid = caseUuid_example; // The case to add user to as new watcher.
WatcherSettings *body = ; // The settings to create the watcher with. (optional)

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

// Adds a new watcher to a case.
[apiInstance addWatcherToCaseWith:caseUuid
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseApi()
var caseUuid = caseUuid_example; // {{String}} The case to add user to as new watcher.
var opts = { 
  'body':  // {{WatcherSettings}} The settings to create the watcher with.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.addWatcherToCase(caseUuid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new CaseApi();
            var caseUuid = caseUuid_example;  // String | The case to add user to as new watcher.
            var body = new WatcherSettings(); // WatcherSettings | The settings to create the watcher with. (optional) 

            try
            {
                // Adds a new watcher to a case.
                apiInstance.addWatcherToCase(caseUuid, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseApi.addWatcherToCase: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCaseApi();
$caseUuid = caseUuid_example; // String | The case to add user to as new watcher.
$body = ; // WatcherSettings | The settings to create the watcher with.

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

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

my $api_instance = WWW::SwaggerClient::CaseApi->new();
my $caseUuid = caseUuid_example; # String | The case to add user to as new watcher.
my $body = WWW::SwaggerClient::Object::WatcherSettings->new(); # WatcherSettings | The settings to create the watcher with.

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseApi()
caseUuid = caseUuid_example # String | The case to add user to as new watcher.
body =  # WatcherSettings | The settings to create the watcher with. (optional)

try: 
    # Adds a new watcher to a case.
    api_instance.add_watcher_to_case(caseUuid, body=body)
except ApiException as e:
    print("Exception when calling CaseApi->addWatcherToCase: %s\n" % e)

Parameters

Path parameters
Name Description
caseUuid*
String
The case to add user to as new watcher.
Required
Body parameters
Name Description
body

Responses

Status: 200 - The status response for the create request.

Status: 201 - Added a new watcher to a case.

Status: default - Internal Server Error


caseGroupAddMember

Adds a case as a member of another case.


/case/{caseUuid}/member/{memberUuid}

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/case/{caseUuid}/member/{memberUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseApi;

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

public class CaseApiExample {

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

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

        CaseApi apiInstance = new CaseApi();
        String caseUuid = caseUuid_example; // String | The UUID of the case to update.
        String memberUuid = memberUuid_example; // String | The UUID of the case to add.
        try {
            createResponse result = apiInstance.caseGroupAddMember(caseUuid, memberUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#caseGroupAddMember");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseApi;

public class CaseApiExample {

    public static void main(String[] args) {
        CaseApi apiInstance = new CaseApi();
        String caseUuid = caseUuid_example; // String | The UUID of the case to update.
        String memberUuid = memberUuid_example; // String | The UUID of the case to add.
        try {
            createResponse result = apiInstance.caseGroupAddMember(caseUuid, memberUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#caseGroupAddMember");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *caseUuid = caseUuid_example; // The UUID of the case to update.
String *memberUuid = memberUuid_example; // The UUID of the case to add.

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

// Adds a case as a member of another case.
[apiInstance caseGroupAddMemberWith:caseUuid
    memberUuid:memberUuid
              completionHandler: ^(createResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseApi()
var caseUuid = caseUuid_example; // {{String}} The UUID of the case to update.
var memberUuid = memberUuid_example; // {{String}} The UUID of the case to add.

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

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

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

            var apiInstance = new CaseApi();
            var caseUuid = caseUuid_example;  // String | The UUID of the case to update.
            var memberUuid = memberUuid_example;  // String | The UUID of the case to add.

            try
            {
                // Adds a case as a member of another case.
                createResponse result = apiInstance.caseGroupAddMember(caseUuid, memberUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseApi.caseGroupAddMember: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCaseApi();
$caseUuid = caseUuid_example; // String | The UUID of the case to update.
$memberUuid = memberUuid_example; // String | The UUID of the case to add.

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

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

my $api_instance = WWW::SwaggerClient::CaseApi->new();
my $caseUuid = caseUuid_example; # String | The UUID of the case to update.
my $memberUuid = memberUuid_example; # String | The UUID of the case to add.

eval { 
    my $result = $api_instance->caseGroupAddMember(caseUuid => $caseUuid, memberUuid => $memberUuid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CaseApi->caseGroupAddMember: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseApi()
caseUuid = caseUuid_example # String | The UUID of the case to update.
memberUuid = memberUuid_example # String | The UUID of the case to add.

try: 
    # Adds a case as a member of another case.
    api_response = api_instance.case_group_add_member(caseUuid, memberUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseApi->caseGroupAddMember: %s\n" % e)

Parameters

Path parameters
Name Description
caseUuid*
String
The UUID of the case to update.
Required
memberUuid*
String
The UUID of the case to add.
Required

Responses

Status: 201 - The case has been created as a member of another case.

Status: 404 - Requested case not found or insufficient permissions to finds.

Status: default - Internal Server Error


caseGroupRemoveMember

Removes a case member from a case.


/case/{caseUuid}/member/{memberUuid}

Usage and SDK Samples

curl -X DELETE\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/case/{caseUuid}/member/{memberUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseApi;

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

public class CaseApiExample {

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

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

        CaseApi apiInstance = new CaseApi();
        String caseUuid = caseUuid_example; // String | The UUID of the case to update.
        String memberUuid = memberUuid_example; // String | The UUID of the case to remove.
        try {
            apiInstance.caseGroupRemoveMember(caseUuid, memberUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#caseGroupRemoveMember");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseApi;

public class CaseApiExample {

    public static void main(String[] args) {
        CaseApi apiInstance = new CaseApi();
        String caseUuid = caseUuid_example; // String | The UUID of the case to update.
        String memberUuid = memberUuid_example; // String | The UUID of the case to remove.
        try {
            apiInstance.caseGroupRemoveMember(caseUuid, memberUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#caseGroupRemoveMember");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *caseUuid = caseUuid_example; // The UUID of the case to update.
String *memberUuid = memberUuid_example; // The UUID of the case to remove.

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

// Removes a case member from a case.
[apiInstance caseGroupRemoveMemberWith:caseUuid
    memberUuid:memberUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseApi()
var caseUuid = caseUuid_example; // {{String}} The UUID of the case to update.
var memberUuid = memberUuid_example; // {{String}} The UUID of the case to remove.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.caseGroupRemoveMember(caseUuid, memberUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new CaseApi();
            var caseUuid = caseUuid_example;  // String | The UUID of the case to update.
            var memberUuid = memberUuid_example;  // String | The UUID of the case to remove.

            try
            {
                // Removes a case member from a case.
                apiInstance.caseGroupRemoveMember(caseUuid, memberUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseApi.caseGroupRemoveMember: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCaseApi();
$caseUuid = caseUuid_example; // String | The UUID of the case to update.
$memberUuid = memberUuid_example; // String | The UUID of the case to remove.

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

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

my $api_instance = WWW::SwaggerClient::CaseApi->new();
my $caseUuid = caseUuid_example; # String | The UUID of the case to update.
my $memberUuid = memberUuid_example; # String | The UUID of the case to remove.

eval { 
    $api_instance->caseGroupRemoveMember(caseUuid => $caseUuid, memberUuid => $memberUuid);
};
if ($@) {
    warn "Exception when calling CaseApi->caseGroupRemoveMember: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseApi()
caseUuid = caseUuid_example # String | The UUID of the case to update.
memberUuid = memberUuid_example # String | The UUID of the case to remove.

try: 
    # Removes a case member from a case.
    api_instance.case_group_remove_member(caseUuid, memberUuid)
except ApiException as e:
    print("Exception when calling CaseApi->caseGroupRemoveMember: %s\n" % e)

Parameters

Path parameters
Name Description
caseUuid*
String
The UUID of the case to update.
Required
memberUuid*
String
The UUID of the case to remove.
Required

Responses

Status: 204 - The case was deleted successfully.

Status: default - Internal Server Error


createActionInstanceData

Creates a data item on a case action.


/action-instance/{actionInstanceUuid}/data

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/action-instance/{actionInstanceUuid}/data"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseApi;

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

public class CaseApiExample {

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

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

        CaseApi apiInstance = new CaseApi();
        CaseDataItemRequest body = ; // CaseDataItemRequest | The data item to create.
        String actionInstanceUuid = actionInstanceUuid_example; // String | The case action instance to add to.
        try {
            dataStub result = apiInstance.createActionInstanceData(body, actionInstanceUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#createActionInstanceData");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseApi;

public class CaseApiExample {

    public static void main(String[] args) {
        CaseApi apiInstance = new CaseApi();
        CaseDataItemRequest body = ; // CaseDataItemRequest | The data item to create.
        String actionInstanceUuid = actionInstanceUuid_example; // String | The case action instance to add to.
        try {
            dataStub result = apiInstance.createActionInstanceData(body, actionInstanceUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#createActionInstanceData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
CaseDataItemRequest *body = ; // The data item to create.
String *actionInstanceUuid = actionInstanceUuid_example; // The case action instance to add to.

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

// Creates a data item on a case action.
[apiInstance createActionInstanceDataWith:body
    actionInstanceUuid:actionInstanceUuid
              completionHandler: ^(dataStub output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseApi()
var body = ; // {{CaseDataItemRequest}} The data item to create.
var actionInstanceUuid = actionInstanceUuid_example; // {{String}} The case action instance to add to.

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

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

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

            var apiInstance = new CaseApi();
            var body = new CaseDataItemRequest(); // CaseDataItemRequest | The data item to create.
            var actionInstanceUuid = actionInstanceUuid_example;  // String | The case action instance to add to.

            try
            {
                // Creates a data item on a case action.
                dataStub result = apiInstance.createActionInstanceData(body, actionInstanceUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseApi.createActionInstanceData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCaseApi();
$body = ; // CaseDataItemRequest | The data item to create.
$actionInstanceUuid = actionInstanceUuid_example; // String | The case action instance to add to.

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

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

my $api_instance = WWW::SwaggerClient::CaseApi->new();
my $body = WWW::SwaggerClient::Object::CaseDataItemRequest->new(); # CaseDataItemRequest | The data item to create.
my $actionInstanceUuid = actionInstanceUuid_example; # String | The case action instance to add to.

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseApi()
body =  # CaseDataItemRequest | The data item to create.
actionInstanceUuid = actionInstanceUuid_example # String | The case action instance to add to.

try: 
    # Creates a data item on a case action.
    api_response = api_instance.create_action_instance_data(body, actionInstanceUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseApi->createActionInstanceData: %s\n" % e)

Parameters

Path parameters
Name Description
actionInstanceUuid*
String
The case action instance to add to.
Required
Body parameters
Name Description
body *

Responses

Status: 201 - The case action data has been created.

Status: 400 - Bad request.

Status: 401 - Invalid authentication for this request.

Status: 403 - The request does not have authorisation.

Status: 404 - Requested case not found or insufficient permissions to finds.

Status: default - Internal Server Error


createCase

Creates a case.


/case

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/case"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseApi;

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

public class CaseApiExample {

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

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

        CaseApi apiInstance = new CaseApi();
        Case body = ; // Case | The case to create.
        try {
            createResponse result = apiInstance.createCase(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#createCase");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseApi;

public class CaseApiExample {

    public static void main(String[] args) {
        CaseApi apiInstance = new CaseApi();
        Case body = ; // Case | The case to create.
        try {
            createResponse result = apiInstance.createCase(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#createCase");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
Case *body = ; // The case to create.

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

// Creates a case.
[apiInstance createCaseWith:body
              completionHandler: ^(createResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseApi()
var body = ; // {{Case}} The case to create.

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

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

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

            var apiInstance = new CaseApi();
            var body = new Case(); // Case | The case to create.

            try
            {
                // Creates a case.
                createResponse result = apiInstance.createCase(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseApi.createCase: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCaseApi();
$body = ; // Case | The case to create.

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

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

my $api_instance = WWW::SwaggerClient::CaseApi->new();
my $body = WWW::SwaggerClient::Object::Case->new(); # Case | The case to create.

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseApi()
body =  # Case | The case to create.

try: 
    # Creates a case.
    api_response = api_instance.create_case(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseApi->createCase: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - The case has been created.

Status: 401 - Invalid authentication for this request.

Status: 403 - The request does not have authorisation.

Status: default - Internal Server Error


createCaseData

Creates a data item on a case.


/case/{caseUuid}/data

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/case/{caseUuid}/data"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseApi;

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

public class CaseApiExample {

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

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

        CaseApi apiInstance = new CaseApi();
        CaseDataItemRequest body = ; // CaseDataItemRequest | The data item to create.
        String caseUuid = caseUuid_example; // String | The case to add to.
        try {
            dataStub result = apiInstance.createCaseData(body, caseUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#createCaseData");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseApi;

public class CaseApiExample {

    public static void main(String[] args) {
        CaseApi apiInstance = new CaseApi();
        CaseDataItemRequest body = ; // CaseDataItemRequest | The data item to create.
        String caseUuid = caseUuid_example; // String | The case to add to.
        try {
            dataStub result = apiInstance.createCaseData(body, caseUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#createCaseData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
CaseDataItemRequest *body = ; // The data item to create.
String *caseUuid = caseUuid_example; // The case to add to.

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

// Creates a data item on a case.
[apiInstance createCaseDataWith:body
    caseUuid:caseUuid
              completionHandler: ^(dataStub output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseApi()
var body = ; // {{CaseDataItemRequest}} The data item to create.
var caseUuid = caseUuid_example; // {{String}} The case to add to.

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

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

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

            var apiInstance = new CaseApi();
            var body = new CaseDataItemRequest(); // CaseDataItemRequest | The data item to create.
            var caseUuid = caseUuid_example;  // String | The case to add to.

            try
            {
                // Creates a data item on a case.
                dataStub result = apiInstance.createCaseData(body, caseUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseApi.createCaseData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCaseApi();
$body = ; // CaseDataItemRequest | The data item to create.
$caseUuid = caseUuid_example; // String | The case to add to.

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

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

my $api_instance = WWW::SwaggerClient::CaseApi->new();
my $body = WWW::SwaggerClient::Object::CaseDataItemRequest->new(); # CaseDataItemRequest | The data item to create.
my $caseUuid = caseUuid_example; # String | The case to add to.

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseApi()
body =  # CaseDataItemRequest | The data item to create.
caseUuid = caseUuid_example # String | The case to add to.

try: 
    # Creates a data item on a case.
    api_response = api_instance.create_case_data(body, caseUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseApi->createCaseData: %s\n" % e)

Parameters

Path parameters
Name Description
caseUuid*
String
The case to add to.
Required
Body parameters
Name Description
body *

Responses

Status: 201 - The case data has been created.

Status: 400 - Failed to encrypt payload.

Status: 401 - Invalid authentication for this request.

Status: 403 - The request does not have authorisation.

Status: 404 - Requested case not found or insufficient permissions to finds.

Status: default - Internal Server Error


createCaseDataUnderParent

Creates a data item on a case, under a parent.

This endpoint is deprecated. Use endpoint /data/{parentStudUuid} instead.


/case/{caseUuid}/data/{parentStubId}

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/case/{caseUuid}/data/{parentStubId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseApi;

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

public class CaseApiExample {

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

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

        CaseApi apiInstance = new CaseApi();
        CaseDataItemRequest body = ; // CaseDataItemRequest | The data item to create.
        String caseUuid = caseUuid_example; // String | The case to add to.
        String parentStubId = parentStubId_example; // String | The parent to add under.
        try {
            dataStub result = apiInstance.createCaseDataUnderParent(body, caseUuid, parentStubId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#createCaseDataUnderParent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseApi;

public class CaseApiExample {

    public static void main(String[] args) {
        CaseApi apiInstance = new CaseApi();
        CaseDataItemRequest body = ; // CaseDataItemRequest | The data item to create.
        String caseUuid = caseUuid_example; // String | The case to add to.
        String parentStubId = parentStubId_example; // String | The parent to add under.
        try {
            dataStub result = apiInstance.createCaseDataUnderParent(body, caseUuid, parentStubId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#createCaseDataUnderParent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
CaseDataItemRequest *body = ; // The data item to create.
String *caseUuid = caseUuid_example; // The case to add to.
String *parentStubId = parentStubId_example; // The parent to add under.

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

// Creates a data item on a case, under a parent.
[apiInstance createCaseDataUnderParentWith:body
    caseUuid:caseUuid
    parentStubId:parentStubId
              completionHandler: ^(dataStub output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseApi()
var body = ; // {{CaseDataItemRequest}} The data item to create.
var caseUuid = caseUuid_example; // {{String}} The case to add to.
var parentStubId = parentStubId_example; // {{String}} The parent to add under.

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

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

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

            var apiInstance = new CaseApi();
            var body = new CaseDataItemRequest(); // CaseDataItemRequest | The data item to create.
            var caseUuid = caseUuid_example;  // String | The case to add to.
            var parentStubId = parentStubId_example;  // String | The parent to add under.

            try
            {
                // Creates a data item on a case, under a parent.
                dataStub result = apiInstance.createCaseDataUnderParent(body, caseUuid, parentStubId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseApi.createCaseDataUnderParent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCaseApi();
$body = ; // CaseDataItemRequest | The data item to create.
$caseUuid = caseUuid_example; // String | The case to add to.
$parentStubId = parentStubId_example; // String | The parent to add under.

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

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

my $api_instance = WWW::SwaggerClient::CaseApi->new();
my $body = WWW::SwaggerClient::Object::CaseDataItemRequest->new(); # CaseDataItemRequest | The data item to create.
my $caseUuid = caseUuid_example; # String | The case to add to.
my $parentStubId = parentStubId_example; # String | The parent to add under.

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseApi()
body =  # CaseDataItemRequest | The data item to create.
caseUuid = caseUuid_example # String | The case to add to.
parentStubId = parentStubId_example # String | The parent to add under.

try: 
    # Creates a data item on a case, under a parent.
    api_response = api_instance.create_case_data_under_parent(body, caseUuid, parentStubId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseApi->createCaseDataUnderParent: %s\n" % e)

Parameters

Path parameters
Name Description
caseUuid*
String
The case to add to.
Required
parentStubId*
String
The parent to add under.
Required
Body parameters
Name Description
body *

Responses

Status: 201 - The data item on the case has been created.

Status: 401 - Invalid authentication for this request.

Status: 403 - The request does not have authorisation.

Status: 404 - Requested parent not found or insufficient permissions to finds.

Status: default - Internal Server Error


createCasePlaybook

Creates a playbook.


/case/{caseUuid}/playbook/{casePlaybookUuid}

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/case/{caseUuid}/playbook/{casePlaybookUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseApi;

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

public class CaseApiExample {

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

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

        CaseApi apiInstance = new CaseApi();
        String caseUuid = caseUuid_example; // String | The UUID of the case to which the playbook will be assigned.
        String casePlaybookUuid = casePlaybookUuid_example; // String | The UUID of the playbook to be assigned.
        try {
            createResponse result = apiInstance.createCasePlaybook(caseUuid, casePlaybookUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#createCasePlaybook");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseApi;

public class CaseApiExample {

    public static void main(String[] args) {
        CaseApi apiInstance = new CaseApi();
        String caseUuid = caseUuid_example; // String | The UUID of the case to which the playbook will be assigned.
        String casePlaybookUuid = casePlaybookUuid_example; // String | The UUID of the playbook to be assigned.
        try {
            createResponse result = apiInstance.createCasePlaybook(caseUuid, casePlaybookUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#createCasePlaybook");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *caseUuid = caseUuid_example; // The UUID of the case to which the playbook will be assigned.
String *casePlaybookUuid = casePlaybookUuid_example; // The UUID of the playbook to be assigned.

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

// Creates a playbook.
[apiInstance createCasePlaybookWith:caseUuid
    casePlaybookUuid:casePlaybookUuid
              completionHandler: ^(createResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseApi()
var caseUuid = caseUuid_example; // {{String}} The UUID of the case to which the playbook will be assigned.
var casePlaybookUuid = casePlaybookUuid_example; // {{String}} The UUID of the playbook to be assigned.

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

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

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

            var apiInstance = new CaseApi();
            var caseUuid = caseUuid_example;  // String | The UUID of the case to which the playbook will be assigned.
            var casePlaybookUuid = casePlaybookUuid_example;  // String | The UUID of the playbook to be assigned.

            try
            {
                // Creates a playbook.
                createResponse result = apiInstance.createCasePlaybook(caseUuid, casePlaybookUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseApi.createCasePlaybook: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCaseApi();
$caseUuid = caseUuid_example; // String | The UUID of the case to which the playbook will be assigned.
$casePlaybookUuid = casePlaybookUuid_example; // String | The UUID of the playbook to be assigned.

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

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

my $api_instance = WWW::SwaggerClient::CaseApi->new();
my $caseUuid = caseUuid_example; # String | The UUID of the case to which the playbook will be assigned.
my $casePlaybookUuid = casePlaybookUuid_example; # String | The UUID of the playbook to be assigned.

eval { 
    my $result = $api_instance->createCasePlaybook(caseUuid => $caseUuid, casePlaybookUuid => $casePlaybookUuid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CaseApi->createCasePlaybook: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseApi()
caseUuid = caseUuid_example # String | The UUID of the case to which the playbook will be assigned.
casePlaybookUuid = casePlaybookUuid_example # String | The UUID of the playbook to be assigned.

try: 
    # Creates a playbook.
    api_response = api_instance.create_case_playbook(caseUuid, casePlaybookUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseApi->createCasePlaybook: %s\n" % e)

Parameters

Path parameters
Name Description
caseUuid*
String
The UUID of the case to which the playbook will be assigned.
Required
casePlaybookUuid*
String
The UUID of the playbook to be assigned.
Required

Responses

Status: 201 - The status of the create case playbook request.

Status: default - Internal Server Error


createCaseStixData

Creates a STIX item on a case.


/case/{caseUuid}/stix

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/case/{caseUuid}/stix"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseApi;

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

public class CaseApiExample {

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

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

        CaseApi apiInstance = new CaseApi();
        CaseDataStixRequest body = ; // CaseDataStixRequest | The data item to create.
        String caseUuid = caseUuid_example; // String | The case to add to.
        try {
            dataStub result = apiInstance.createCaseStixData(body, caseUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#createCaseStixData");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseApi;

public class CaseApiExample {

    public static void main(String[] args) {
        CaseApi apiInstance = new CaseApi();
        CaseDataStixRequest body = ; // CaseDataStixRequest | The data item to create.
        String caseUuid = caseUuid_example; // String | The case to add to.
        try {
            dataStub result = apiInstance.createCaseStixData(body, caseUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#createCaseStixData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
CaseDataStixRequest *body = ; // The data item to create.
String *caseUuid = caseUuid_example; // The case to add to.

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

// Creates a STIX item on a case.
[apiInstance createCaseStixDataWith:body
    caseUuid:caseUuid
              completionHandler: ^(dataStub output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseApi()
var body = ; // {{CaseDataStixRequest}} The data item to create.
var caseUuid = caseUuid_example; // {{String}} The case to add to.

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

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

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

            var apiInstance = new CaseApi();
            var body = new CaseDataStixRequest(); // CaseDataStixRequest | The data item to create.
            var caseUuid = caseUuid_example;  // String | The case to add to.

            try
            {
                // Creates a STIX item on a case.
                dataStub result = apiInstance.createCaseStixData(body, caseUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseApi.createCaseStixData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCaseApi();
$body = ; // CaseDataStixRequest | The data item to create.
$caseUuid = caseUuid_example; // String | The case to add to.

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

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

my $api_instance = WWW::SwaggerClient::CaseApi->new();
my $body = WWW::SwaggerClient::Object::CaseDataStixRequest->new(); # CaseDataStixRequest | The data item to create.
my $caseUuid = caseUuid_example; # String | The case to add to.

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseApi()
body =  # CaseDataStixRequest | The data item to create.
caseUuid = caseUuid_example # String | The case to add to.

try: 
    # Creates a STIX item on a case.
    api_response = api_instance.create_case_stix_data(body, caseUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseApi->createCaseStixData: %s\n" % e)

Parameters

Path parameters
Name Description
caseUuid*
String
The case to add to.
Required
Body parameters
Name Description
body *

Responses

Status: 201 - The STIX item has been created.

Status: 401 - Invalid authentication for this request.

Status: 404 - Requested case not found or insufficient permissions to finds.

Status: default - Internal Server Error


createCaseStixDataUnderParent

Creates a STIX item on a case, under a parent.


/case/{caseUuid}/stix/{parentStubId}

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/case/{caseUuid}/stix/{parentStubId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseApi;

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

public class CaseApiExample {

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

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

        CaseApi apiInstance = new CaseApi();
        CaseDataStixRequest body = ; // CaseDataStixRequest | The data item to create.
        String caseUuid = caseUuid_example; // String | The case to add to.
        String parentStubId = parentStubId_example; // String | The parent to add under.
        try {
            dataStub result = apiInstance.createCaseStixDataUnderParent(body, caseUuid, parentStubId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#createCaseStixDataUnderParent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseApi;

public class CaseApiExample {

    public static void main(String[] args) {
        CaseApi apiInstance = new CaseApi();
        CaseDataStixRequest body = ; // CaseDataStixRequest | The data item to create.
        String caseUuid = caseUuid_example; // String | The case to add to.
        String parentStubId = parentStubId_example; // String | The parent to add under.
        try {
            dataStub result = apiInstance.createCaseStixDataUnderParent(body, caseUuid, parentStubId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#createCaseStixDataUnderParent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
CaseDataStixRequest *body = ; // The data item to create.
String *caseUuid = caseUuid_example; // The case to add to.
String *parentStubId = parentStubId_example; // The parent to add under.

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

// Creates a STIX item on a case, under a parent.
[apiInstance createCaseStixDataUnderParentWith:body
    caseUuid:caseUuid
    parentStubId:parentStubId
              completionHandler: ^(dataStub output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseApi()
var body = ; // {{CaseDataStixRequest}} The data item to create.
var caseUuid = caseUuid_example; // {{String}} The case to add to.
var parentStubId = parentStubId_example; // {{String}} The parent to add under.

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

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

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

            var apiInstance = new CaseApi();
            var body = new CaseDataStixRequest(); // CaseDataStixRequest | The data item to create.
            var caseUuid = caseUuid_example;  // String | The case to add to.
            var parentStubId = parentStubId_example;  // String | The parent to add under.

            try
            {
                // Creates a STIX item on a case, under a parent.
                dataStub result = apiInstance.createCaseStixDataUnderParent(body, caseUuid, parentStubId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseApi.createCaseStixDataUnderParent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCaseApi();
$body = ; // CaseDataStixRequest | The data item to create.
$caseUuid = caseUuid_example; // String | The case to add to.
$parentStubId = parentStubId_example; // String | The parent to add under.

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

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

my $api_instance = WWW::SwaggerClient::CaseApi->new();
my $body = WWW::SwaggerClient::Object::CaseDataStixRequest->new(); # CaseDataStixRequest | The data item to create.
my $caseUuid = caseUuid_example; # String | The case to add to.
my $parentStubId = parentStubId_example; # String | The parent to add under.

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseApi()
body =  # CaseDataStixRequest | The data item to create.
caseUuid = caseUuid_example # String | The case to add to.
parentStubId = parentStubId_example # String | The parent to add under.

try: 
    # Creates a STIX item on a case, under a parent.
    api_response = api_instance.create_case_stix_data_under_parent(body, caseUuid, parentStubId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseApi->createCaseStixDataUnderParent: %s\n" % e)

Parameters

Path parameters
Name Description
caseUuid*
String
The case to add to.
Required
parentStubId*
String
The parent to add under.
Required
Body parameters
Name Description
body *

Responses

Status: 201 - The STIX item has been created on a case.

Status: 401 - Invalid authentication for this request.

Status: 404 - Requested parent not found or insufficient permissions to finds.

Status: default - Internal Server Error


createHistoricCaseData

Retroactively creates a data item on a case.


/case/{caseUuid}/history/data

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/case/{caseUuid}/history/data"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseApi;

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

public class CaseApiExample {

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

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

        CaseApi apiInstance = new CaseApi();
        CaseDataItemRequest body = ; // CaseDataItemRequest | The data item to create.
        String caseUuid = caseUuid_example; // String | The case to add to.
        try {
            dataStub result = apiInstance.createHistoricCaseData(body, caseUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#createHistoricCaseData");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseApi;

public class CaseApiExample {

    public static void main(String[] args) {
        CaseApi apiInstance = new CaseApi();
        CaseDataItemRequest body = ; // CaseDataItemRequest | The data item to create.
        String caseUuid = caseUuid_example; // String | The case to add to.
        try {
            dataStub result = apiInstance.createHistoricCaseData(body, caseUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#createHistoricCaseData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
CaseDataItemRequest *body = ; // The data item to create.
String *caseUuid = caseUuid_example; // The case to add to.

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

// Retroactively creates a data item on a case.
[apiInstance createHistoricCaseDataWith:body
    caseUuid:caseUuid
              completionHandler: ^(dataStub output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseApi()
var body = ; // {{CaseDataItemRequest}} The data item to create.
var caseUuid = caseUuid_example; // {{String}} The case to add to.

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

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

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

            var apiInstance = new CaseApi();
            var body = new CaseDataItemRequest(); // CaseDataItemRequest | The data item to create.
            var caseUuid = caseUuid_example;  // String | The case to add to.

            try
            {
                // Retroactively creates a data item on a case.
                dataStub result = apiInstance.createHistoricCaseData(body, caseUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseApi.createHistoricCaseData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCaseApi();
$body = ; // CaseDataItemRequest | The data item to create.
$caseUuid = caseUuid_example; // String | The case to add to.

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

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

my $api_instance = WWW::SwaggerClient::CaseApi->new();
my $body = WWW::SwaggerClient::Object::CaseDataItemRequest->new(); # CaseDataItemRequest | The data item to create.
my $caseUuid = caseUuid_example; # String | The case to add to.

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseApi()
body =  # CaseDataItemRequest | The data item to create.
caseUuid = caseUuid_example # String | The case to add to.

try: 
    # Retroactively creates a data item on a case.
    api_response = api_instance.create_historic_case_data(body, caseUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseApi->createHistoricCaseData: %s\n" % e)

Parameters

Path parameters
Name Description
caseUuid*
String
The case to add to.
Required
Body parameters
Name Description
body *

Responses

Status: 201 - The historic case data has been created.

Status: 400 - Failed to encrypt payload.

Status: 401 - Invalid authentication for this request.

Status: 403 - The request does not have authorisation.

Status: 404 - Requested case not found or insufficient permissions to finds.

Status: default - Internal Server Error


deleteCasePlaybook

Removes a playbook from a case.


/case/{caseUuid}/playbook/{casePlaybookUuid}

Usage and SDK Samples

curl -X DELETE\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/case/{caseUuid}/playbook/{casePlaybookUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseApi;

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

public class CaseApiExample {

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

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

        CaseApi apiInstance = new CaseApi();
        String caseUuid = caseUuid_example; // String | The UUID of the case to remove from.
        String casePlaybookUuid = casePlaybookUuid_example; // String | The UUID of the playbook to remove.
        try {
            apiInstance.deleteCasePlaybook(caseUuid, casePlaybookUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#deleteCasePlaybook");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseApi;

public class CaseApiExample {

    public static void main(String[] args) {
        CaseApi apiInstance = new CaseApi();
        String caseUuid = caseUuid_example; // String | The UUID of the case to remove from.
        String casePlaybookUuid = casePlaybookUuid_example; // String | The UUID of the playbook to remove.
        try {
            apiInstance.deleteCasePlaybook(caseUuid, casePlaybookUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#deleteCasePlaybook");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *caseUuid = caseUuid_example; // The UUID of the case to remove from.
String *casePlaybookUuid = casePlaybookUuid_example; // The UUID of the playbook to remove.

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

// Removes a playbook from a case.
[apiInstance deleteCasePlaybookWith:caseUuid
    casePlaybookUuid:casePlaybookUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseApi()
var caseUuid = caseUuid_example; // {{String}} The UUID of the case to remove from.
var casePlaybookUuid = casePlaybookUuid_example; // {{String}} The UUID of the playbook to remove.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteCasePlaybook(caseUuid, casePlaybookUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new CaseApi();
            var caseUuid = caseUuid_example;  // String | The UUID of the case to remove from.
            var casePlaybookUuid = casePlaybookUuid_example;  // String | The UUID of the playbook to remove.

            try
            {
                // Removes a playbook from a case.
                apiInstance.deleteCasePlaybook(caseUuid, casePlaybookUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseApi.deleteCasePlaybook: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCaseApi();
$caseUuid = caseUuid_example; // String | The UUID of the case to remove from.
$casePlaybookUuid = casePlaybookUuid_example; // String | The UUID of the playbook to remove.

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

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

my $api_instance = WWW::SwaggerClient::CaseApi->new();
my $caseUuid = caseUuid_example; # String | The UUID of the case to remove from.
my $casePlaybookUuid = casePlaybookUuid_example; # String | The UUID of the playbook to remove.

eval { 
    $api_instance->deleteCasePlaybook(caseUuid => $caseUuid, casePlaybookUuid => $casePlaybookUuid);
};
if ($@) {
    warn "Exception when calling CaseApi->deleteCasePlaybook: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseApi()
caseUuid = caseUuid_example # String | The UUID of the case to remove from.
casePlaybookUuid = casePlaybookUuid_example # String | The UUID of the playbook to remove.

try: 
    # Removes a playbook from a case.
    api_instance.delete_case_playbook(caseUuid, casePlaybookUuid)
except ApiException as e:
    print("Exception when calling CaseApi->deleteCasePlaybook: %s\n" % e)

Parameters

Path parameters
Name Description
caseUuid*
String
The UUID of the case to remove from.
Required
casePlaybookUuid*
String
The UUID of the playbook to remove.
Required

Responses

Status: 204 - The resource was deleted successfully.

Status: default - Internal Server Error


deleteCasePlaybookActionTag

Removes a tag from a case playbook action.


/case/{caseUuid}/playbook/{casePlaybookUuid}/action-instance/{actionInstanceUuid}/case-tag/{tagUuid}

Usage and SDK Samples

curl -X DELETE\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/case/{caseUuid}/playbook/{casePlaybookUuid}/action-instance/{actionInstanceUuid}/case-tag/{tagUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseApi;

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

public class CaseApiExample {

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

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

        CaseApi apiInstance = new CaseApi();
        String caseUuid = caseUuid_example; // String | The UUID of the case to remove from.
        String casePlaybookUuid = casePlaybookUuid_example; // String | The UUID of the playbook to remove.
        String actionInstanceUuid = actionInstanceUuid_example; // String | The UUID of the action instance to update.
        String tagUuid = tagUuid_example; // String | The UUID of the tag to remove.
        try {
            apiInstance.deleteCasePlaybookActionTag(caseUuid, casePlaybookUuid, actionInstanceUuid, tagUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#deleteCasePlaybookActionTag");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseApi;

public class CaseApiExample {

    public static void main(String[] args) {
        CaseApi apiInstance = new CaseApi();
        String caseUuid = caseUuid_example; // String | The UUID of the case to remove from.
        String casePlaybookUuid = casePlaybookUuid_example; // String | The UUID of the playbook to remove.
        String actionInstanceUuid = actionInstanceUuid_example; // String | The UUID of the action instance to update.
        String tagUuid = tagUuid_example; // String | The UUID of the tag to remove.
        try {
            apiInstance.deleteCasePlaybookActionTag(caseUuid, casePlaybookUuid, actionInstanceUuid, tagUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#deleteCasePlaybookActionTag");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *caseUuid = caseUuid_example; // The UUID of the case to remove from.
String *casePlaybookUuid = casePlaybookUuid_example; // The UUID of the playbook to remove.
String *actionInstanceUuid = actionInstanceUuid_example; // The UUID of the action instance to update.
String *tagUuid = tagUuid_example; // The UUID of the tag to remove.

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

// Removes a tag from a case playbook action.
[apiInstance deleteCasePlaybookActionTagWith:caseUuid
    casePlaybookUuid:casePlaybookUuid
    actionInstanceUuid:actionInstanceUuid
    tagUuid:tagUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseApi()
var caseUuid = caseUuid_example; // {{String}} The UUID of the case to remove from.
var casePlaybookUuid = casePlaybookUuid_example; // {{String}} The UUID of the playbook to remove.
var actionInstanceUuid = actionInstanceUuid_example; // {{String}} The UUID of the action instance to update.
var tagUuid = tagUuid_example; // {{String}} The UUID of the tag to remove.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteCasePlaybookActionTag(caseUuid, casePlaybookUuid, actionInstanceUuid, tagUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new CaseApi();
            var caseUuid = caseUuid_example;  // String | The UUID of the case to remove from.
            var casePlaybookUuid = casePlaybookUuid_example;  // String | The UUID of the playbook to remove.
            var actionInstanceUuid = actionInstanceUuid_example;  // String | The UUID of the action instance to update.
            var tagUuid = tagUuid_example;  // String | The UUID of the tag to remove.

            try
            {
                // Removes a tag from a case playbook action.
                apiInstance.deleteCasePlaybookActionTag(caseUuid, casePlaybookUuid, actionInstanceUuid, tagUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseApi.deleteCasePlaybookActionTag: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCaseApi();
$caseUuid = caseUuid_example; // String | The UUID of the case to remove from.
$casePlaybookUuid = casePlaybookUuid_example; // String | The UUID of the playbook to remove.
$actionInstanceUuid = actionInstanceUuid_example; // String | The UUID of the action instance to update.
$tagUuid = tagUuid_example; // String | The UUID of the tag to remove.

try {
    $api_instance->deleteCasePlaybookActionTag($caseUuid, $casePlaybookUuid, $actionInstanceUuid, $tagUuid);
} catch (Exception $e) {
    echo 'Exception when calling CaseApi->deleteCasePlaybookActionTag: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CaseApi;

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

my $api_instance = WWW::SwaggerClient::CaseApi->new();
my $caseUuid = caseUuid_example; # String | The UUID of the case to remove from.
my $casePlaybookUuid = casePlaybookUuid_example; # String | The UUID of the playbook to remove.
my $actionInstanceUuid = actionInstanceUuid_example; # String | The UUID of the action instance to update.
my $tagUuid = tagUuid_example; # String | The UUID of the tag to remove.

eval { 
    $api_instance->deleteCasePlaybookActionTag(caseUuid => $caseUuid, casePlaybookUuid => $casePlaybookUuid, actionInstanceUuid => $actionInstanceUuid, tagUuid => $tagUuid);
};
if ($@) {
    warn "Exception when calling CaseApi->deleteCasePlaybookActionTag: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseApi()
caseUuid = caseUuid_example # String | The UUID of the case to remove from.
casePlaybookUuid = casePlaybookUuid_example # String | The UUID of the playbook to remove.
actionInstanceUuid = actionInstanceUuid_example # String | The UUID of the action instance to update.
tagUuid = tagUuid_example # String | The UUID of the tag to remove.

try: 
    # Removes a tag from a case playbook action.
    api_instance.delete_case_playbook_action_tag(caseUuid, casePlaybookUuid, actionInstanceUuid, tagUuid)
except ApiException as e:
    print("Exception when calling CaseApi->deleteCasePlaybookActionTag: %s\n" % e)

Parameters

Path parameters
Name Description
caseUuid*
String
The UUID of the case to remove from.
Required
casePlaybookUuid*
String
The UUID of the playbook to remove.
Required
actionInstanceUuid*
String
The UUID of the action instance to update.
Required
tagUuid*
String
The UUID of the tag to remove.
Required

Responses

Status: 204 - The resource was deleted successfully.

Status: default - Internal Server Error


getActionInstanceData

GET a data item on a case or case playbook action.


/action-instance/{actionInstanceUuid}/data

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/action-instance/{actionInstanceUuid}/data"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseApi;

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

public class CaseApiExample {

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

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

        CaseApi apiInstance = new CaseApi();
        String actionInstanceUuid = actionInstanceUuid_example; // String | The case action instance to get from.
        try {
            array[dataStub] result = apiInstance.getActionInstanceData(actionInstanceUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#getActionInstanceData");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseApi;

public class CaseApiExample {

    public static void main(String[] args) {
        CaseApi apiInstance = new CaseApi();
        String actionInstanceUuid = actionInstanceUuid_example; // String | The case action instance to get from.
        try {
            array[dataStub] result = apiInstance.getActionInstanceData(actionInstanceUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#getActionInstanceData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *actionInstanceUuid = actionInstanceUuid_example; // The case action instance to get from.

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

// GET a data item on a case or case playbook action.
[apiInstance getActionInstanceDataWith:actionInstanceUuid
              completionHandler: ^(array[dataStub] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseApi()
var actionInstanceUuid = actionInstanceUuid_example; // {{String}} The case action instance to get from.

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

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

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

            var apiInstance = new CaseApi();
            var actionInstanceUuid = actionInstanceUuid_example;  // String | The case action instance to get from.

            try
            {
                // GET a data item on a case or case playbook action.
                array[dataStub] result = apiInstance.getActionInstanceData(actionInstanceUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseApi.getActionInstanceData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCaseApi();
$actionInstanceUuid = actionInstanceUuid_example; // String | The case action instance to get from.

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

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

my $api_instance = WWW::SwaggerClient::CaseApi->new();
my $actionInstanceUuid = actionInstanceUuid_example; # String | The case action instance to get from.

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseApi()
actionInstanceUuid = actionInstanceUuid_example # String | The case action instance to get from.

try: 
    # GET a data item on a case or case playbook action.
    api_response = api_instance.get_action_instance_data(actionInstanceUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseApi->getActionInstanceData: %s\n" % e)

Parameters

Path parameters
Name Description
actionInstanceUuid*
String
The case action instance to get from.
Required

Responses

Status: 200 - The case action data has been returned.

Status: 400 - Bad request.

Status: 401 - Invalid authentication for this request.

Status: 403 - The request does not have authorisation.

Status: 404 - Requested case not found or insufficient permissions to finds.

Status: default - Internal Server Error


getCase

Gets a case.


/case/{caseUuid}

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/case/{caseUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseApi;

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

public class CaseApiExample {

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

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

        CaseApi apiInstance = new CaseApi();
        String caseUuid = caseUuid_example; // String | The UUID of the case to retrieve.
        try {
            case result = apiInstance.getCase(caseUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#getCase");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseApi;

public class CaseApiExample {

    public static void main(String[] args) {
        CaseApi apiInstance = new CaseApi();
        String caseUuid = caseUuid_example; // String | The UUID of the case to retrieve.
        try {
            case result = apiInstance.getCase(caseUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#getCase");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *caseUuid = caseUuid_example; // The UUID of the case to retrieve.

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

// Gets a case.
[apiInstance getCaseWith:caseUuid
              completionHandler: ^(case output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseApi()
var caseUuid = caseUuid_example; // {{String}} The UUID of the case to retrieve.

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

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

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

            var apiInstance = new CaseApi();
            var caseUuid = caseUuid_example;  // String | The UUID of the case to retrieve.

            try
            {
                // Gets a case.
                case result = apiInstance.getCase(caseUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseApi.getCase: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCaseApi();
$caseUuid = caseUuid_example; // String | The UUID of the case to retrieve.

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

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

my $api_instance = WWW::SwaggerClient::CaseApi->new();
my $caseUuid = caseUuid_example; # String | The UUID of the case to retrieve.

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseApi()
caseUuid = caseUuid_example # String | The UUID of the case to retrieve.

try: 
    # Gets a case.
    api_response = api_instance.get_case(caseUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseApi->getCase: %s\n" % e)

Parameters

Path parameters
Name Description
caseUuid*
String
The UUID of the case to retrieve.
Required

Responses

Status: 200 - Fetched the case and transmitted in the message body.

Status: 401 - Invalid authentication for this request.

Status: 404 - Requested case not found or insufficient permissions to finds.

Status: default - Internal Server Error


getCaseActions

Gets a list of action for a case.


/case/{caseUuid}/action

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/case/{caseUuid}/action"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseApi;

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

public class CaseApiExample {

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

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

        CaseApi apiInstance = new CaseApi();
        String caseUuid = caseUuid_example; // String | The UUID of the case.
        try {
            array[playbookActionInstance] result = apiInstance.getCaseActions(caseUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#getCaseActions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseApi;

public class CaseApiExample {

    public static void main(String[] args) {
        CaseApi apiInstance = new CaseApi();
        String caseUuid = caseUuid_example; // String | The UUID of the case.
        try {
            array[playbookActionInstance] result = apiInstance.getCaseActions(caseUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#getCaseActions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *caseUuid = caseUuid_example; // The UUID of the case.

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

// Gets a list of action for a case.
[apiInstance getCaseActionsWith:caseUuid
              completionHandler: ^(array[playbookActionInstance] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseApi()
var caseUuid = caseUuid_example; // {{String}} The UUID of the case.

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

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

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

            var apiInstance = new CaseApi();
            var caseUuid = caseUuid_example;  // String | The UUID of the case.

            try
            {
                // Gets a list of action for a case.
                array[playbookActionInstance] result = apiInstance.getCaseActions(caseUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseApi.getCaseActions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCaseApi();
$caseUuid = caseUuid_example; // String | The UUID of the case.

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

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

my $api_instance = WWW::SwaggerClient::CaseApi->new();
my $caseUuid = caseUuid_example; # String | The UUID of the case.

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseApi()
caseUuid = caseUuid_example # String | The UUID of the case.

try: 
    # Gets a list of action for a case.
    api_response = api_instance.get_case_actions(caseUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseApi->getCaseActions: %s\n" % e)

Parameters

Path parameters
Name Description
caseUuid*
String
The UUID of the case.
Required

Responses

Status: 200 - Fetched list of actions and transmitted in the message body.

Status: default - Internal Server Error


getCaseByLocator

Gets a case by locator.


/case/locator/{locator}

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/case/locator/{locator}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseApi;

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

public class CaseApiExample {

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

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

        CaseApi apiInstance = new CaseApi();
        String locator = locator_example; // String | The locator of the case to retrieve.
        try {
            case result = apiInstance.getCaseByLocator(locator);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#getCaseByLocator");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseApi;

public class CaseApiExample {

    public static void main(String[] args) {
        CaseApi apiInstance = new CaseApi();
        String locator = locator_example; // String | The locator of the case to retrieve.
        try {
            case result = apiInstance.getCaseByLocator(locator);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#getCaseByLocator");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *locator = locator_example; // The locator of the case to retrieve.

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

// Gets a case by locator.
[apiInstance getCaseByLocatorWith:locator
              completionHandler: ^(case output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseApi()
var locator = locator_example; // {{String}} The locator of the case to retrieve.

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

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

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

            var apiInstance = new CaseApi();
            var locator = locator_example;  // String | The locator of the case to retrieve.

            try
            {
                // Gets a case by locator.
                case result = apiInstance.getCaseByLocator(locator);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseApi.getCaseByLocator: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCaseApi();
$locator = locator_example; // String | The locator of the case to retrieve.

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

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

my $api_instance = WWW::SwaggerClient::CaseApi->new();
my $locator = locator_example; # String | The locator of the case to retrieve.

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseApi()
locator = locator_example # String | The locator of the case to retrieve.

try: 
    # Gets a case by locator.
    api_response = api_instance.get_case_by_locator(locator)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseApi->getCaseByLocator: %s\n" % e)

Parameters

Path parameters
Name Description
locator*
String
The locator of the case to retrieve.
Required

Responses

Status: 200 - Fetched the the case by locator, and transmitted in the message body.

Status: 401 - Invalid authentication for this request.

Status: 404 - Requested case not found or insufficient permissions to finds.

Status: default - Internal Server Error


getCaseDataList

Gets a list of data items for a case.


/case/{caseUuid}/data

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/case/{caseUuid}/data"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseApi;

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

public class CaseApiExample {

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

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

        CaseApi apiInstance = new CaseApi();
        String caseUuid = caseUuid_example; // String | The case to get data for.
        try {
            array[caseAndActionDataStubList] result = apiInstance.getCaseDataList(caseUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#getCaseDataList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseApi;

public class CaseApiExample {

    public static void main(String[] args) {
        CaseApi apiInstance = new CaseApi();
        String caseUuid = caseUuid_example; // String | The case to get data for.
        try {
            array[caseAndActionDataStubList] result = apiInstance.getCaseDataList(caseUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#getCaseDataList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *caseUuid = caseUuid_example; // The case to get data for.

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

// Gets a list of data items for a case.
[apiInstance getCaseDataListWith:caseUuid
              completionHandler: ^(array[caseAndActionDataStubList] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseApi()
var caseUuid = caseUuid_example; // {{String}} The case to get data for.

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

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

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

            var apiInstance = new CaseApi();
            var caseUuid = caseUuid_example;  // String | The case to get data for.

            try
            {
                // Gets a list of data items for a case.
                array[caseAndActionDataStubList] result = apiInstance.getCaseDataList(caseUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseApi.getCaseDataList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCaseApi();
$caseUuid = caseUuid_example; // String | The case to get data for.

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

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

my $api_instance = WWW::SwaggerClient::CaseApi->new();
my $caseUuid = caseUuid_example; # String | The case to get data for.

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseApi()
caseUuid = caseUuid_example # String | The case to get data for.

try: 
    # Gets a list of data items for a case.
    api_response = api_instance.get_case_data_list(caseUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseApi->getCaseDataList: %s\n" % e)

Parameters

Path parameters
Name Description
caseUuid*
String
The case to get data for.
Required

Responses

Status: 200 - Fetched list of data items and transmitted in the message body.

Status: 401 - Invalid authentication for this request.

Status: 404 - Requested list of data items not found or insufficient permissions to finds.

Status: default - Internal Server Error


getCasePlaybook

Gets the status of each action, for a playbook on a given case.


/case/{caseUuid}/playbook/{casePlaybookUuid}

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/case/{caseUuid}/playbook/{casePlaybookUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseApi;

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

public class CaseApiExample {

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

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

        CaseApi apiInstance = new CaseApi();
        String caseUuid = caseUuid_example; // String | The UUID of the case.
        String casePlaybookUuid = casePlaybookUuid_example; // String | The UUID of the playbook.
        try {
            array[playbookActionInstance] result = apiInstance.getCasePlaybook(caseUuid, casePlaybookUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#getCasePlaybook");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseApi;

public class CaseApiExample {

    public static void main(String[] args) {
        CaseApi apiInstance = new CaseApi();
        String caseUuid = caseUuid_example; // String | The UUID of the case.
        String casePlaybookUuid = casePlaybookUuid_example; // String | The UUID of the playbook.
        try {
            array[playbookActionInstance] result = apiInstance.getCasePlaybook(caseUuid, casePlaybookUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#getCasePlaybook");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *caseUuid = caseUuid_example; // The UUID of the case.
String *casePlaybookUuid = casePlaybookUuid_example; // The UUID of the playbook.

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

// Gets the status of each action, for a playbook on a given case.
[apiInstance getCasePlaybookWith:caseUuid
    casePlaybookUuid:casePlaybookUuid
              completionHandler: ^(array[playbookActionInstance] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseApi()
var caseUuid = caseUuid_example; // {{String}} The UUID of the case.
var casePlaybookUuid = casePlaybookUuid_example; // {{String}} The UUID of the playbook.

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

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

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

            var apiInstance = new CaseApi();
            var caseUuid = caseUuid_example;  // String | The UUID of the case.
            var casePlaybookUuid = casePlaybookUuid_example;  // String | The UUID of the playbook.

            try
            {
                // Gets the status of each action, for a playbook on a given case.
                array[playbookActionInstance] result = apiInstance.getCasePlaybook(caseUuid, casePlaybookUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseApi.getCasePlaybook: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCaseApi();
$caseUuid = caseUuid_example; // String | The UUID of the case.
$casePlaybookUuid = casePlaybookUuid_example; // String | The UUID of the playbook.

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

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

my $api_instance = WWW::SwaggerClient::CaseApi->new();
my $caseUuid = caseUuid_example; # String | The UUID of the case.
my $casePlaybookUuid = casePlaybookUuid_example; # String | The UUID of the playbook.

eval { 
    my $result = $api_instance->getCasePlaybook(caseUuid => $caseUuid, casePlaybookUuid => $casePlaybookUuid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CaseApi->getCasePlaybook: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseApi()
caseUuid = caseUuid_example # String | The UUID of the case.
casePlaybookUuid = casePlaybookUuid_example # String | The UUID of the playbook.

try: 
    # Gets the status of each action, for a playbook on a given case.
    api_response = api_instance.get_case_playbook(caseUuid, casePlaybookUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseApi->getCasePlaybook: %s\n" % e)

Parameters

Path parameters
Name Description
caseUuid*
String
The UUID of the case.
Required
casePlaybookUuid*
String
The UUID of the playbook.
Required

Responses

Status: 200 - A list of playbook action instances has been fetched and is returned in the message body.

Status: default - Internal Server Error


getCasePlaybooks

Gets a list of playbooks for a case.


/case/{caseUuid}/playbook

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/case/{caseUuid}/playbook"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseApi;

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

public class CaseApiExample {

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

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

        CaseApi apiInstance = new CaseApi();
        String caseUuid = caseUuid_example; // String | The UUID of the case.
        try {
            array[atcPlaybook] result = apiInstance.getCasePlaybooks(caseUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#getCasePlaybooks");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseApi;

public class CaseApiExample {

    public static void main(String[] args) {
        CaseApi apiInstance = new CaseApi();
        String caseUuid = caseUuid_example; // String | The UUID of the case.
        try {
            array[atcPlaybook] result = apiInstance.getCasePlaybooks(caseUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#getCasePlaybooks");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *caseUuid = caseUuid_example; // The UUID of the case.

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

// Gets a list of playbooks for a case.
[apiInstance getCasePlaybooksWith:caseUuid
              completionHandler: ^(array[atcPlaybook] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseApi()
var caseUuid = caseUuid_example; // {{String}} The UUID of the case.

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

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

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

            var apiInstance = new CaseApi();
            var caseUuid = caseUuid_example;  // String | The UUID of the case.

            try
            {
                // Gets a list of playbooks for a case.
                array[atcPlaybook] result = apiInstance.getCasePlaybooks(caseUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseApi.getCasePlaybooks: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCaseApi();
$caseUuid = caseUuid_example; // String | The UUID of the case.

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

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

my $api_instance = WWW::SwaggerClient::CaseApi->new();
my $caseUuid = caseUuid_example; # String | The UUID of the case.

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseApi()
caseUuid = caseUuid_example # String | The UUID of the case.

try: 
    # Gets a list of playbooks for a case.
    api_response = api_instance.get_case_playbooks(caseUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseApi->getCasePlaybooks: %s\n" % e)

Parameters

Path parameters
Name Description
caseUuid*
String
The UUID of the case.
Required

Responses

Status: 200 - Fetched list of playbooks and transmitted in the message body.

Status: default - Internal Server Error


getCaseQuickSearch

Search cases.


/case/quick-search

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/case/quick-search"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseApi;

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

public class CaseApiExample {

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

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

        CaseApi apiInstance = new CaseApi();
        CaseQuickSearchRequest body = ; // CaseQuickSearchRequest | The terms to search for.
        try {
            quickSearchResult result = apiInstance.getCaseQuickSearch(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#getCaseQuickSearch");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseApi;

public class CaseApiExample {

    public static void main(String[] args) {
        CaseApi apiInstance = new CaseApi();
        CaseQuickSearchRequest body = ; // CaseQuickSearchRequest | The terms to search for.
        try {
            quickSearchResult result = apiInstance.getCaseQuickSearch(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#getCaseQuickSearch");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
CaseQuickSearchRequest *body = ; // The terms to search for.

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

// Search cases.
[apiInstance getCaseQuickSearchWith:body
              completionHandler: ^(quickSearchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseApi()
var body = ; // {{CaseQuickSearchRequest}} The terms to search for.

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

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

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

            var apiInstance = new CaseApi();
            var body = new CaseQuickSearchRequest(); // CaseQuickSearchRequest | The terms to search for.

            try
            {
                // Search cases.
                quickSearchResult result = apiInstance.getCaseQuickSearch(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseApi.getCaseQuickSearch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCaseApi();
$body = ; // CaseQuickSearchRequest | The terms to search for.

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

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

my $api_instance = WWW::SwaggerClient::CaseApi->new();
my $body = WWW::SwaggerClient::Object::CaseQuickSearchRequest->new(); # CaseQuickSearchRequest | The terms to search for.

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseApi()
body =  # CaseQuickSearchRequest | The terms to search for.

try: 
    # Search cases.
    api_response = api_instance.get_case_quick_search(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseApi->getCaseQuickSearch: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - The search results.

Status: 401 - Invalid authentication for this request.

Status: 403 - The request does not have authorisation.

Status: default - Internal Server Error


getCaseStix

Gets a list of STIX data items for a case.


/case/{caseUuid}/stix

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/case/{caseUuid}/stix"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseApi;

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

public class CaseApiExample {

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

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

        CaseApi apiInstance = new CaseApi();
        String caseUuid = caseUuid_example; // String | The case to fetch STIX data for.
        try {
            array[caseDataStixRequest] result = apiInstance.getCaseStix(caseUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#getCaseStix");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseApi;

public class CaseApiExample {

    public static void main(String[] args) {
        CaseApi apiInstance = new CaseApi();
        String caseUuid = caseUuid_example; // String | The case to fetch STIX data for.
        try {
            array[caseDataStixRequest] result = apiInstance.getCaseStix(caseUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#getCaseStix");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *caseUuid = caseUuid_example; // The case to fetch STIX data for.

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

// Gets a list of STIX data items for a case.
[apiInstance getCaseStixWith:caseUuid
              completionHandler: ^(array[caseDataStixRequest] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseApi()
var caseUuid = caseUuid_example; // {{String}} The case to fetch STIX data for.

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

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

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

            var apiInstance = new CaseApi();
            var caseUuid = caseUuid_example;  // String | The case to fetch STIX data for.

            try
            {
                // Gets a list of STIX data items for a case.
                array[caseDataStixRequest] result = apiInstance.getCaseStix(caseUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseApi.getCaseStix: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCaseApi();
$caseUuid = caseUuid_example; // String | The case to fetch STIX data for.

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

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

my $api_instance = WWW::SwaggerClient::CaseApi->new();
my $caseUuid = caseUuid_example; # String | The case to fetch STIX data for.

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseApi()
caseUuid = caseUuid_example # String | The case to fetch STIX data for.

try: 
    # Gets a list of STIX data items for a case.
    api_response = api_instance.get_case_stix(caseUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseApi->getCaseStix: %s\n" % e)

Parameters

Path parameters
Name Description
caseUuid*
String
The case to fetch STIX data for.
Required

Responses

Status: 200 - Fetched list of STIX data items and transmitted in the message body.

Status: 204 - There is no content to send for this request.

Status: 401 - Invalid authentication for this request.

Status: 404 - Requested list of STIX data items not found or insufficient permissions to finds.

Status: default - Internal Server Error


getCaseWatchers

Gets a list of watchers for a case.


/case/{caseUuid}/watch

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/case/{caseUuid}/watch"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseApi;

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

public class CaseApiExample {

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

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

        CaseApi apiInstance = new CaseApi();
        String caseUuid = caseUuid_example; // String | The case to add to.
        try {
            array[user] result = apiInstance.getCaseWatchers(caseUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#getCaseWatchers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseApi;

public class CaseApiExample {

    public static void main(String[] args) {
        CaseApi apiInstance = new CaseApi();
        String caseUuid = caseUuid_example; // String | The case to add to.
        try {
            array[user] result = apiInstance.getCaseWatchers(caseUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#getCaseWatchers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *caseUuid = caseUuid_example; // The case to add to.

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

// Gets a list of watchers for a case.
[apiInstance getCaseWatchersWith:caseUuid
              completionHandler: ^(array[user] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseApi()
var caseUuid = caseUuid_example; // {{String}} The case to add to.

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

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

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

            var apiInstance = new CaseApi();
            var caseUuid = caseUuid_example;  // String | The case to add to.

            try
            {
                // Gets a list of watchers for a case.
                array[user] result = apiInstance.getCaseWatchers(caseUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseApi.getCaseWatchers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCaseApi();
$caseUuid = caseUuid_example; // String | The case to add to.

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

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

my $api_instance = WWW::SwaggerClient::CaseApi->new();
my $caseUuid = caseUuid_example; # String | The case to add to.

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseApi()
caseUuid = caseUuid_example # String | The case to add to.

try: 
    # Gets a list of watchers for a case.
    api_response = api_instance.get_case_watchers(caseUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseApi->getCaseWatchers: %s\n" % e)

Parameters

Path parameters
Name Description
caseUuid*
String
The case to add to.
Required

Responses

Status: 200 - Fetched the list of users and transmitted in message body.

Status: default - Internal Server Error


getCasesFiltered

Gets a list of cases, using filtering and sorting.


/case

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/case?page[number]=&page[size]=&filter[create_start]=&filter[create_end]=&filter[mod_start]=&filter[mod_end]=&filter[state]=&filter[org]=&filter[assignee]=&filter[severity]=&filter[inc_tag]=&filter[exc_tag]=&filter[text]=&filter[parent_uuid]=&sort=&sort_dir="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseApi;

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

public class CaseApiExample {

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

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

        CaseApi apiInstance = new CaseApi();
        Integer page[number] = 56; // Integer | The page offset to retrieve.
        Integer page[size] = 56; // Integer | The number of items per page.
        String filter[createStart] = filter[createStart]_example; // String | Earliest creation timestamp
        String filter[createEnd] = filter[createEnd]_example; // String | Latest creation timestamp
        String filter[modStart] = filter[modStart]_example; // String | Earliest modification timestamp
        String filter[modEnd] = filter[modEnd]_example; // String | Latest modification timestamp
        String filter[state] = filter[state]_example; // String | Comma-delimited list of state names
        String filter[org] = filter[org]_example; // String | Comma-delimited list of org names
        String filter[assignee] = filter[assignee]_example; // String | Comma-delimited list of assignee names
        String filter[severity] = filter[severity]_example; // String | Comma-delimited list of severity names
        String filter[incTag] = filter[incTag]_example; // String | Comma-delimited list of tags to include
        String filter[excTag] = filter[excTag]_example; // String | Comma-delimited list of tags to exclude
        String filter[text] = filter[text]_example; // String | Text to search for in case locator, description, and metadata values
        String filter[parentUuid] = filter[parentUuid]_example; // String | Comma-delimited list of parent case uuids
        String sort = sort_example; // String | Field to sort on, one of: description, created, modified, org, assignee, status, severity, severity_name, min_sla_name, min_sla_seconds, closed, actions, completed_actions
        String sortDir = sortDir_example; // String | Sort direction, one of asc or desc
        try {
            caseListQueryResponse result = apiInstance.getCasesFiltered(page[number], page[size], filter[createStart], filter[createEnd], filter[modStart], filter[modEnd], filter[state], filter[org], filter[assignee], filter[severity], filter[incTag], filter[excTag], filter[text], filter[parentUuid], sort, sortDir);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#getCasesFiltered");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseApi;

public class CaseApiExample {

    public static void main(String[] args) {
        CaseApi apiInstance = new CaseApi();
        Integer page[number] = 56; // Integer | The page offset to retrieve.
        Integer page[size] = 56; // Integer | The number of items per page.
        String filter[createStart] = filter[createStart]_example; // String | Earliest creation timestamp
        String filter[createEnd] = filter[createEnd]_example; // String | Latest creation timestamp
        String filter[modStart] = filter[modStart]_example; // String | Earliest modification timestamp
        String filter[modEnd] = filter[modEnd]_example; // String | Latest modification timestamp
        String filter[state] = filter[state]_example; // String | Comma-delimited list of state names
        String filter[org] = filter[org]_example; // String | Comma-delimited list of org names
        String filter[assignee] = filter[assignee]_example; // String | Comma-delimited list of assignee names
        String filter[severity] = filter[severity]_example; // String | Comma-delimited list of severity names
        String filter[incTag] = filter[incTag]_example; // String | Comma-delimited list of tags to include
        String filter[excTag] = filter[excTag]_example; // String | Comma-delimited list of tags to exclude
        String filter[text] = filter[text]_example; // String | Text to search for in case locator, description, and metadata values
        String filter[parentUuid] = filter[parentUuid]_example; // String | Comma-delimited list of parent case uuids
        String sort = sort_example; // String | Field to sort on, one of: description, created, modified, org, assignee, status, severity, severity_name, min_sla_name, min_sla_seconds, closed, actions, completed_actions
        String sortDir = sortDir_example; // String | Sort direction, one of asc or desc
        try {
            caseListQueryResponse result = apiInstance.getCasesFiltered(page[number], page[size], filter[createStart], filter[createEnd], filter[modStart], filter[modEnd], filter[state], filter[org], filter[assignee], filter[severity], filter[incTag], filter[excTag], filter[text], filter[parentUuid], sort, sortDir);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#getCasesFiltered");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
Integer *page[number] = 56; // The page offset to retrieve.
Integer *page[size] = 56; // The number of items per page.
String *filter[createStart] = filter[createStart]_example; // Earliest creation timestamp (optional)
String *filter[createEnd] = filter[createEnd]_example; // Latest creation timestamp (optional)
String *filter[modStart] = filter[modStart]_example; // Earliest modification timestamp (optional)
String *filter[modEnd] = filter[modEnd]_example; // Latest modification timestamp (optional)
String *filter[state] = filter[state]_example; // Comma-delimited list of state names (optional)
String *filter[org] = filter[org]_example; // Comma-delimited list of org names (optional)
String *filter[assignee] = filter[assignee]_example; // Comma-delimited list of assignee names (optional)
String *filter[severity] = filter[severity]_example; // Comma-delimited list of severity names (optional)
String *filter[incTag] = filter[incTag]_example; // Comma-delimited list of tags to include (optional)
String *filter[excTag] = filter[excTag]_example; // Comma-delimited list of tags to exclude (optional)
String *filter[text] = filter[text]_example; // Text to search for in case locator, description, and metadata values (optional)
String *filter[parentUuid] = filter[parentUuid]_example; // Comma-delimited list of parent case uuids (optional)
String *sort = sort_example; // Field to sort on, one of: description, created, modified, org, assignee, status, severity, severity_name, min_sla_name, min_sla_seconds, closed, actions, completed_actions (optional)
String *sortDir = sortDir_example; // Sort direction, one of asc or desc (optional)

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

// Gets a list of cases, using filtering and sorting.
[apiInstance getCasesFilteredWith:page[number]
    page[size]:page[size]
    filter[createStart]:filter[createStart]
    filter[createEnd]:filter[createEnd]
    filter[modStart]:filter[modStart]
    filter[modEnd]:filter[modEnd]
    filter[state]:filter[state]
    filter[org]:filter[org]
    filter[assignee]:filter[assignee]
    filter[severity]:filter[severity]
    filter[incTag]:filter[incTag]
    filter[excTag]:filter[excTag]
    filter[text]:filter[text]
    filter[parentUuid]:filter[parentUuid]
    sort:sort
    sortDir:sortDir
              completionHandler: ^(caseListQueryResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseApi()
var page[number] = 56; // {{Integer}} The page offset to retrieve.
var page[size] = 56; // {{Integer}} The number of items per page.
var opts = { 
  'filter[createStart]': filter[createStart]_example, // {{String}} Earliest creation timestamp
  'filter[createEnd]': filter[createEnd]_example, // {{String}} Latest creation timestamp
  'filter[modStart]': filter[modStart]_example, // {{String}} Earliest modification timestamp
  'filter[modEnd]': filter[modEnd]_example, // {{String}} Latest modification timestamp
  'filter[state]': filter[state]_example, // {{String}} Comma-delimited list of state names
  'filter[org]': filter[org]_example, // {{String}} Comma-delimited list of org names
  'filter[assignee]': filter[assignee]_example, // {{String}} Comma-delimited list of assignee names
  'filter[severity]': filter[severity]_example, // {{String}} Comma-delimited list of severity names
  'filter[incTag]': filter[incTag]_example, // {{String}} Comma-delimited list of tags to include
  'filter[excTag]': filter[excTag]_example, // {{String}} Comma-delimited list of tags to exclude
  'filter[text]': filter[text]_example, // {{String}} Text to search for in case locator, description, and metadata values
  'filter[parentUuid]': filter[parentUuid]_example, // {{String}} Comma-delimited list of parent case uuids
  'sort': sort_example, // {{String}} Field to sort on, one of: description, created, modified, org, assignee, status, severity, severity_name, min_sla_name, min_sla_seconds, closed, actions, completed_actions
  'sortDir': sortDir_example // {{String}} Sort direction, one of asc or desc
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCasesFiltered(page[number], page[size], opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new CaseApi();
            var page[number] = 56;  // Integer | The page offset to retrieve.
            var page[size] = 56;  // Integer | The number of items per page.
            var filter[createStart] = filter[createStart]_example;  // String | Earliest creation timestamp (optional) 
            var filter[createEnd] = filter[createEnd]_example;  // String | Latest creation timestamp (optional) 
            var filter[modStart] = filter[modStart]_example;  // String | Earliest modification timestamp (optional) 
            var filter[modEnd] = filter[modEnd]_example;  // String | Latest modification timestamp (optional) 
            var filter[state] = filter[state]_example;  // String | Comma-delimited list of state names (optional) 
            var filter[org] = filter[org]_example;  // String | Comma-delimited list of org names (optional) 
            var filter[assignee] = filter[assignee]_example;  // String | Comma-delimited list of assignee names (optional) 
            var filter[severity] = filter[severity]_example;  // String | Comma-delimited list of severity names (optional) 
            var filter[incTag] = filter[incTag]_example;  // String | Comma-delimited list of tags to include (optional) 
            var filter[excTag] = filter[excTag]_example;  // String | Comma-delimited list of tags to exclude (optional) 
            var filter[text] = filter[text]_example;  // String | Text to search for in case locator, description, and metadata values (optional) 
            var filter[parentUuid] = filter[parentUuid]_example;  // String | Comma-delimited list of parent case uuids (optional) 
            var sort = sort_example;  // String | Field to sort on, one of: description, created, modified, org, assignee, status, severity, severity_name, min_sla_name, min_sla_seconds, closed, actions, completed_actions (optional) 
            var sortDir = sortDir_example;  // String | Sort direction, one of asc or desc (optional) 

            try
            {
                // Gets a list of cases, using filtering and sorting.
                caseListQueryResponse result = apiInstance.getCasesFiltered(page[number], page[size], filter[createStart], filter[createEnd], filter[modStart], filter[modEnd], filter[state], filter[org], filter[assignee], filter[severity], filter[incTag], filter[excTag], filter[text], filter[parentUuid], sort, sortDir);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseApi.getCasesFiltered: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCaseApi();
$page[number] = 56; // Integer | The page offset to retrieve.
$page[size] = 56; // Integer | The number of items per page.
$filter[createStart] = filter[createStart]_example; // String | Earliest creation timestamp
$filter[createEnd] = filter[createEnd]_example; // String | Latest creation timestamp
$filter[modStart] = filter[modStart]_example; // String | Earliest modification timestamp
$filter[modEnd] = filter[modEnd]_example; // String | Latest modification timestamp
$filter[state] = filter[state]_example; // String | Comma-delimited list of state names
$filter[org] = filter[org]_example; // String | Comma-delimited list of org names
$filter[assignee] = filter[assignee]_example; // String | Comma-delimited list of assignee names
$filter[severity] = filter[severity]_example; // String | Comma-delimited list of severity names
$filter[incTag] = filter[incTag]_example; // String | Comma-delimited list of tags to include
$filter[excTag] = filter[excTag]_example; // String | Comma-delimited list of tags to exclude
$filter[text] = filter[text]_example; // String | Text to search for in case locator, description, and metadata values
$filter[parentUuid] = filter[parentUuid]_example; // String | Comma-delimited list of parent case uuids
$sort = sort_example; // String | Field to sort on, one of: description, created, modified, org, assignee, status, severity, severity_name, min_sla_name, min_sla_seconds, closed, actions, completed_actions
$sortDir = sortDir_example; // String | Sort direction, one of asc or desc

try {
    $result = $api_instance->getCasesFiltered($page[number], $page[size], $filter[createStart], $filter[createEnd], $filter[modStart], $filter[modEnd], $filter[state], $filter[org], $filter[assignee], $filter[severity], $filter[incTag], $filter[excTag], $filter[text], $filter[parentUuid], $sort, $sortDir);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CaseApi->getCasesFiltered: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CaseApi;

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

my $api_instance = WWW::SwaggerClient::CaseApi->new();
my $page[number] = 56; # Integer | The page offset to retrieve.
my $page[size] = 56; # Integer | The number of items per page.
my $filter[createStart] = filter[createStart]_example; # String | Earliest creation timestamp
my $filter[createEnd] = filter[createEnd]_example; # String | Latest creation timestamp
my $filter[modStart] = filter[modStart]_example; # String | Earliest modification timestamp
my $filter[modEnd] = filter[modEnd]_example; # String | Latest modification timestamp
my $filter[state] = filter[state]_example; # String | Comma-delimited list of state names
my $filter[org] = filter[org]_example; # String | Comma-delimited list of org names
my $filter[assignee] = filter[assignee]_example; # String | Comma-delimited list of assignee names
my $filter[severity] = filter[severity]_example; # String | Comma-delimited list of severity names
my $filter[incTag] = filter[incTag]_example; # String | Comma-delimited list of tags to include
my $filter[excTag] = filter[excTag]_example; # String | Comma-delimited list of tags to exclude
my $filter[text] = filter[text]_example; # String | Text to search for in case locator, description, and metadata values
my $filter[parentUuid] = filter[parentUuid]_example; # String | Comma-delimited list of parent case uuids
my $sort = sort_example; # String | Field to sort on, one of: description, created, modified, org, assignee, status, severity, severity_name, min_sla_name, min_sla_seconds, closed, actions, completed_actions
my $sortDir = sortDir_example; # String | Sort direction, one of asc or desc

eval { 
    my $result = $api_instance->getCasesFiltered(page[number] => $page[number], page[size] => $page[size], filter[createStart] => $filter[createStart], filter[createEnd] => $filter[createEnd], filter[modStart] => $filter[modStart], filter[modEnd] => $filter[modEnd], filter[state] => $filter[state], filter[org] => $filter[org], filter[assignee] => $filter[assignee], filter[severity] => $filter[severity], filter[incTag] => $filter[incTag], filter[excTag] => $filter[excTag], filter[text] => $filter[text], filter[parentUuid] => $filter[parentUuid], sort => $sort, sortDir => $sortDir);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CaseApi->getCasesFiltered: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseApi()
page[number] = 56 # Integer | The page offset to retrieve.
page[size] = 56 # Integer | The number of items per page.
filter[createStart] = filter[createStart]_example # String | Earliest creation timestamp (optional)
filter[createEnd] = filter[createEnd]_example # String | Latest creation timestamp (optional)
filter[modStart] = filter[modStart]_example # String | Earliest modification timestamp (optional)
filter[modEnd] = filter[modEnd]_example # String | Latest modification timestamp (optional)
filter[state] = filter[state]_example # String | Comma-delimited list of state names (optional)
filter[org] = filter[org]_example # String | Comma-delimited list of org names (optional)
filter[assignee] = filter[assignee]_example # String | Comma-delimited list of assignee names (optional)
filter[severity] = filter[severity]_example # String | Comma-delimited list of severity names (optional)
filter[incTag] = filter[incTag]_example # String | Comma-delimited list of tags to include (optional)
filter[excTag] = filter[excTag]_example # String | Comma-delimited list of tags to exclude (optional)
filter[text] = filter[text]_example # String | Text to search for in case locator, description, and metadata values (optional)
filter[parentUuid] = filter[parentUuid]_example # String | Comma-delimited list of parent case uuids (optional)
sort = sort_example # String | Field to sort on, one of: description, created, modified, org, assignee, status, severity, severity_name, min_sla_name, min_sla_seconds, closed, actions, completed_actions (optional)
sortDir = sortDir_example # String | Sort direction, one of asc or desc (optional)

try: 
    # Gets a list of cases, using filtering and sorting.
    api_response = api_instance.get_cases_filtered(page[number], page[size], filter[createStart]=filter[createStart], filter[createEnd]=filter[createEnd], filter[modStart]=filter[modStart], filter[modEnd]=filter[modEnd], filter[state]=filter[state], filter[org]=filter[org], filter[assignee]=filter[assignee], filter[severity]=filter[severity], filter[incTag]=filter[incTag], filter[excTag]=filter[excTag], filter[text]=filter[text], filter[parentUuid]=filter[parentUuid], sort=sort, sortDir=sortDir)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseApi->getCasesFiltered: %s\n" % e)

Parameters

Query parameters
Name Description
page[number]*
Integer
The page offset to retrieve.
Required
page[size]*
Integer
The number of items per page.
Required
filter[create_start]
String
Earliest creation timestamp
filter[create_end]
String
Latest creation timestamp
filter[mod_start]
String
Earliest modification timestamp
filter[mod_end]
String
Latest modification timestamp
filter[state]
String
Comma-delimited list of state names
filter[org]
String
Comma-delimited list of org names
filter[assignee]
String
Comma-delimited list of assignee names
filter[severity]
String
Comma-delimited list of severity names
filter[inc_tag]
String
Comma-delimited list of tags to include
filter[exc_tag]
String
Comma-delimited list of tags to exclude
filter[text]
String
Text to search for in case locator, description, and metadata values
filter[parent_uuid]
String
Comma-delimited list of parent case uuids
sort
String
Field to sort on, one of: description, created, modified, org, assignee, status, severity, severity_name, min_sla_name, min_sla_seconds, closed, actions, completed_actions
sort_dir
String
Sort direction, one of asc or desc

Responses

Status: 200 - Fetched the list of cases and transmitted in the message body.

Status: 401 - Invalid authentication for this request.

Status: default - Internal Server Error


getGroupsContainingCase

Returns the UUID of all case groups that contain a given case


/case/{caseUuid}/member

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/case/{caseUuid}/member"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseApi;

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

public class CaseApiExample {

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

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

        CaseApi apiInstance = new CaseApi();
        String caseUuid = caseUuid_example; // String | The UUID of the case.
        try {
            array['String'] result = apiInstance.getGroupsContainingCase(caseUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#getGroupsContainingCase");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseApi;

public class CaseApiExample {

    public static void main(String[] args) {
        CaseApi apiInstance = new CaseApi();
        String caseUuid = caseUuid_example; // String | The UUID of the case.
        try {
            array['String'] result = apiInstance.getGroupsContainingCase(caseUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#getGroupsContainingCase");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *caseUuid = caseUuid_example; // The UUID of the case.

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

[apiInstance getGroupsContainingCaseWith:caseUuid
              completionHandler: ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseApi()
var caseUuid = caseUuid_example; // {{String}} The UUID of the case.

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

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

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

            var apiInstance = new CaseApi();
            var caseUuid = caseUuid_example;  // String | The UUID of the case.

            try
            {
                array['String'] result = apiInstance.getGroupsContainingCase(caseUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseApi.getGroupsContainingCase: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCaseApi();
$caseUuid = caseUuid_example; // String | The UUID of the case.

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

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

my $api_instance = WWW::SwaggerClient::CaseApi->new();
my $caseUuid = caseUuid_example; # String | The UUID of the case.

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseApi()
caseUuid = caseUuid_example # String | The UUID of the case.

try: 
    api_response = api_instance.get_groups_containing_case(caseUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseApi->getGroupsContainingCase: %s\n" % e)

Parameters

Path parameters
Name Description
caseUuid*
String
The UUID of the case.
Required

Responses

Status: 200 - Fetched the list of case group UUIDs and transmitted in the message body.

Status: 400 - caseUuid does not represent a valid UUID.

Status: 404 - Requested case not found or insufficient permissions to find.

Status: default - Internal Server Error


putCasePlaybookAction

Updates a playbook action for a given playbook on a given case.


/case/{caseUuid}/playbook/{casePlaybookUuid}/action-instance/{actionInstanceUuid}

Usage and SDK Samples

curl -X PUT\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/case/{caseUuid}/playbook/{casePlaybookUuid}/action-instance/{actionInstanceUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseApi;

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

public class CaseApiExample {

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

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

        CaseApi apiInstance = new CaseApi();
        CasePlaybookActionUpdateRequest body = ; // CasePlaybookActionUpdateRequest | The action update request
        String caseUuid = caseUuid_example; // String | The UUID of the case to update.
        String casePlaybookUuid = casePlaybookUuid_example; // String | The UUID of the playbook to update.
        String actionInstanceUuid = actionInstanceUuid_example; // String | The UUID of the action instance to update.
        try {
            apiInstance.putCasePlaybookAction(body, caseUuid, casePlaybookUuid, actionInstanceUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#putCasePlaybookAction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseApi;

public class CaseApiExample {

    public static void main(String[] args) {
        CaseApi apiInstance = new CaseApi();
        CasePlaybookActionUpdateRequest body = ; // CasePlaybookActionUpdateRequest | The action update request
        String caseUuid = caseUuid_example; // String | The UUID of the case to update.
        String casePlaybookUuid = casePlaybookUuid_example; // String | The UUID of the playbook to update.
        String actionInstanceUuid = actionInstanceUuid_example; // String | The UUID of the action instance to update.
        try {
            apiInstance.putCasePlaybookAction(body, caseUuid, casePlaybookUuid, actionInstanceUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#putCasePlaybookAction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
CasePlaybookActionUpdateRequest *body = ; // The action update request
String *caseUuid = caseUuid_example; // The UUID of the case to update.
String *casePlaybookUuid = casePlaybookUuid_example; // The UUID of the playbook to update.
String *actionInstanceUuid = actionInstanceUuid_example; // The UUID of the action instance to update.

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

// Updates a playbook action for a given playbook on a given case.
[apiInstance putCasePlaybookActionWith:body
    caseUuid:caseUuid
    casePlaybookUuid:casePlaybookUuid
    actionInstanceUuid:actionInstanceUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseApi()
var body = ; // {{CasePlaybookActionUpdateRequest}} The action update request
var caseUuid = caseUuid_example; // {{String}} The UUID of the case to update.
var casePlaybookUuid = casePlaybookUuid_example; // {{String}} The UUID of the playbook to update.
var actionInstanceUuid = actionInstanceUuid_example; // {{String}} The UUID of the action instance to update.

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

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

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

            var apiInstance = new CaseApi();
            var body = new CasePlaybookActionUpdateRequest(); // CasePlaybookActionUpdateRequest | The action update request
            var caseUuid = caseUuid_example;  // String | The UUID of the case to update.
            var casePlaybookUuid = casePlaybookUuid_example;  // String | The UUID of the playbook to update.
            var actionInstanceUuid = actionInstanceUuid_example;  // String | The UUID of the action instance to update.

            try
            {
                // Updates a playbook action for a given playbook on a given case.
                apiInstance.putCasePlaybookAction(body, caseUuid, casePlaybookUuid, actionInstanceUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseApi.putCasePlaybookAction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCaseApi();
$body = ; // CasePlaybookActionUpdateRequest | The action update request
$caseUuid = caseUuid_example; // String | The UUID of the case to update.
$casePlaybookUuid = casePlaybookUuid_example; // String | The UUID of the playbook to update.
$actionInstanceUuid = actionInstanceUuid_example; // String | The UUID of the action instance to update.

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

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

my $api_instance = WWW::SwaggerClient::CaseApi->new();
my $body = WWW::SwaggerClient::Object::CasePlaybookActionUpdateRequest->new(); # CasePlaybookActionUpdateRequest | The action update request
my $caseUuid = caseUuid_example; # String | The UUID of the case to update.
my $casePlaybookUuid = casePlaybookUuid_example; # String | The UUID of the playbook to update.
my $actionInstanceUuid = actionInstanceUuid_example; # String | The UUID of the action instance to update.

eval { 
    $api_instance->putCasePlaybookAction(body => $body, caseUuid => $caseUuid, casePlaybookUuid => $casePlaybookUuid, actionInstanceUuid => $actionInstanceUuid);
};
if ($@) {
    warn "Exception when calling CaseApi->putCasePlaybookAction: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseApi()
body =  # CasePlaybookActionUpdateRequest | The action update request
caseUuid = caseUuid_example # String | The UUID of the case to update.
casePlaybookUuid = casePlaybookUuid_example # String | The UUID of the playbook to update.
actionInstanceUuid = actionInstanceUuid_example # String | The UUID of the action instance to update.

try: 
    # Updates a playbook action for a given playbook on a given case.
    api_instance.put_case_playbook_action(body, caseUuid, casePlaybookUuid, actionInstanceUuid)
except ApiException as e:
    print("Exception when calling CaseApi->putCasePlaybookAction: %s\n" % e)

Parameters

Path parameters
Name Description
caseUuid*
String
The UUID of the case to update.
Required
casePlaybookUuid*
String
The UUID of the playbook to update.
Required
actionInstanceUuid*
String
The UUID of the action instance to update.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - Playbook was updated successfully.

Status: default - Internal Server Error


removeCaseAction

Remove an action from a case.


/case/{caseUuid}/action-instance/{actionInstanceUuid}

Usage and SDK Samples

curl -X DELETE\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/case/{caseUuid}/action-instance/{actionInstanceUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseApi;

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

public class CaseApiExample {

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

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

        CaseApi apiInstance = new CaseApi();
        String caseUuid = caseUuid_example; // String | The UUID of the case.
        String actionInstanceUuid = actionInstanceUuid_example; // String | The UUID of the action instance to update.
        try {
            apiInstance.removeCaseAction(caseUuid, actionInstanceUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#removeCaseAction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseApi;

public class CaseApiExample {

    public static void main(String[] args) {
        CaseApi apiInstance = new CaseApi();
        String caseUuid = caseUuid_example; // String | The UUID of the case.
        String actionInstanceUuid = actionInstanceUuid_example; // String | The UUID of the action instance to update.
        try {
            apiInstance.removeCaseAction(caseUuid, actionInstanceUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#removeCaseAction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *caseUuid = caseUuid_example; // The UUID of the case.
String *actionInstanceUuid = actionInstanceUuid_example; // The UUID of the action instance to update.

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

// Remove an action from a case.
[apiInstance removeCaseActionWith:caseUuid
    actionInstanceUuid:actionInstanceUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseApi()
var caseUuid = caseUuid_example; // {{String}} The UUID of the case.
var actionInstanceUuid = actionInstanceUuid_example; // {{String}} The UUID of the action instance to update.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeCaseAction(caseUuid, actionInstanceUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new CaseApi();
            var caseUuid = caseUuid_example;  // String | The UUID of the case.
            var actionInstanceUuid = actionInstanceUuid_example;  // String | The UUID of the action instance to update.

            try
            {
                // Remove an action from a case.
                apiInstance.removeCaseAction(caseUuid, actionInstanceUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseApi.removeCaseAction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCaseApi();
$caseUuid = caseUuid_example; // String | The UUID of the case.
$actionInstanceUuid = actionInstanceUuid_example; // String | The UUID of the action instance to update.

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

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

my $api_instance = WWW::SwaggerClient::CaseApi->new();
my $caseUuid = caseUuid_example; # String | The UUID of the case.
my $actionInstanceUuid = actionInstanceUuid_example; # String | The UUID of the action instance to update.

eval { 
    $api_instance->removeCaseAction(caseUuid => $caseUuid, actionInstanceUuid => $actionInstanceUuid);
};
if ($@) {
    warn "Exception when calling CaseApi->removeCaseAction: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseApi()
caseUuid = caseUuid_example # String | The UUID of the case.
actionInstanceUuid = actionInstanceUuid_example # String | The UUID of the action instance to update.

try: 
    # Remove an action from a case.
    api_instance.remove_case_action(caseUuid, actionInstanceUuid)
except ApiException as e:
    print("Exception when calling CaseApi->removeCaseAction: %s\n" % e)

Parameters

Path parameters
Name Description
caseUuid*
String
The UUID of the case.
Required
actionInstanceUuid*
String
The UUID of the action instance to update.
Required

Responses

Status: 204 - The resource was deleted successfully.

Status: default - Internal Server Error


updateCase

Updates a case.


/case/{caseUuid}

Usage and SDK Samples

curl -X PUT\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/case/{caseUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseApi;

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

public class CaseApiExample {

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

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

        CaseApi apiInstance = new CaseApi();
        Case body = ; // Case | The case to update.
        String caseUuid = caseUuid_example; // String | The UUID of the case to update.
        try {
            apiInstance.updateCase(body, caseUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#updateCase");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseApi;

public class CaseApiExample {

    public static void main(String[] args) {
        CaseApi apiInstance = new CaseApi();
        Case body = ; // Case | The case to update.
        String caseUuid = caseUuid_example; // String | The UUID of the case to update.
        try {
            apiInstance.updateCase(body, caseUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#updateCase");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
Case *body = ; // The case to update.
String *caseUuid = caseUuid_example; // The UUID of the case to update.

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

// Updates a case.
[apiInstance updateCaseWith:body
    caseUuid:caseUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseApi()
var body = ; // {{Case}} The case to update.
var caseUuid = caseUuid_example; // {{String}} The UUID of the case to update.

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

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

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

            var apiInstance = new CaseApi();
            var body = new Case(); // Case | The case to update.
            var caseUuid = caseUuid_example;  // String | The UUID of the case to update.

            try
            {
                // Updates a case.
                apiInstance.updateCase(body, caseUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseApi.updateCase: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCaseApi();
$body = ; // Case | The case to update.
$caseUuid = caseUuid_example; // String | The UUID of the case to update.

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

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

my $api_instance = WWW::SwaggerClient::CaseApi->new();
my $body = WWW::SwaggerClient::Object::Case->new(); # Case | The case to update.
my $caseUuid = caseUuid_example; # String | The UUID of the case to update.

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseApi()
body =  # Case | The case to update.
caseUuid = caseUuid_example # String | The UUID of the case to update.

try: 
    # Updates a case.
    api_instance.update_case(body, caseUuid)
except ApiException as e:
    print("Exception when calling CaseApi->updateCase: %s\n" % e)

Parameters

Path parameters
Name Description
caseUuid*
String
The UUID of the case to update.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - The case was updated successfully.

Status: 401 - Not authorised to update case.

Status: 403 - The request does not have authorisation.

Status: 404 - Requested case not found or insufficient permissions to finds.

Status: default - Internal Server Error


updateCaseAction

Update an action for a case.


/case/{caseUuid}/action-instance/{actionInstanceUuid}

Usage and SDK Samples

curl -X PUT\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/case/{caseUuid}/action-instance/{actionInstanceUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseApi;

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

public class CaseApiExample {

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

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

        CaseApi apiInstance = new CaseApi();
        CasePlaybookActionUpdateRequest body = ; // CasePlaybookActionUpdateRequest | The action update request
        String caseUuid = caseUuid_example; // String | The UUID of the case.
        String actionInstanceUuid = actionInstanceUuid_example; // String | The UUID of the action instance to update.
        try {
            apiInstance.updateCaseAction(body, caseUuid, actionInstanceUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#updateCaseAction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseApi;

public class CaseApiExample {

    public static void main(String[] args) {
        CaseApi apiInstance = new CaseApi();
        CasePlaybookActionUpdateRequest body = ; // CasePlaybookActionUpdateRequest | The action update request
        String caseUuid = caseUuid_example; // String | The UUID of the case.
        String actionInstanceUuid = actionInstanceUuid_example; // String | The UUID of the action instance to update.
        try {
            apiInstance.updateCaseAction(body, caseUuid, actionInstanceUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#updateCaseAction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
CasePlaybookActionUpdateRequest *body = ; // The action update request
String *caseUuid = caseUuid_example; // The UUID of the case.
String *actionInstanceUuid = actionInstanceUuid_example; // The UUID of the action instance to update.

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

// Update an action for a case.
[apiInstance updateCaseActionWith:body
    caseUuid:caseUuid
    actionInstanceUuid:actionInstanceUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseApi()
var body = ; // {{CasePlaybookActionUpdateRequest}} The action update request
var caseUuid = caseUuid_example; // {{String}} The UUID of the case.
var actionInstanceUuid = actionInstanceUuid_example; // {{String}} The UUID of the action instance to update.

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

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

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

            var apiInstance = new CaseApi();
            var body = new CasePlaybookActionUpdateRequest(); // CasePlaybookActionUpdateRequest | The action update request
            var caseUuid = caseUuid_example;  // String | The UUID of the case.
            var actionInstanceUuid = actionInstanceUuid_example;  // String | The UUID of the action instance to update.

            try
            {
                // Update an action for a case.
                apiInstance.updateCaseAction(body, caseUuid, actionInstanceUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseApi.updateCaseAction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCaseApi();
$body = ; // CasePlaybookActionUpdateRequest | The action update request
$caseUuid = caseUuid_example; // String | The UUID of the case.
$actionInstanceUuid = actionInstanceUuid_example; // String | The UUID of the action instance to update.

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

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

my $api_instance = WWW::SwaggerClient::CaseApi->new();
my $body = WWW::SwaggerClient::Object::CasePlaybookActionUpdateRequest->new(); # CasePlaybookActionUpdateRequest | The action update request
my $caseUuid = caseUuid_example; # String | The UUID of the case.
my $actionInstanceUuid = actionInstanceUuid_example; # String | The UUID of the action instance to update.

eval { 
    $api_instance->updateCaseAction(body => $body, caseUuid => $caseUuid, actionInstanceUuid => $actionInstanceUuid);
};
if ($@) {
    warn "Exception when calling CaseApi->updateCaseAction: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseApi()
body =  # CasePlaybookActionUpdateRequest | The action update request
caseUuid = caseUuid_example # String | The UUID of the case.
actionInstanceUuid = actionInstanceUuid_example # String | The UUID of the action instance to update.

try: 
    # Update an action for a case.
    api_instance.update_case_action(body, caseUuid, actionInstanceUuid)
except ApiException as e:
    print("Exception when calling CaseApi->updateCaseAction: %s\n" % e)

Parameters

Path parameters
Name Description
caseUuid*
String
The UUID of the case.
Required
actionInstanceUuid*
String
The UUID of the action instance to update.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - Case action was updated successfully.

Status: default - Internal Server Error


updateCaseHistory

Updates a case.


/case/{caseUuid}/history

Usage and SDK Samples

curl -X PUT\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/case/{caseUuid}/history"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseApi;

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

public class CaseApiExample {

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

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

        CaseApi apiInstance = new CaseApi();
        Case body = ; // Case | The case to update.
        String caseUuid = caseUuid_example; // String | The UUID of the case to update.
        try {
            apiInstance.updateCaseHistory(body, caseUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#updateCaseHistory");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseApi;

public class CaseApiExample {

    public static void main(String[] args) {
        CaseApi apiInstance = new CaseApi();
        Case body = ; // Case | The case to update.
        String caseUuid = caseUuid_example; // String | The UUID of the case to update.
        try {
            apiInstance.updateCaseHistory(body, caseUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#updateCaseHistory");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
Case *body = ; // The case to update.
String *caseUuid = caseUuid_example; // The UUID of the case to update.

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

// Updates a case.
[apiInstance updateCaseHistoryWith:body
    caseUuid:caseUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseApi()
var body = ; // {{Case}} The case to update.
var caseUuid = caseUuid_example; // {{String}} The UUID of the case to update.

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

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

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

            var apiInstance = new CaseApi();
            var body = new Case(); // Case | The case to update.
            var caseUuid = caseUuid_example;  // String | The UUID of the case to update.

            try
            {
                // Updates a case.
                apiInstance.updateCaseHistory(body, caseUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseApi.updateCaseHistory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCaseApi();
$body = ; // Case | The case to update.
$caseUuid = caseUuid_example; // String | The UUID of the case to update.

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

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

my $api_instance = WWW::SwaggerClient::CaseApi->new();
my $body = WWW::SwaggerClient::Object::Case->new(); # Case | The case to update.
my $caseUuid = caseUuid_example; # String | The UUID of the case to update.

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseApi()
body =  # Case | The case to update.
caseUuid = caseUuid_example # String | The UUID of the case to update.

try: 
    # Updates a case.
    api_instance.update_case_history(body, caseUuid)
except ApiException as e:
    print("Exception when calling CaseApi->updateCaseHistory: %s\n" % e)

Parameters

Path parameters
Name Description
caseUuid*
String
The UUID of the case to update.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - The case was updated successfully.

Status: 401 - Not authorised to update case.

Status: 403 - The request does not have authorisation.

Status: 404 - Requested case not found or insufficient permissions to finds.

Status: default - Internal Server Error


updateCaseMeta

Creates a case metadata entry.


/case/{caseUuid}/meta

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/case/{caseUuid}/meta"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseApi;

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

public class CaseApiExample {

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

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

        CaseApi apiInstance = new CaseApi();
        MetaNameManipulation body = ; // MetaNameManipulation | The case metadata to create.
        String caseUuid = caseUuid_example; // String | The UUID of the case to update.
        try {
            apiInstance.updateCaseMeta(body, caseUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#updateCaseMeta");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseApi;

public class CaseApiExample {

    public static void main(String[] args) {
        CaseApi apiInstance = new CaseApi();
        MetaNameManipulation body = ; // MetaNameManipulation | The case metadata to create.
        String caseUuid = caseUuid_example; // String | The UUID of the case to update.
        try {
            apiInstance.updateCaseMeta(body, caseUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#updateCaseMeta");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
MetaNameManipulation *body = ; // The case metadata to create.
String *caseUuid = caseUuid_example; // The UUID of the case to update.

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

// Creates a case metadata entry.
[apiInstance updateCaseMetaWith:body
    caseUuid:caseUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseApi()
var body = ; // {{MetaNameManipulation}} The case metadata to create.
var caseUuid = caseUuid_example; // {{String}} The UUID of the case to update.

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

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

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

            var apiInstance = new CaseApi();
            var body = new MetaNameManipulation(); // MetaNameManipulation | The case metadata to create.
            var caseUuid = caseUuid_example;  // String | The UUID of the case to update.

            try
            {
                // Creates a case metadata entry.
                apiInstance.updateCaseMeta(body, caseUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseApi.updateCaseMeta: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCaseApi();
$body = ; // MetaNameManipulation | The case metadata to create.
$caseUuid = caseUuid_example; // String | The UUID of the case to update.

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

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

my $api_instance = WWW::SwaggerClient::CaseApi->new();
my $body = WWW::SwaggerClient::Object::MetaNameManipulation->new(); # MetaNameManipulation | The case metadata to create.
my $caseUuid = caseUuid_example; # String | The UUID of the case to update.

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseApi()
body =  # MetaNameManipulation | The case metadata to create.
caseUuid = caseUuid_example # String | The UUID of the case to update.

try: 
    # Creates a case metadata entry.
    api_instance.update_case_meta(body, caseUuid)
except ApiException as e:
    print("Exception when calling CaseApi->updateCaseMeta: %s\n" % e)

Parameters

Path parameters
Name Description
caseUuid*
String
The UUID of the case to update.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - Case metadata has been created.

Status: 401 - Invalid authentication for this request.

Status: 404 - Requested case not found or insufficient permissions to finds.

Status: default - Internal Server Error


updateCasePlaybook

Updates a playbook instance on a case.


/case/{caseUuid}/playbook/{casePlaybookUuid}

Usage and SDK Samples

curl -X PUT\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/case/{caseUuid}/playbook/{casePlaybookUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseApi;

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

public class CaseApiExample {

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

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

        CaseApi apiInstance = new CaseApi();
        CasePlaybookUpdateRequest body = ; // CasePlaybookUpdateRequest | The update request
        String caseUuid = caseUuid_example; // String | The UUID of the case.
        String casePlaybookUuid = casePlaybookUuid_example; // String | The UUID of the playbook instance to be updated.
        try {
            apiInstance.updateCasePlaybook(body, caseUuid, casePlaybookUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#updateCasePlaybook");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseApi;

public class CaseApiExample {

    public static void main(String[] args) {
        CaseApi apiInstance = new CaseApi();
        CasePlaybookUpdateRequest body = ; // CasePlaybookUpdateRequest | The update request
        String caseUuid = caseUuid_example; // String | The UUID of the case.
        String casePlaybookUuid = casePlaybookUuid_example; // String | The UUID of the playbook instance to be updated.
        try {
            apiInstance.updateCasePlaybook(body, caseUuid, casePlaybookUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseApi#updateCasePlaybook");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
CasePlaybookUpdateRequest *body = ; // The update request
String *caseUuid = caseUuid_example; // The UUID of the case.
String *casePlaybookUuid = casePlaybookUuid_example; // The UUID of the playbook instance to be updated.

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

// Updates a playbook instance on a case.
[apiInstance updateCasePlaybookWith:body
    caseUuid:caseUuid
    casePlaybookUuid:casePlaybookUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseApi()
var body = ; // {{CasePlaybookUpdateRequest}} The update request
var caseUuid = caseUuid_example; // {{String}} The UUID of the case.
var casePlaybookUuid = casePlaybookUuid_example; // {{String}} The UUID of the playbook instance to be updated.

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

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

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

            var apiInstance = new CaseApi();
            var body = new CasePlaybookUpdateRequest(); // CasePlaybookUpdateRequest | The update request
            var caseUuid = caseUuid_example;  // String | The UUID of the case.
            var casePlaybookUuid = casePlaybookUuid_example;  // String | The UUID of the playbook instance to be updated.

            try
            {
                // Updates a playbook instance on a case.
                apiInstance.updateCasePlaybook(body, caseUuid, casePlaybookUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseApi.updateCasePlaybook: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCaseApi();
$body = ; // CasePlaybookUpdateRequest | The update request
$caseUuid = caseUuid_example; // String | The UUID of the case.
$casePlaybookUuid = casePlaybookUuid_example; // String | The UUID of the playbook instance to be updated.

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

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

my $api_instance = WWW::SwaggerClient::CaseApi->new();
my $body = WWW::SwaggerClient::Object::CasePlaybookUpdateRequest->new(); # CasePlaybookUpdateRequest | The update request
my $caseUuid = caseUuid_example; # String | The UUID of the case.
my $casePlaybookUuid = casePlaybookUuid_example; # String | The UUID of the playbook instance to be updated.

eval { 
    $api_instance->updateCasePlaybook(body => $body, caseUuid => $caseUuid, casePlaybookUuid => $casePlaybookUuid);
};
if ($@) {
    warn "Exception when calling CaseApi->updateCasePlaybook: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseApi()
body =  # CasePlaybookUpdateRequest | The update request
caseUuid = caseUuid_example # String | The UUID of the case.
casePlaybookUuid = casePlaybookUuid_example # String | The UUID of the playbook instance to be updated.

try: 
    # Updates a playbook instance on a case.
    api_instance.update_case_playbook(body, caseUuid, casePlaybookUuid)
except ApiException as e:
    print("Exception when calling CaseApi->updateCasePlaybook: %s\n" % e)

Parameters

Path parameters
Name Description
caseUuid*
String
The UUID of the case.
Required
casePlaybookUuid*
String
The UUID of the playbook instance to be updated.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - The resource was updated successfully.

Status: default - Internal Server Error


CaseCache

addCaseCache

Creates a case cache entry


/case-cache

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/case-cache"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseCacheApi;

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

public class CaseCacheApiExample {

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

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

        CaseCacheApi apiInstance = new CaseCacheApi();
        AddCaseRequest body = ; // AddCaseRequest | The case to add
        try {
            createResponse result = apiInstance.addCaseCache(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseCacheApi#addCaseCache");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseCacheApi;

public class CaseCacheApiExample {

    public static void main(String[] args) {
        CaseCacheApi apiInstance = new CaseCacheApi();
        AddCaseRequest body = ; // AddCaseRequest | The case to add
        try {
            createResponse result = apiInstance.addCaseCache(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseCacheApi#addCaseCache");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
AddCaseRequest *body = ; // The case to add

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

[apiInstance addCaseCacheWith:body
              completionHandler: ^(createResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseCacheApi()
var body = ; // {{AddCaseRequest}} The case to add

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

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

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

            var apiInstance = new CaseCacheApi();
            var body = new AddCaseRequest(); // AddCaseRequest | The case to add

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

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

$api_instance = new Swagger\Client\ApiCaseCacheApi();
$body = ; // AddCaseRequest | The case to add

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

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

my $api_instance = WWW::SwaggerClient::CaseCacheApi->new();
my $body = WWW::SwaggerClient::Object::AddCaseRequest->new(); # AddCaseRequest | The case to add

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseCacheApi()
body =  # AddCaseRequest | The case to add

try: 
    api_response = api_instance.add_case_cache(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseCacheApi->addCaseCache: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - A case cache entry has been created.

Status: 401 - Authorization information is missing or invalid.

Status: 409 - Request conflict with the current state of the server.

Status: default - Internal Server Error


deleteCaseCache

Deletes a case from the cache


/case-cache/{caseUuid}

Usage and SDK Samples

curl -X DELETE\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/case-cache/{caseUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseCacheApi;

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

public class CaseCacheApiExample {

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

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

        CaseCacheApi apiInstance = new CaseCacheApi();
        String caseUuid = caseUuid_example; // String | The UUID of the case to remove.
        try {
            apiInstance.deleteCaseCache(caseUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseCacheApi#deleteCaseCache");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseCacheApi;

public class CaseCacheApiExample {

    public static void main(String[] args) {
        CaseCacheApi apiInstance = new CaseCacheApi();
        String caseUuid = caseUuid_example; // String | The UUID of the case to remove.
        try {
            apiInstance.deleteCaseCache(caseUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseCacheApi#deleteCaseCache");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *caseUuid = caseUuid_example; // The UUID of the case to remove.

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

[apiInstance deleteCaseCacheWith:caseUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseCacheApi()
var caseUuid = caseUuid_example; // {{String}} The UUID of the case to remove.

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

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

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

            var apiInstance = new CaseCacheApi();
            var caseUuid = caseUuid_example;  // String | The UUID of the case to remove.

            try
            {
                apiInstance.deleteCaseCache(caseUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseCacheApi.deleteCaseCache: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCaseCacheApi();
$caseUuid = caseUuid_example; // String | The UUID of the case to remove.

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

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

my $api_instance = WWW::SwaggerClient::CaseCacheApi->new();
my $caseUuid = caseUuid_example; # String | The UUID of the case to remove.

eval { 
    $api_instance->deleteCaseCache(caseUuid => $caseUuid);
};
if ($@) {
    warn "Exception when calling CaseCacheApi->deleteCaseCache: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseCacheApi()
caseUuid = caseUuid_example # String | The UUID of the case to remove.

try: 
    api_instance.delete_case_cache(caseUuid)
except ApiException as e:
    print("Exception when calling CaseCacheApi->deleteCaseCache: %s\n" % e)

Parameters

Path parameters
Name Description
caseUuid*
String
The UUID of the case to remove.
Required

Responses

Status: 204 - The resource was deleted successfully.

Status: 401 - Authorization information is missing or invalid.

Status: default - Internal Server Error


getCaseCache

Gets a list of cases from the cache


/case-cache

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/case-cache"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseCacheApi;

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

public class CaseCacheApiExample {

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

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

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

public class CaseCacheApiExample {

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

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

[apiInstance getCaseCacheWithCompletionHandler: 
              ^(array[caseCacheEntry] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseCacheApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCaseCache(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new CaseCacheApi();

            try
            {
                array[caseCacheEntry] result = apiInstance.getCaseCache();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseCacheApi.getCaseCache: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

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

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

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseCacheApi()

try: 
    api_response = api_instance.get_case_cache()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseCacheApi->getCaseCache: %s\n" % e)

Parameters

Responses

Status: 200 - Fetched list of cases from the cache and transmitted in the message body.

Status: default - Internal Server Error


CaseSeverity

getSeverity

Gets a list of case severities.


/case-severity

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/case-severity"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseSeverityApi;

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

public class CaseSeverityApiExample {

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

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

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

public class CaseSeverityApiExample {

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

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

// Gets a list of case severities.
[apiInstance getSeverityWithCompletionHandler: 
              ^(array[caseSeverity] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseSeverityApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSeverity(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new CaseSeverityApi();

            try
            {
                // Gets a list of case severities.
                array[caseSeverity] result = apiInstance.getSeverity();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseSeverityApi.getSeverity: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

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

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

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseSeverityApi()

try: 
    # Gets a list of case severities.
    api_response = api_instance.get_severity()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseSeverityApi->getSeverity: %s\n" % e)

Parameters

Responses

Status: 200 - Fetched list of case severities transmitted in the message body.

Status: default - Internal Server Error


CaseStatus

getStatus

Gets a list of case statuses.


/case-status

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/case-status"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseStatusApi;

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

public class CaseStatusApiExample {

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

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

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

public class CaseStatusApiExample {

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

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

// Gets a list of case statuses.
[apiInstance getStatusWithCompletionHandler: 
              ^(array[caseStatus] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseStatusApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getStatus(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new CaseStatusApi();

            try
            {
                // Gets a list of case statuses.
                array[caseStatus] result = apiInstance.getStatus();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseStatusApi.getStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

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

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

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseStatusApi()

try: 
    # Gets a list of case statuses.
    api_response = api_instance.get_status()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseStatusApi->getStatus: %s\n" % e)

Parameters

Responses

Status: 200 - Fetched the list of case statuses and transmitted in the message body.

Status: default - Internal Server Error


CaseTag

addCaseTag

Adds a tag to a case.


/case/{caseUuid}/tag

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/case/{caseUuid}/tag"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseTagApi;

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

public class CaseTagApiExample {

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

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

        CaseTagApi apiInstance = new CaseTagApi();
        CaseTagMapRequest body = ; // CaseTagMapRequest | The case tag to add.
        String caseUuid = caseUuid_example; // String | The case to add to.
        try {
            caseStatus result = apiInstance.addCaseTag(body, caseUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseTagApi#addCaseTag");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseTagApi;

public class CaseTagApiExample {

    public static void main(String[] args) {
        CaseTagApi apiInstance = new CaseTagApi();
        CaseTagMapRequest body = ; // CaseTagMapRequest | The case tag to add.
        String caseUuid = caseUuid_example; // String | The case to add to.
        try {
            caseStatus result = apiInstance.addCaseTag(body, caseUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseTagApi#addCaseTag");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
CaseTagMapRequest *body = ; // The case tag to add.
String *caseUuid = caseUuid_example; // The case to add to.

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

// Adds a tag to a case.
[apiInstance addCaseTagWith:body
    caseUuid:caseUuid
              completionHandler: ^(caseStatus output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseTagApi()
var body = ; // {{CaseTagMapRequest}} The case tag to add.
var caseUuid = caseUuid_example; // {{String}} The case to add to.

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

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

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

            var apiInstance = new CaseTagApi();
            var body = new CaseTagMapRequest(); // CaseTagMapRequest | The case tag to add.
            var caseUuid = caseUuid_example;  // String | The case to add to.

            try
            {
                // Adds a tag to a case.
                caseStatus result = apiInstance.addCaseTag(body, caseUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseTagApi.addCaseTag: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCaseTagApi();
$body = ; // CaseTagMapRequest | The case tag to add.
$caseUuid = caseUuid_example; // String | The case to add to.

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

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

my $api_instance = WWW::SwaggerClient::CaseTagApi->new();
my $body = WWW::SwaggerClient::Object::CaseTagMapRequest->new(); # CaseTagMapRequest | The case tag to add.
my $caseUuid = caseUuid_example; # String | The case to add to.

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseTagApi()
body =  # CaseTagMapRequest | The case tag to add.
caseUuid = caseUuid_example # String | The case to add to.

try: 
    # Adds a tag to a case.
    api_response = api_instance.add_case_tag(body, caseUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseTagApi->addCaseTag: %s\n" % e)

Parameters

Path parameters
Name Description
caseUuid*
String
The case to add to.
Required
Body parameters
Name Description
body *

Responses

Status: 200 - The status of the action is transmitted in the message body.

Status: 208 - Tag has already been added to case.

Status: default - Internal Server Error


createCaseTag

Creates a case tag.


/case-tag

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/case-tag"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseTagApi;

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

public class CaseTagApiExample {

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

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

        CaseTagApi apiInstance = new CaseTagApi();
        CaseTag body = ; // CaseTag | The case tag to create.
        try {
            createResponse result = apiInstance.createCaseTag(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseTagApi#createCaseTag");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseTagApi;

public class CaseTagApiExample {

    public static void main(String[] args) {
        CaseTagApi apiInstance = new CaseTagApi();
        CaseTag body = ; // CaseTag | The case tag to create.
        try {
            createResponse result = apiInstance.createCaseTag(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseTagApi#createCaseTag");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
CaseTag *body = ; // The case tag to create.

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

// Creates a case tag.
[apiInstance createCaseTagWith:body
              completionHandler: ^(createResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseTagApi()
var body = ; // {{CaseTag}} The case tag to create.

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

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

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

            var apiInstance = new CaseTagApi();
            var body = new CaseTag(); // CaseTag | The case tag to create.

            try
            {
                // Creates a case tag.
                createResponse result = apiInstance.createCaseTag(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseTagApi.createCaseTag: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCaseTagApi();
$body = ; // CaseTag | The case tag to create.

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

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

my $api_instance = WWW::SwaggerClient::CaseTagApi->new();
my $body = WWW::SwaggerClient::Object::CaseTag->new(); # CaseTag | The case tag to create.

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseTagApi()
body =  # CaseTag | The case tag to create.

try: 
    # Creates a case tag.
    api_response = api_instance.create_case_tag(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseTagApi->createCaseTag: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Case tag has been created.

Status: default - Internal Server Error


deleteCaseTag

Delete a caseTag .


/case-tag/{tagUuid}

Usage and SDK Samples

curl -X DELETE\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/case-tag/{tagUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseTagApi;

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

public class CaseTagApiExample {

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

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

        CaseTagApi apiInstance = new CaseTagApi();
        String tagUuid = tagUuid_example; // String | The case tag to delete.
        try {
            apiInstance.deleteCaseTag(tagUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseTagApi#deleteCaseTag");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseTagApi;

public class CaseTagApiExample {

    public static void main(String[] args) {
        CaseTagApi apiInstance = new CaseTagApi();
        String tagUuid = tagUuid_example; // String | The case tag to delete.
        try {
            apiInstance.deleteCaseTag(tagUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseTagApi#deleteCaseTag");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *tagUuid = tagUuid_example; // The case tag to delete.

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

// Delete a caseTag .
[apiInstance deleteCaseTagWith:tagUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseTagApi()
var tagUuid = tagUuid_example; // {{String}} The case tag to delete.

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

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

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

            var apiInstance = new CaseTagApi();
            var tagUuid = tagUuid_example;  // String | The case tag to delete.

            try
            {
                // Delete a caseTag .
                apiInstance.deleteCaseTag(tagUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseTagApi.deleteCaseTag: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCaseTagApi();
$tagUuid = tagUuid_example; // String | The case tag to delete.

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

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

my $api_instance = WWW::SwaggerClient::CaseTagApi->new();
my $tagUuid = tagUuid_example; # String | The case tag to delete.

eval { 
    $api_instance->deleteCaseTag(tagUuid => $tagUuid);
};
if ($@) {
    warn "Exception when calling CaseTagApi->deleteCaseTag: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseTagApi()
tagUuid = tagUuid_example # String | The case tag to delete.

try: 
    # Delete a caseTag .
    api_instance.delete_case_tag(tagUuid)
except ApiException as e:
    print("Exception when calling CaseTagApi->deleteCaseTag: %s\n" % e)

Parameters

Path parameters
Name Description
tagUuid*
String
The case tag to delete.
Required

Responses

Status: 204 - The resource was deleted successfully.

Status: default - Internal Server Error


getCaseTagWithUuid

Retrieve case tag with uuid.


/case-tag/{tagUuid}

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/case-tag/{tagUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseTagApi;

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

public class CaseTagApiExample {

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

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

        CaseTagApi apiInstance = new CaseTagApi();
        String tagUuid = tagUuid_example; // String | The case tag to retrieve.
        try {
            caseTag result = apiInstance.getCaseTagWithUuid(tagUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseTagApi#getCaseTagWithUuid");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseTagApi;

public class CaseTagApiExample {

    public static void main(String[] args) {
        CaseTagApi apiInstance = new CaseTagApi();
        String tagUuid = tagUuid_example; // String | The case tag to retrieve.
        try {
            caseTag result = apiInstance.getCaseTagWithUuid(tagUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseTagApi#getCaseTagWithUuid");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *tagUuid = tagUuid_example; // The case tag to retrieve.

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

// Retrieve case tag with uuid.
[apiInstance getCaseTagWithUuidWith:tagUuid
              completionHandler: ^(caseTag output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseTagApi()
var tagUuid = tagUuid_example; // {{String}} The case tag to retrieve.

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

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

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

            var apiInstance = new CaseTagApi();
            var tagUuid = tagUuid_example;  // String | The case tag to retrieve.

            try
            {
                // Retrieve case tag with uuid.
                caseTag result = apiInstance.getCaseTagWithUuid(tagUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseTagApi.getCaseTagWithUuid: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCaseTagApi();
$tagUuid = tagUuid_example; // String | The case tag to retrieve.

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

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

my $api_instance = WWW::SwaggerClient::CaseTagApi->new();
my $tagUuid = tagUuid_example; # String | The case tag to retrieve.

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseTagApi()
tagUuid = tagUuid_example # String | The case tag to retrieve.

try: 
    # Retrieve case tag with uuid.
    api_response = api_instance.get_case_tag_with_uuid(tagUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseTagApi->getCaseTagWithUuid: %s\n" % e)

Parameters

Path parameters
Name Description
tagUuid*
String
The case tag to retrieve.
Required

Responses

Status: 200 - Fetched the case tag and transmitted in the message body.

Status: default - Internal Server Error


getCaseTags

Gets a list of case tags.


/case-tag

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/case-tag"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseTagApi;

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

public class CaseTagApiExample {

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

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

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

public class CaseTagApiExample {

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

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

// Gets a list of case tags.
[apiInstance getCaseTagsWithCompletionHandler: 
              ^(array[caseTag] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseTagApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCaseTags(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new CaseTagApi();

            try
            {
                // Gets a list of case tags.
                array[caseTag] result = apiInstance.getCaseTags();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseTagApi.getCaseTags: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

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

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

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseTagApi()

try: 
    # Gets a list of case tags.
    api_response = api_instance.get_case_tags()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseTagApi->getCaseTags: %s\n" % e)

Parameters

Responses

Status: 200 - Fetched the list of case tags and transmitted in the message body.

Status: default - Internal Server Error


getTagsForCase

Gets a list of tags for the case.


/case/{caseUuid}/tag

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/case/{caseUuid}/tag"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseTagApi;

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

public class CaseTagApiExample {

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

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

        CaseTagApi apiInstance = new CaseTagApi();
        CaseTag body = ; // CaseTag | The case tag to create.
        String caseUuid = caseUuid_example; // String | The UUID of the case to retrieve tags from.
        try {
            caseTag result = apiInstance.getTagsForCase(body, caseUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseTagApi#getTagsForCase");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseTagApi;

public class CaseTagApiExample {

    public static void main(String[] args) {
        CaseTagApi apiInstance = new CaseTagApi();
        CaseTag body = ; // CaseTag | The case tag to create.
        String caseUuid = caseUuid_example; // String | The UUID of the case to retrieve tags from.
        try {
            caseTag result = apiInstance.getTagsForCase(body, caseUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseTagApi#getTagsForCase");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
CaseTag *body = ; // The case tag to create.
String *caseUuid = caseUuid_example; // The UUID of the case to retrieve tags from.

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

// Gets a list of tags for the case.
[apiInstance getTagsForCaseWith:body
    caseUuid:caseUuid
              completionHandler: ^(caseTag output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

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

var api = new CydarmApi.CaseTagApi()
var body = ; // {{CaseTag}} The case tag to create.
var caseUuid = caseUuid_example; // {{String}} The UUID of the case to retrieve tags from.

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

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

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

            var apiInstance = new CaseTagApi();
            var body = new CaseTag(); // CaseTag | The case tag to create.
            var caseUuid = caseUuid_example;  // String | The UUID of the case to retrieve tags from.

            try
            {
                // Gets a list of tags for the case.
                caseTag result = apiInstance.getTagsForCase(body, caseUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseTagApi.getTagsForCase: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCaseTagApi();
$body = ; // CaseTag | The case tag to create.
$caseUuid = caseUuid_example; // String | The UUID of the case to retrieve tags from.

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

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

my $api_instance = WWW::SwaggerClient::CaseTagApi->new();
my $body = WWW::SwaggerClient::Object::CaseTag->new(); # CaseTag | The case tag to create.
my $caseUuid = caseUuid_example; # String | The UUID of the case to retrieve tags from.

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseTagApi()
body =  # CaseTag | The case tag to create.
caseUuid = caseUuid_example # String | The UUID of the case to retrieve tags from.

try: 
    # Gets a list of tags for the case.
    api_response = api_instance.get_tags_for_case(body, caseUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseTagApi->getTagsForCase: %s\n" % e)

Parameters

Path parameters
Name Description
caseUuid*
String
The UUID of the case to retrieve tags from.
Required
Body parameters
Name Description
body *

Responses

Status: 200 - Fetched the list of case tags for the case and transmitted in the message body.

Status: default - Internal Server Error


removeCaseTag

Removes a tag from a case.


/case/{caseUuid}/tag

Usage and SDK Samples

curl -X DELETE\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/case/{caseUuid}/tag"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseTagApi;

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

public class CaseTagApiExample {

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

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

        CaseTagApi apiInstance = new CaseTagApi();
        CaseTag body = ; // CaseTag | The case tag to remove.
        String caseUuid = caseUuid_example; // String | The case to remove a tag from.
        try {
            apiInstance.removeCaseTag(body, caseUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseTagApi#removeCaseTag");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseTagApi;

public class CaseTagApiExample {

    public static void main(String[] args) {
        CaseTagApi apiInstance = new CaseTagApi();
        CaseTag body = ; // CaseTag | The case tag to remove.
        String caseUuid = caseUuid_example; // String | The case to remove a tag from.
        try {
            apiInstance.removeCaseTag(body, caseUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseTagApi#removeCaseTag");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
CaseTag *body = ; // The case tag to remove.
String *caseUuid = caseUuid_example; // The case to remove a tag from.

CaseTagApi *apiInstance = [[CaseTagApi alloc] init];

// Removes a tag from a case.
[apiInstance removeCaseTagWith:body
    caseUuid:caseUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.CaseTagApi()
var body = ; // {{CaseTag}} The case tag to remove.
var caseUuid = caseUuid_example; // {{String}} The case to remove a tag from.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeCaseTag(bodycaseUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class removeCaseTagExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new CaseTagApi();
            var body = new CaseTag(); // CaseTag | The case tag to remove.
            var caseUuid = caseUuid_example;  // String | The case to remove a tag from.

            try
            {
                // Removes a tag from a case.
                apiInstance.removeCaseTag(body, caseUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseTagApi.removeCaseTag: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiCaseTagApi();
$body = ; // CaseTag | The case tag to remove.
$caseUuid = caseUuid_example; // String | The case to remove a tag from.

try {
    $api_instance->removeCaseTag($body, $caseUuid);
} catch (Exception $e) {
    echo 'Exception when calling CaseTagApi->removeCaseTag: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CaseTagApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CaseTagApi->new();
my $body = WWW::SwaggerClient::Object::CaseTag->new(); # CaseTag | The case tag to remove.
my $caseUuid = caseUuid_example; # String | The case to remove a tag from.

eval { 
    $api_instance->removeCaseTag(body => $body, caseUuid => $caseUuid);
};
if ($@) {
    warn "Exception when calling CaseTagApi->removeCaseTag: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseTagApi()
body =  # CaseTag | The case tag to remove.
caseUuid = caseUuid_example # String | The case to remove a tag from.

try: 
    # Removes a tag from a case.
    api_instance.remove_case_tag(body, caseUuid)
except ApiException as e:
    print("Exception when calling CaseTagApi->removeCaseTag: %s\n" % e)

Parameters

Path parameters
Name Description
caseUuid*
String
The case to remove a tag from.
Required
Body parameters
Name Description
body *

Responses

Status: 200 - The resource was deleted successfully.

Status: default - Internal Server Error


updateCaseTag

Updates a case tag item.


/case-tag/{tagUuid}

Usage and SDK Samples

curl -X PUT\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/case-tag/{tagUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseTagApi;

import java.io.File;
import java.util.*;

public class CaseTagApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        CaseTagApi apiInstance = new CaseTagApi();
        CaseTag body = ; // CaseTag | The case tag to update.
        String tagUuid = tagUuid_example; // String | The UUID of the case tag to update.
        try {
            dataStub result = apiInstance.updateCaseTag(body, tagUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseTagApi#updateCaseTag");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseTagApi;

public class CaseTagApiExample {

    public static void main(String[] args) {
        CaseTagApi apiInstance = new CaseTagApi();
        CaseTag body = ; // CaseTag | The case tag to update.
        String tagUuid = tagUuid_example; // String | The UUID of the case tag to update.
        try {
            dataStub result = apiInstance.updateCaseTag(body, tagUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseTagApi#updateCaseTag");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
CaseTag *body = ; // The case tag to update.
String *tagUuid = tagUuid_example; // The UUID of the case tag to update.

CaseTagApi *apiInstance = [[CaseTagApi alloc] init];

// Updates a case tag item.
[apiInstance updateCaseTagWith:body
    tagUuid:tagUuid
              completionHandler: ^(dataStub output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.CaseTagApi()
var body = ; // {{CaseTag}} The case tag to update.
var tagUuid = tagUuid_example; // {{String}} The UUID of the case tag to update.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateCaseTag(bodytagUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateCaseTagExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new CaseTagApi();
            var body = new CaseTag(); // CaseTag | The case tag to update.
            var tagUuid = tagUuid_example;  // String | The UUID of the case tag to update.

            try
            {
                // Updates a case tag item.
                dataStub result = apiInstance.updateCaseTag(body, tagUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseTagApi.updateCaseTag: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiCaseTagApi();
$body = ; // CaseTag | The case tag to update.
$tagUuid = tagUuid_example; // String | The UUID of the case tag to update.

try {
    $result = $api_instance->updateCaseTag($body, $tagUuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CaseTagApi->updateCaseTag: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CaseTagApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CaseTagApi->new();
my $body = WWW::SwaggerClient::Object::CaseTag->new(); # CaseTag | The case tag to update.
my $tagUuid = tagUuid_example; # String | The UUID of the case tag to update.

eval { 
    my $result = $api_instance->updateCaseTag(body => $body, tagUuid => $tagUuid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CaseTagApi->updateCaseTag: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CaseTagApi()
body =  # CaseTag | The case tag to update.
tagUuid = tagUuid_example # String | The UUID of the case tag to update.

try: 
    # Updates a case tag item.
    api_response = api_instance.update_case_tag(body, tagUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseTagApi->updateCaseTag: %s\n" % e)

Parameters

Path parameters
Name Description
tagUuid*
String
The UUID of the case tag to update.
Required
Body parameters
Name Description
body *

Responses

Status: 200 - The resource was updated successfully.

Status: 401 - Invalid authentication for this request.

Status: 403 - The request does not have authorisation.

Status: 404 - Requested data item not found or insufficient permissions to find.

Status: default - Internal Server Error


Connector

createConnector

Creates a connector


/connector

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/connector"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConnectorApi;

import java.io.File;
import java.util.*;

public class ConnectorApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        ConnectorApi apiInstance = new ConnectorApi();
        CreateConnectorRequest body = ; // CreateConnectorRequest | The connector to create.
        try {
            createResponse result = apiInstance.createConnector(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorApi#createConnector");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConnectorApi;

public class ConnectorApiExample {

    public static void main(String[] args) {
        ConnectorApi apiInstance = new ConnectorApi();
        CreateConnectorRequest body = ; // CreateConnectorRequest | The connector to create.
        try {
            createResponse result = apiInstance.createConnector(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorApi#createConnector");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
CreateConnectorRequest *body = ; // The connector to create.

ConnectorApi *apiInstance = [[ConnectorApi alloc] init];

[apiInstance createConnectorWith:body
              completionHandler: ^(createResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.ConnectorApi()
var body = ; // {{CreateConnectorRequest}} The connector to create.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createConnector(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createConnectorExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new ConnectorApi();
            var body = new CreateConnectorRequest(); // CreateConnectorRequest | The connector to create.

            try
            {
                createResponse result = apiInstance.createConnector(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConnectorApi.createConnector: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiConnectorApi();
$body = ; // CreateConnectorRequest | The connector to create.

try {
    $result = $api_instance->createConnector($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConnectorApi->createConnector: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConnectorApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ConnectorApi->new();
my $body = WWW::SwaggerClient::Object::CreateConnectorRequest->new(); # CreateConnectorRequest | The connector to create.

eval { 
    my $result = $api_instance->createConnector(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConnectorApi->createConnector: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ConnectorApi()
body =  # CreateConnectorRequest | The connector to create.

try: 
    api_response = api_instance.create_connector(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConnectorApi->createConnector: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - The connector has been created successfully.

Status: default - Internal Server Error


deleteConnector

Deletes the specified connector


/connector/{connectorId}

Usage and SDK Samples

curl -X DELETE\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/connector/{connectorId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConnectorApi;

import java.io.File;
import java.util.*;

public class ConnectorApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        ConnectorApi apiInstance = new ConnectorApi();
        String connectorId = connectorId_example; // String | The id of the connector to delete.
        try {
            apiInstance.deleteConnector(connectorId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorApi#deleteConnector");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConnectorApi;

public class ConnectorApiExample {

    public static void main(String[] args) {
        ConnectorApi apiInstance = new ConnectorApi();
        String connectorId = connectorId_example; // String | The id of the connector to delete.
        try {
            apiInstance.deleteConnector(connectorId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorApi#deleteConnector");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *connectorId = connectorId_example; // The id of the connector to delete.

ConnectorApi *apiInstance = [[ConnectorApi alloc] init];

[apiInstance deleteConnectorWith:connectorId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.ConnectorApi()
var connectorId = connectorId_example; // {{String}} The id of the connector to delete.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteConnector(connectorId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteConnectorExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new ConnectorApi();
            var connectorId = connectorId_example;  // String | The id of the connector to delete.

            try
            {
                apiInstance.deleteConnector(connectorId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConnectorApi.deleteConnector: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiConnectorApi();
$connectorId = connectorId_example; // String | The id of the connector to delete.

try {
    $api_instance->deleteConnector($connectorId);
} catch (Exception $e) {
    echo 'Exception when calling ConnectorApi->deleteConnector: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConnectorApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ConnectorApi->new();
my $connectorId = connectorId_example; # String | The id of the connector to delete.

eval { 
    $api_instance->deleteConnector(connectorId => $connectorId);
};
if ($@) {
    warn "Exception when calling ConnectorApi->deleteConnector: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ConnectorApi()
connectorId = connectorId_example # String | The id of the connector to delete.

try: 
    api_instance.delete_connector(connectorId)
except ApiException as e:
    print("Exception when calling ConnectorApi->deleteConnector: %s\n" % e)

Parameters

Path parameters
Name Description
connectorId*
String
The id of the connector to delete.
Required

Responses

Status: 204 - Deleted the connector

Status: default - Internal Server Error


getConnector

Gets specified connector


/connector/{connectorId}

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/connector/{connectorId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConnectorApi;

import java.io.File;
import java.util.*;

public class ConnectorApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        ConnectorApi apiInstance = new ConnectorApi();
        String connectorId = connectorId_example; // String | The id of the connector
        try {
            connector result = apiInstance.getConnector(connectorId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorApi#getConnector");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConnectorApi;

public class ConnectorApiExample {

    public static void main(String[] args) {
        ConnectorApi apiInstance = new ConnectorApi();
        String connectorId = connectorId_example; // String | The id of the connector
        try {
            connector result = apiInstance.getConnector(connectorId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorApi#getConnector");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *connectorId = connectorId_example; // The id of the connector

ConnectorApi *apiInstance = [[ConnectorApi alloc] init];

[apiInstance getConnectorWith:connectorId
              completionHandler: ^(connector output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.ConnectorApi()
var connectorId = connectorId_example; // {{String}} The id of the connector

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConnector(connectorId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getConnectorExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new ConnectorApi();
            var connectorId = connectorId_example;  // String | The id of the connector

            try
            {
                connector result = apiInstance.getConnector(connectorId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConnectorApi.getConnector: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiConnectorApi();
$connectorId = connectorId_example; // String | The id of the connector

try {
    $result = $api_instance->getConnector($connectorId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConnectorApi->getConnector: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConnectorApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ConnectorApi->new();
my $connectorId = connectorId_example; # String | The id of the connector

eval { 
    my $result = $api_instance->getConnector(connectorId => $connectorId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConnectorApi->getConnector: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ConnectorApi()
connectorId = connectorId_example # String | The id of the connector

try: 
    api_response = api_instance.get_connector(connectorId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConnectorApi->getConnector: %s\n" % e)

Parameters

Path parameters
Name Description
connectorId*
String
The id of the connector
Required

Responses

Status: 200 - Fetched the connector and transmitted in the message body.

Status: default - Internal Server Error


getConnectorType

Gets the specified connector type


/connector-type/{connectorTypeId}

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/connector-type/{connectorTypeId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConnectorApi;

import java.io.File;
import java.util.*;

public class ConnectorApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        ConnectorApi apiInstance = new ConnectorApi();
        String connectorTypeId = connectorTypeId_example; // String | The id of the actuator type
        try {
            connectorType result = apiInstance.getConnectorType(connectorTypeId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorApi#getConnectorType");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConnectorApi;

public class ConnectorApiExample {

    public static void main(String[] args) {
        ConnectorApi apiInstance = new ConnectorApi();
        String connectorTypeId = connectorTypeId_example; // String | The id of the actuator type
        try {
            connectorType result = apiInstance.getConnectorType(connectorTypeId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorApi#getConnectorType");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *connectorTypeId = connectorTypeId_example; // The id of the actuator type

ConnectorApi *apiInstance = [[ConnectorApi alloc] init];

[apiInstance getConnectorTypeWith:connectorTypeId
              completionHandler: ^(connectorType output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.ConnectorApi()
var connectorTypeId = connectorTypeId_example; // {{String}} The id of the actuator type

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConnectorType(connectorTypeId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getConnectorTypeExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new ConnectorApi();
            var connectorTypeId = connectorTypeId_example;  // String | The id of the actuator type

            try
            {
                connectorType result = apiInstance.getConnectorType(connectorTypeId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConnectorApi.getConnectorType: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiConnectorApi();
$connectorTypeId = connectorTypeId_example; // String | The id of the actuator type

try {
    $result = $api_instance->getConnectorType($connectorTypeId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConnectorApi->getConnectorType: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConnectorApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ConnectorApi->new();
my $connectorTypeId = connectorTypeId_example; # String | The id of the actuator type

eval { 
    my $result = $api_instance->getConnectorType(connectorTypeId => $connectorTypeId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConnectorApi->getConnectorType: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ConnectorApi()
connectorTypeId = connectorTypeId_example # String | The id of the actuator type

try: 
    api_response = api_instance.get_connector_type(connectorTypeId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConnectorApi->getConnectorType: %s\n" % e)

Parameters

Path parameters
Name Description
connectorTypeId*
String
The id of the actuator type
Required

Responses

Status: 200 - Fetched the connector type and transmitted in the message body.

Status: default - Internal Server Error


getConnectorTypes

Gets all connector types


/connector-type

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/connector-type"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConnectorApi;

import java.io.File;
import java.util.*;

public class ConnectorApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        ConnectorApi apiInstance = new ConnectorApi();
        try {
            array[connectorType] result = apiInstance.getConnectorTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorApi#getConnectorTypes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConnectorApi;

public class ConnectorApiExample {

    public static void main(String[] args) {
        ConnectorApi apiInstance = new ConnectorApi();
        try {
            array[connectorType] result = apiInstance.getConnectorTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorApi#getConnectorTypes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];

ConnectorApi *apiInstance = [[ConnectorApi alloc] init];

[apiInstance getConnectorTypesWithCompletionHandler: 
              ^(array[connectorType] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.ConnectorApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConnectorTypes(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getConnectorTypesExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new ConnectorApi();

            try
            {
                array[connectorType] result = apiInstance.getConnectorTypes();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConnectorApi.getConnectorTypes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiConnectorApi();

try {
    $result = $api_instance->getConnectorTypes();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConnectorApi->getConnectorTypes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConnectorApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ConnectorApi->new();

eval { 
    my $result = $api_instance->getConnectorTypes();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConnectorApi->getConnectorTypes: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ConnectorApi()

try: 
    api_response = api_instance.get_connector_types()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConnectorApi->getConnectorTypes: %s\n" % e)

Parameters

Responses

Status: 200 - Fetched the list of connector types and transmitted in the message body.

Status: default - Internal Server Error


getConnectors

Gets all connectors


/connector

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/connector"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConnectorApi;

import java.io.File;
import java.util.*;

public class ConnectorApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        ConnectorApi apiInstance = new ConnectorApi();
        try {
            array[connector] result = apiInstance.getConnectors();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorApi#getConnectors");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConnectorApi;

public class ConnectorApiExample {

    public static void main(String[] args) {
        ConnectorApi apiInstance = new ConnectorApi();
        try {
            array[connector] result = apiInstance.getConnectors();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorApi#getConnectors");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];

ConnectorApi *apiInstance = [[ConnectorApi alloc] init];

[apiInstance getConnectorsWithCompletionHandler: 
              ^(array[connector] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.ConnectorApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConnectors(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getConnectorsExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new ConnectorApi();

            try
            {
                array[connector] result = apiInstance.getConnectors();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConnectorApi.getConnectors: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiConnectorApi();

try {
    $result = $api_instance->getConnectors();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConnectorApi->getConnectors: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConnectorApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ConnectorApi->new();

eval { 
    my $result = $api_instance->getConnectors();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConnectorApi->getConnectors: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ConnectorApi()

try: 
    api_response = api_instance.get_connectors()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConnectorApi->getConnectors: %s\n" % e)

Parameters

Responses

Status: 200 - Fetched the list of connectors and transmitted in the message body.

Status: default - Internal Server Error


postConnectorType

Creates a connector type


/connector-type

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/connector-type"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConnectorApi;

import java.io.File;
import java.util.*;

public class ConnectorApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        ConnectorApi apiInstance = new ConnectorApi();
        ConnectorTypeCreateRequest body = ; // ConnectorTypeCreateRequest | The connector type to create
        try {
            createResponse result = apiInstance.postConnectorType(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorApi#postConnectorType");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConnectorApi;

public class ConnectorApiExample {

    public static void main(String[] args) {
        ConnectorApi apiInstance = new ConnectorApi();
        ConnectorTypeCreateRequest body = ; // ConnectorTypeCreateRequest | The connector type to create
        try {
            createResponse result = apiInstance.postConnectorType(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorApi#postConnectorType");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
ConnectorTypeCreateRequest *body = ; // The connector type to create

ConnectorApi *apiInstance = [[ConnectorApi alloc] init];

[apiInstance postConnectorTypeWith:body
              completionHandler: ^(createResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.ConnectorApi()
var body = ; // {{ConnectorTypeCreateRequest}} The connector type to create

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postConnectorType(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class postConnectorTypeExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new ConnectorApi();
            var body = new ConnectorTypeCreateRequest(); // ConnectorTypeCreateRequest | The connector type to create

            try
            {
                createResponse result = apiInstance.postConnectorType(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConnectorApi.postConnectorType: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiConnectorApi();
$body = ; // ConnectorTypeCreateRequest | The connector type to create

try {
    $result = $api_instance->postConnectorType($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConnectorApi->postConnectorType: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConnectorApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ConnectorApi->new();
my $body = WWW::SwaggerClient::Object::ConnectorTypeCreateRequest->new(); # ConnectorTypeCreateRequest | The connector type to create

eval { 
    my $result = $api_instance->postConnectorType(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConnectorApi->postConnectorType: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ConnectorApi()
body =  # ConnectorTypeCreateRequest | The connector type to create

try: 
    api_response = api_instance.post_connector_type(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConnectorApi->postConnectorType: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Created the connector type

Status: default - Internal Server Error


updateConnector

Updates the specified connector


/connector/{connectorId}

Usage and SDK Samples

curl -X PUT\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/connector/{connectorId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConnectorApi;

import java.io.File;
import java.util.*;

public class ConnectorApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        ConnectorApi apiInstance = new ConnectorApi();
        UpdateConnectorRequest body = ; // UpdateConnectorRequest | The update connector request.
        String connectorId = connectorId_example; // String | The id of the connector to update.
        try {
            apiInstance.updateConnector(body, connectorId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorApi#updateConnector");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConnectorApi;

public class ConnectorApiExample {

    public static void main(String[] args) {
        ConnectorApi apiInstance = new ConnectorApi();
        UpdateConnectorRequest body = ; // UpdateConnectorRequest | The update connector request.
        String connectorId = connectorId_example; // String | The id of the connector to update.
        try {
            apiInstance.updateConnector(body, connectorId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorApi#updateConnector");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
UpdateConnectorRequest *body = ; // The update connector request.
String *connectorId = connectorId_example; // The id of the connector to update.

ConnectorApi *apiInstance = [[ConnectorApi alloc] init];

[apiInstance updateConnectorWith:body
    connectorId:connectorId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.ConnectorApi()
var body = ; // {{UpdateConnectorRequest}} The update connector request.
var connectorId = connectorId_example; // {{String}} The id of the connector to update.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateConnector(bodyconnectorId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateConnectorExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new ConnectorApi();
            var body = new UpdateConnectorRequest(); // UpdateConnectorRequest | The update connector request.
            var connectorId = connectorId_example;  // String | The id of the connector to update.

            try
            {
                apiInstance.updateConnector(body, connectorId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConnectorApi.updateConnector: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiConnectorApi();
$body = ; // UpdateConnectorRequest | The update connector request.
$connectorId = connectorId_example; // String | The id of the connector to update.

try {
    $api_instance->updateConnector($body, $connectorId);
} catch (Exception $e) {
    echo 'Exception when calling ConnectorApi->updateConnector: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConnectorApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ConnectorApi->new();
my $body = WWW::SwaggerClient::Object::UpdateConnectorRequest->new(); # UpdateConnectorRequest | The update connector request.
my $connectorId = connectorId_example; # String | The id of the connector to update.

eval { 
    $api_instance->updateConnector(body => $body, connectorId => $connectorId);
};
if ($@) {
    warn "Exception when calling ConnectorApi->updateConnector: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ConnectorApi()
body =  # UpdateConnectorRequest | The update connector request.
connectorId = connectorId_example # String | The id of the connector to update.

try: 
    api_instance.update_connector(body, connectorId)
except ApiException as e:
    print("Exception when calling ConnectorApi->updateConnector: %s\n" % e)

Parameters

Path parameters
Name Description
connectorId*
String
The id of the connector to update.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - Updated the connector

Status: default - Internal Server Error


ConnectorType

updateConnectorType

Updates the specified connector


/connector-type/{connectorTypeId}

Usage and SDK Samples

curl -X PUT\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/connector-type/{connectorTypeId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConnectorTypeApi;

import java.io.File;
import java.util.*;

public class ConnectorTypeApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        ConnectorTypeApi apiInstance = new ConnectorTypeApi();
        ConnectorTypeUpdateRequest body = ; // ConnectorTypeUpdateRequest | The updated connector request.
        String connectorTypeId = connectorTypeId_example; // String | The id of the actuator type to update.
        try {
            apiInstance.updateConnectorType(body, connectorTypeId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorTypeApi#updateConnectorType");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConnectorTypeApi;

public class ConnectorTypeApiExample {

    public static void main(String[] args) {
        ConnectorTypeApi apiInstance = new ConnectorTypeApi();
        ConnectorTypeUpdateRequest body = ; // ConnectorTypeUpdateRequest | The updated connector request.
        String connectorTypeId = connectorTypeId_example; // String | The id of the actuator type to update.
        try {
            apiInstance.updateConnectorType(body, connectorTypeId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorTypeApi#updateConnectorType");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
ConnectorTypeUpdateRequest *body = ; // The updated connector request.
String *connectorTypeId = connectorTypeId_example; // The id of the actuator type to update.

ConnectorTypeApi *apiInstance = [[ConnectorTypeApi alloc] init];

[apiInstance updateConnectorTypeWith:body
    connectorTypeId:connectorTypeId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.ConnectorTypeApi()
var body = ; // {{ConnectorTypeUpdateRequest}} The updated connector request.
var connectorTypeId = connectorTypeId_example; // {{String}} The id of the actuator type to update.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateConnectorType(bodyconnectorTypeId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateConnectorTypeExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new ConnectorTypeApi();
            var body = new ConnectorTypeUpdateRequest(); // ConnectorTypeUpdateRequest | The updated connector request.
            var connectorTypeId = connectorTypeId_example;  // String | The id of the actuator type to update.

            try
            {
                apiInstance.updateConnectorType(body, connectorTypeId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConnectorTypeApi.updateConnectorType: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiConnectorTypeApi();
$body = ; // ConnectorTypeUpdateRequest | The updated connector request.
$connectorTypeId = connectorTypeId_example; // String | The id of the actuator type to update.

try {
    $api_instance->updateConnectorType($body, $connectorTypeId);
} catch (Exception $e) {
    echo 'Exception when calling ConnectorTypeApi->updateConnectorType: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConnectorTypeApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ConnectorTypeApi->new();
my $body = WWW::SwaggerClient::Object::ConnectorTypeUpdateRequest->new(); # ConnectorTypeUpdateRequest | The updated connector request.
my $connectorTypeId = connectorTypeId_example; # String | The id of the actuator type to update.

eval { 
    $api_instance->updateConnectorType(body => $body, connectorTypeId => $connectorTypeId);
};
if ($@) {
    warn "Exception when calling ConnectorTypeApi->updateConnectorType: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ConnectorTypeApi()
body =  # ConnectorTypeUpdateRequest | The updated connector request.
connectorTypeId = connectorTypeId_example # String | The id of the actuator type to update.

try: 
    api_instance.update_connector_type(body, connectorTypeId)
except ApiException as e:
    print("Exception when calling ConnectorTypeApi->updateConnectorType: %s\n" % e)

Parameters

Path parameters
Name Description
connectorTypeId*
String
The id of the actuator type to update.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - Updated the connector type

Status: default - Internal Server Error


Data

deleteData

Deletes a data item.


/data/{dataUuid}

Usage and SDK Samples

curl -X DELETE\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/data/{dataUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataApi;

import java.io.File;
import java.util.*;

public class DataApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        DataApi apiInstance = new DataApi();
        String dataUuid = dataUuid_example; // String | The UUID of the data object to delete.
        try {
            apiInstance.deleteData(dataUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#deleteData");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataApi;

public class DataApiExample {

    public static void main(String[] args) {
        DataApi apiInstance = new DataApi();
        String dataUuid = dataUuid_example; // String | The UUID of the data object to delete.
        try {
            apiInstance.deleteData(dataUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#deleteData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *dataUuid = dataUuid_example; // The UUID of the data object to delete.

DataApi *apiInstance = [[DataApi alloc] init];

// Deletes a data item.
[apiInstance deleteDataWith:dataUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.DataApi()
var dataUuid = dataUuid_example; // {{String}} The UUID of the data object to delete.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteData(dataUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteDataExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new DataApi();
            var dataUuid = dataUuid_example;  // String | The UUID of the data object to delete.

            try
            {
                // Deletes a data item.
                apiInstance.deleteData(dataUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataApi.deleteData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiDataApi();
$dataUuid = dataUuid_example; // String | The UUID of the data object to delete.

try {
    $api_instance->deleteData($dataUuid);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->deleteData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DataApi->new();
my $dataUuid = dataUuid_example; # String | The UUID of the data object to delete.

eval { 
    $api_instance->deleteData(dataUuid => $dataUuid);
};
if ($@) {
    warn "Exception when calling DataApi->deleteData: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DataApi()
dataUuid = dataUuid_example # String | The UUID of the data object to delete.

try: 
    # Deletes a data item.
    api_instance.delete_data(dataUuid)
except ApiException as e:
    print("Exception when calling DataApi->deleteData: %s\n" % e)

Parameters

Path parameters
Name Description
dataUuid*
String
The UUID of the data object to delete.
Required

Responses

Status: 200 - The resource was deleted successfully.

Status: 401 - Invalid authentication for this request.

Status: 403 - The request does not have authorisation.

Status: 404 - Requested data item not found or insufficient permissions to find.

Status: default - Internal Server Error


getDataFile

Gets a data file for download.


/data/{dataUuid}/file

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/data/{dataUuid}/file"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataApi;

import java.io.File;
import java.util.*;

public class DataApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        DataApi apiInstance = new DataApi();
        String dataUuid = dataUuid_example; // String | The UUID of the data file object to retrieve.
        try {
            errorResponse result = apiInstance.getDataFile(dataUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#getDataFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataApi;

public class DataApiExample {

    public static void main(String[] args) {
        DataApi apiInstance = new DataApi();
        String dataUuid = dataUuid_example; // String | The UUID of the data file object to retrieve.
        try {
            errorResponse result = apiInstance.getDataFile(dataUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#getDataFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *dataUuid = dataUuid_example; // The UUID of the data file object to retrieve.

DataApi *apiInstance = [[DataApi alloc] init];

// Gets a data file for download.
[apiInstance getDataFileWith:dataUuid
              completionHandler: ^(errorResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.DataApi()
var dataUuid = dataUuid_example; // {{String}} The UUID of the data file object to retrieve.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDataFile(dataUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDataFileExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new DataApi();
            var dataUuid = dataUuid_example;  // String | The UUID of the data file object to retrieve.

            try
            {
                // Gets a data file for download.
                errorResponse result = apiInstance.getDataFile(dataUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataApi.getDataFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiDataApi();
$dataUuid = dataUuid_example; // String | The UUID of the data file object to retrieve.

try {
    $result = $api_instance->getDataFile($dataUuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getDataFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DataApi->new();
my $dataUuid = dataUuid_example; # String | The UUID of the data file object to retrieve.

eval { 
    my $result = $api_instance->getDataFile(dataUuid => $dataUuid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataApi->getDataFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DataApi()
dataUuid = dataUuid_example # String | The UUID of the data file object to retrieve.

try: 
    # Gets a data file for download.
    api_response = api_instance.get_data_file(dataUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->getDataFile: %s\n" % e)

Parameters

Path parameters
Name Description
dataUuid*
String
The UUID of the data file object to retrieve.
Required

Responses

Status: 401 - Invalid authentication for this request.

Status: 403 - The request does not have authorisation.

Status: 404 - Requested data file not found or insufficient permissions to finds.

Status: default - Internal Server Error


getDataObject

Gets a data object.


/data/{dataUuid}

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/data/{dataUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataApi;

import java.io.File;
import java.util.*;

public class DataApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        DataApi apiInstance = new DataApi();
        String dataUuid = dataUuid_example; // String | The UUID of the data object to retrieve.
        try {
            dataObject result = apiInstance.getDataObject(dataUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#getDataObject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataApi;

public class DataApiExample {

    public static void main(String[] args) {
        DataApi apiInstance = new DataApi();
        String dataUuid = dataUuid_example; // String | The UUID of the data object to retrieve.
        try {
            dataObject result = apiInstance.getDataObject(dataUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#getDataObject");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *dataUuid = dataUuid_example; // The UUID of the data object to retrieve.

DataApi *apiInstance = [[DataApi alloc] init];

// Gets a data object.
[apiInstance getDataObjectWith:dataUuid
              completionHandler: ^(dataObject output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.DataApi()
var dataUuid = dataUuid_example; // {{String}} The UUID of the data object to retrieve.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDataObject(dataUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDataObjectExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new DataApi();
            var dataUuid = dataUuid_example;  // String | The UUID of the data object to retrieve.

            try
            {
                // Gets a data object.
                dataObject result = apiInstance.getDataObject(dataUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataApi.getDataObject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiDataApi();
$dataUuid = dataUuid_example; // String | The UUID of the data object to retrieve.

try {
    $result = $api_instance->getDataObject($dataUuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getDataObject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DataApi->new();
my $dataUuid = dataUuid_example; # String | The UUID of the data object to retrieve.

eval { 
    my $result = $api_instance->getDataObject(dataUuid => $dataUuid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataApi->getDataObject: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DataApi()
dataUuid = dataUuid_example # String | The UUID of the data object to retrieve.

try: 
    # Gets a data object.
    api_response = api_instance.get_data_object(dataUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->getDataObject: %s\n" % e)

Parameters

Path parameters
Name Description
dataUuid*
String
The UUID of the data object to retrieve.
Required

Responses

Status: 200 - Fetched the data object and transmitted in the message body.

Status: 401 - Invalid authentication for this request.

Status: 403 - The request does not have authorisation.

Status: 404 - Requested data object not found or insufficient permissions to find.

Status: default - Internal Server Error


getDataObjectsByUuidList

Gets a list of data object.


/data

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/data?uuids=&timezone="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataApi;

import java.io.File;
import java.util.*;

public class DataApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        DataApi apiInstance = new DataApi();
        String uuids = uuids_example; // String | A relay state variable to send
        String timezone = timezone_example; // String | timezone for the data object
        try {
            array[dataObject] result = apiInstance.getDataObjectsByUuidList(uuids, timezone);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#getDataObjectsByUuidList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataApi;

public class DataApiExample {

    public static void main(String[] args) {
        DataApi apiInstance = new DataApi();
        String uuids = uuids_example; // String | A relay state variable to send
        String timezone = timezone_example; // String | timezone for the data object
        try {
            array[dataObject] result = apiInstance.getDataObjectsByUuidList(uuids, timezone);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#getDataObjectsByUuidList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *uuids = uuids_example; // A relay state variable to send (optional)
String *timezone = timezone_example; // timezone for the data object (optional)

DataApi *apiInstance = [[DataApi alloc] init];

// Gets a list of data object.
[apiInstance getDataObjectsByUuidListWith:uuids
    timezone:timezone
              completionHandler: ^(array[dataObject] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.DataApi()
var opts = { 
  'uuids': uuids_example, // {{String}} A relay state variable to send
  'timezone': timezone_example // {{String}} timezone for the data object
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDataObjectsByUuidList(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDataObjectsByUuidListExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new DataApi();
            var uuids = uuids_example;  // String | A relay state variable to send (optional) 
            var timezone = timezone_example;  // String | timezone for the data object (optional) 

            try
            {
                // Gets a list of data object.
                array[dataObject] result = apiInstance.getDataObjectsByUuidList(uuids, timezone);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataApi.getDataObjectsByUuidList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiDataApi();
$uuids = uuids_example; // String | A relay state variable to send
$timezone = timezone_example; // String | timezone for the data object

try {
    $result = $api_instance->getDataObjectsByUuidList($uuids, $timezone);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getDataObjectsByUuidList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DataApi->new();
my $uuids = uuids_example; # String | A relay state variable to send
my $timezone = timezone_example; # String | timezone for the data object

eval { 
    my $result = $api_instance->getDataObjectsByUuidList(uuids => $uuids, timezone => $timezone);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataApi->getDataObjectsByUuidList: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DataApi()
uuids = uuids_example # String | A relay state variable to send (optional)
timezone = timezone_example # String | timezone for the data object (optional)

try: 
    # Gets a list of data object.
    api_response = api_instance.get_data_objects_by_uuid_list(uuids=uuids, timezone=timezone)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->getDataObjectsByUuidList: %s\n" % e)

Parameters

Query parameters
Name Description
uuids
String
A relay state variable to send
timezone
String
timezone for the data object

Responses

Status: 200 - Fetched the data object and transmitted in the message body.

Status: 401 - Invalid authentication for this request.

Status: 403 - The request does not have authorisation.

Status: 404 - Requested data object not found or insufficient permissions to find.

Status: default - Internal Server Error


postDataReply

Adds a reply to a comment.


/data/{dataUuid}

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/data/{dataUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataApi;

import java.io.File;
import java.util.*;

public class DataApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        DataApi apiInstance = new DataApi();
        DataObject body = ; // DataObject | The data object to update.
        String dataUuid = dataUuid_example; // String | The UUID of the data object to update.
        try {
            dataStub result = apiInstance.postDataReply(body, dataUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#postDataReply");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataApi;

public class DataApiExample {

    public static void main(String[] args) {
        DataApi apiInstance = new DataApi();
        DataObject body = ; // DataObject | The data object to update.
        String dataUuid = dataUuid_example; // String | The UUID of the data object to update.
        try {
            dataStub result = apiInstance.postDataReply(body, dataUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#postDataReply");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
DataObject *body = ; // The data object to update.
String *dataUuid = dataUuid_example; // The UUID of the data object to update.

DataApi *apiInstance = [[DataApi alloc] init];

// Adds a reply to a comment.
[apiInstance postDataReplyWith:body
    dataUuid:dataUuid
              completionHandler: ^(dataStub output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.DataApi()
var body = ; // {{DataObject}} The data object to update.
var dataUuid = dataUuid_example; // {{String}} The UUID of the data object to update.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postDataReply(bodydataUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class postDataReplyExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new DataApi();
            var body = new DataObject(); // DataObject | The data object to update.
            var dataUuid = dataUuid_example;  // String | The UUID of the data object to update.

            try
            {
                // Adds a reply to a comment.
                dataStub result = apiInstance.postDataReply(body, dataUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataApi.postDataReply: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiDataApi();
$body = ; // DataObject | The data object to update.
$dataUuid = dataUuid_example; // String | The UUID of the data object to update.

try {
    $result = $api_instance->postDataReply($body, $dataUuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->postDataReply: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DataApi->new();
my $body = WWW::SwaggerClient::Object::DataObject->new(); # DataObject | The data object to update.
my $dataUuid = dataUuid_example; # String | The UUID of the data object to update.

eval { 
    my $result = $api_instance->postDataReply(body => $body, dataUuid => $dataUuid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataApi->postDataReply: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DataApi()
body =  # DataObject | The data object to update.
dataUuid = dataUuid_example # String | The UUID of the data object to update.

try: 
    # Adds a reply to a comment.
    api_response = api_instance.post_data_reply(body, dataUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->postDataReply: %s\n" % e)

Parameters

Path parameters
Name Description
dataUuid*
String
The UUID of the data object to update.
Required
Body parameters
Name Description
body *

Responses

Status: 201 - The reply was created successfully.

Status: 400 - Failed to encrypt payload.

Status: 401 - Invalid authentication for this request.

Status: 403 - The request does not have authorisation.

Status: default - Internal Server Error


removeWatcherFromCase

Removes a watcher from a case.


/case/{caseUuid}/watch

Usage and SDK Samples

curl -X DELETE\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/case/{caseUuid}/watch"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataApi;

import java.io.File;
import java.util.*;

public class DataApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        DataApi apiInstance = new DataApi();
        String caseUuid = caseUuid_example; // String | The case to remove the watcher from.
        try {
            apiInstance.removeWatcherFromCase(caseUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#removeWatcherFromCase");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataApi;

public class DataApiExample {

    public static void main(String[] args) {
        DataApi apiInstance = new DataApi();
        String caseUuid = caseUuid_example; // String | The case to remove the watcher from.
        try {
            apiInstance.removeWatcherFromCase(caseUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#removeWatcherFromCase");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *caseUuid = caseUuid_example; // The case to remove the watcher from.

DataApi *apiInstance = [[DataApi alloc] init];

// Removes a watcher from a case.
[apiInstance removeWatcherFromCaseWith:caseUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.DataApi()
var caseUuid = caseUuid_example; // {{String}} The case to remove the watcher from.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeWatcherFromCase(caseUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class removeWatcherFromCaseExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new DataApi();
            var caseUuid = caseUuid_example;  // String | The case to remove the watcher from.

            try
            {
                // Removes a watcher from a case.
                apiInstance.removeWatcherFromCase(caseUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataApi.removeWatcherFromCase: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiDataApi();
$caseUuid = caseUuid_example; // String | The case to remove the watcher from.

try {
    $api_instance->removeWatcherFromCase($caseUuid);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->removeWatcherFromCase: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DataApi->new();
my $caseUuid = caseUuid_example; # String | The case to remove the watcher from.

eval { 
    $api_instance->removeWatcherFromCase(caseUuid => $caseUuid);
};
if ($@) {
    warn "Exception when calling DataApi->removeWatcherFromCase: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DataApi()
caseUuid = caseUuid_example # String | The case to remove the watcher from.

try: 
    # Removes a watcher from a case.
    api_instance.remove_watcher_from_case(caseUuid)
except ApiException as e:
    print("Exception when calling DataApi->removeWatcherFromCase: %s\n" % e)

Parameters

Path parameters
Name Description
caseUuid*
String
The case to remove the watcher from.
Required

Responses

Status: 204 - The watcher was removed successfully.

Status: default - Internal Server Error


updateData

Updates a data item.


/data/{dataUuid}

Usage and SDK Samples

curl -X PUT\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/data/{dataUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataApi;

import java.io.File;
import java.util.*;

public class DataApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        DataApi apiInstance = new DataApi();
        DataObject body = ; // DataObject | The data object to update.
        String dataUuid = dataUuid_example; // String | The UUID of the data object to update.
        try {
            dataStub result = apiInstance.updateData(body, dataUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#updateData");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataApi;

public class DataApiExample {

    public static void main(String[] args) {
        DataApi apiInstance = new DataApi();
        DataObject body = ; // DataObject | The data object to update.
        String dataUuid = dataUuid_example; // String | The UUID of the data object to update.
        try {
            dataStub result = apiInstance.updateData(body, dataUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#updateData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
DataObject *body = ; // The data object to update.
String *dataUuid = dataUuid_example; // The UUID of the data object to update.

DataApi *apiInstance = [[DataApi alloc] init];

// Updates a data item.
[apiInstance updateDataWith:body
    dataUuid:dataUuid
              completionHandler: ^(dataStub output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.DataApi()
var body = ; // {{DataObject}} The data object to update.
var dataUuid = dataUuid_example; // {{String}} The UUID of the data object to update.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateData(bodydataUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateDataExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new DataApi();
            var body = new DataObject(); // DataObject | The data object to update.
            var dataUuid = dataUuid_example;  // String | The UUID of the data object to update.

            try
            {
                // Updates a data item.
                dataStub result = apiInstance.updateData(body, dataUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataApi.updateData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiDataApi();
$body = ; // DataObject | The data object to update.
$dataUuid = dataUuid_example; // String | The UUID of the data object to update.

try {
    $result = $api_instance->updateData($body, $dataUuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->updateData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DataApi->new();
my $body = WWW::SwaggerClient::Object::DataObject->new(); # DataObject | The data object to update.
my $dataUuid = dataUuid_example; # String | The UUID of the data object to update.

eval { 
    my $result = $api_instance->updateData(body => $body, dataUuid => $dataUuid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataApi->updateData: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DataApi()
body =  # DataObject | The data object to update.
dataUuid = dataUuid_example # String | The UUID of the data object to update.

try: 
    # Updates a data item.
    api_response = api_instance.update_data(body, dataUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->updateData: %s\n" % e)

Parameters

Path parameters
Name Description
dataUuid*
String
The UUID of the data object to update.
Required
Body parameters
Name Description
body *

Responses

Status: 200 - The resource was updated successfully.

Status: 401 - Invalid authentication for this request.

Status: 403 - The request does not have authorisation.

Status: 404 - Requested data item not found or insufficient permissions to find.

Status: default - Internal Server Error


Default

getResources

Gets a list of resources.


/resource

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/resource"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        DefaultApi apiInstance = new DefaultApi();
        try {
            array[resource] result = apiInstance.getResources();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getResources");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            array[resource] result = apiInstance.getResources();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getResources");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];

DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Gets a list of resources.
[apiInstance getResourcesWithCompletionHandler: 
              ^(array[resource] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.DefaultApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getResources(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getResourcesExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new DefaultApi();

            try
            {
                // Gets a list of resources.
                array[resource] result = apiInstance.getResources();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getResources: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiDefaultApi();

try {
    $result = $api_instance->getResources();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getResources: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DefaultApi->new();

eval { 
    my $result = $api_instance->getResources();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->getResources: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()

try: 
    # Gets a list of resources.
    api_response = api_instance.get_resources()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->getResources: %s\n" % e)

Parameters

Responses

Status: 200 - Fetched a list of resources and transmitted in the message body.

Status: 401 - Invalid authentication for this request.

Status: 403 - Invalid authorization for this request.

Status: default - Internal Server Error


updateResource

Updates a resource


/resource/{resourceUuid}

Usage and SDK Samples

curl -X PUT\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/resource/{resourceUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        DefaultApi apiInstance = new DefaultApi();
        Resource body = ; // Resource | The resource body to update with.
        String resourceUuid = resourceUuid_example; // String | The UUID of the resource to update
        try {
            apiInstance.updateResource(body, resourceUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#updateResource");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Resource body = ; // Resource | The resource body to update with.
        String resourceUuid = resourceUuid_example; // String | The UUID of the resource to update
        try {
            apiInstance.updateResource(body, resourceUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#updateResource");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
Resource *body = ; // The resource body to update with.
String *resourceUuid = resourceUuid_example; // The UUID of the resource to update

DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance updateResourceWith:body
    resourceUuid:resourceUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.DefaultApi()
var body = ; // {{Resource}} The resource body to update with.
var resourceUuid = resourceUuid_example; // {{String}} The UUID of the resource to update

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateResource(bodyresourceUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateResourceExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new DefaultApi();
            var body = new Resource(); // Resource | The resource body to update with.
            var resourceUuid = resourceUuid_example;  // String | The UUID of the resource to update

            try
            {
                apiInstance.updateResource(body, resourceUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.updateResource: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiDefaultApi();
$body = ; // Resource | The resource body to update with.
$resourceUuid = resourceUuid_example; // String | The UUID of the resource to update

try {
    $api_instance->updateResource($body, $resourceUuid);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->updateResource: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $body = WWW::SwaggerClient::Object::Resource->new(); # Resource | The resource body to update with.
my $resourceUuid = resourceUuid_example; # String | The UUID of the resource to update

eval { 
    $api_instance->updateResource(body => $body, resourceUuid => $resourceUuid);
};
if ($@) {
    warn "Exception when calling DefaultApi->updateResource: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
body =  # Resource | The resource body to update with.
resourceUuid = resourceUuid_example # String | The UUID of the resource to update

try: 
    api_instance.update_resource(body, resourceUuid)
except ApiException as e:
    print("Exception when calling DefaultApi->updateResource: %s\n" % e)

Parameters

Path parameters
Name Description
resourceUuid*
String
The UUID of the resource to update
Required
Body parameters
Name Description
body *

Responses

Status: 200 - the resource has been updated successfully

Status: 401 - Invalid authentication for this request.

Status: 403 - Invalid authorization for this request.

Status: default - Internal Server Error


Form

createForm

Creates a form.


/form

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/form"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FormApi;

import java.io.File;
import java.util.*;

public class FormApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        FormApi apiInstance = new FormApi();
        Form body = ; // Form | The form to create.
        try {
            createResponse result = apiInstance.createForm(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormApi#createForm");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FormApi;

public class FormApiExample {

    public static void main(String[] args) {
        FormApi apiInstance = new FormApi();
        Form body = ; // Form | The form to create.
        try {
            createResponse result = apiInstance.createForm(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormApi#createForm");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
Form *body = ; // The form to create.

FormApi *apiInstance = [[FormApi alloc] init];

// Creates a form.
[apiInstance createFormWith:body
              completionHandler: ^(createResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.FormApi()
var body = ; // {{Form}} The form to create.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createForm(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createFormExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new FormApi();
            var body = new Form(); // Form | The form to create.

            try
            {
                // Creates a form.
                createResponse result = apiInstance.createForm(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FormApi.createForm: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiFormApi();
$body = ; // Form | The form to create.

try {
    $result = $api_instance->createForm($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FormApi->createForm: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FormApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::FormApi->new();
my $body = WWW::SwaggerClient::Object::Form->new(); # Form | The form to create.

eval { 
    my $result = $api_instance->createForm(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FormApi->createForm: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.FormApi()
body =  # Form | The form to create.

try: 
    # Creates a form.
    api_response = api_instance.create_form(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FormApi->createForm: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Created a form.

Status: default - Internal Server Error


deleteForm

Delete a form.


/form{formUuid}

Usage and SDK Samples

curl -X DELETE\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/form{formUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FormApi;

import java.io.File;
import java.util.*;

public class FormApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        FormApi apiInstance = new FormApi();
        String formUuid = formUuid_example; // String | The UUID of the form to delete.
        try {
            apiInstance.deleteForm(formUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormApi#deleteForm");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FormApi;

public class FormApiExample {

    public static void main(String[] args) {
        FormApi apiInstance = new FormApi();
        String formUuid = formUuid_example; // String | The UUID of the form to delete.
        try {
            apiInstance.deleteForm(formUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormApi#deleteForm");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *formUuid = formUuid_example; // The UUID of the form to delete.

FormApi *apiInstance = [[FormApi alloc] init];

// Delete a form.
[apiInstance deleteFormWith:formUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.FormApi()
var formUuid = formUuid_example; // {{String}} The UUID of the form to delete.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteForm(formUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteFormExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new FormApi();
            var formUuid = formUuid_example;  // String | The UUID of the form to delete.

            try
            {
                // Delete a form.
                apiInstance.deleteForm(formUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FormApi.deleteForm: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiFormApi();
$formUuid = formUuid_example; // String | The UUID of the form to delete.

try {
    $api_instance->deleteForm($formUuid);
} catch (Exception $e) {
    echo 'Exception when calling FormApi->deleteForm: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FormApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::FormApi->new();
my $formUuid = formUuid_example; # String | The UUID of the form to delete.

eval { 
    $api_instance->deleteForm(formUuid => $formUuid);
};
if ($@) {
    warn "Exception when calling FormApi->deleteForm: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.FormApi()
formUuid = formUuid_example # String | The UUID of the form to delete.

try: 
    # Delete a form.
    api_instance.delete_form(formUuid)
except ApiException as e:
    print("Exception when calling FormApi->deleteForm: %s\n" % e)

Parameters

Path parameters
Name Description
formUuid*
String
The UUID of the form to delete.
Required

Responses

Status: 204 - The form has been deleted successfully.

Status: 403 - The user has insufficient access to delete the form.

Status: 404 - The form intended to delete is not found.

Status: default - Internal Server Error


getForms

Gets a list of forms.


/form

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/form"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FormApi;

import java.io.File;
import java.util.*;

public class FormApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        FormApi apiInstance = new FormApi();
        try {
            array[form] result = apiInstance.getForms();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormApi#getForms");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FormApi;

public class FormApiExample {

    public static void main(String[] args) {
        FormApi apiInstance = new FormApi();
        try {
            array[form] result = apiInstance.getForms();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormApi#getForms");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];

FormApi *apiInstance = [[FormApi alloc] init];

// Gets a list of forms.
[apiInstance getFormsWithCompletionHandler: 
              ^(array[form] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.FormApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getForms(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getFormsExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new FormApi();

            try
            {
                // Gets a list of forms.
                array[form] result = apiInstance.getForms();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FormApi.getForms: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiFormApi();

try {
    $result = $api_instance->getForms();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FormApi->getForms: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FormApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::FormApi->new();

eval { 
    my $result = $api_instance->getForms();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FormApi->getForms: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.FormApi()

try: 
    # Gets a list of forms.
    api_response = api_instance.get_forms()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FormApi->getForms: %s\n" % e)

Parameters

Responses

Status: 200 - Fetched the list of forms and transmit in the message body

Status: default - Internal Server Error


updateForm

Updates a form.


/form{formUuid}

Usage and SDK Samples

curl -X PUT\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/form{formUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FormApi;

import java.io.File;
import java.util.*;

public class FormApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        FormApi apiInstance = new FormApi();
        Form body = ; // Form | The form to be updated.
        String formUuid = formUuid_example; // String | The UUID of the form to update.
        try {
            apiInstance.updateForm(body, formUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormApi#updateForm");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FormApi;

public class FormApiExample {

    public static void main(String[] args) {
        FormApi apiInstance = new FormApi();
        Form body = ; // Form | The form to be updated.
        String formUuid = formUuid_example; // String | The UUID of the form to update.
        try {
            apiInstance.updateForm(body, formUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormApi#updateForm");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
Form *body = ; // The form to be updated.
String *formUuid = formUuid_example; // The UUID of the form to update.

FormApi *apiInstance = [[FormApi alloc] init];

// Updates a form.
[apiInstance updateFormWith:body
    formUuid:formUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.FormApi()
var body = ; // {{Form}} The form to be updated.
var formUuid = formUuid_example; // {{String}} The UUID of the form to update.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateForm(bodyformUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateFormExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new FormApi();
            var body = new Form(); // Form | The form to be updated.
            var formUuid = formUuid_example;  // String | The UUID of the form to update.

            try
            {
                // Updates a form.
                apiInstance.updateForm(body, formUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FormApi.updateForm: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiFormApi();
$body = ; // Form | The form to be updated.
$formUuid = formUuid_example; // String | The UUID of the form to update.

try {
    $api_instance->updateForm($body, $formUuid);
} catch (Exception $e) {
    echo 'Exception when calling FormApi->updateForm: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FormApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::FormApi->new();
my $body = WWW::SwaggerClient::Object::Form->new(); # Form | The form to be updated.
my $formUuid = formUuid_example; # String | The UUID of the form to update.

eval { 
    $api_instance->updateForm(body => $body, formUuid => $formUuid);
};
if ($@) {
    warn "Exception when calling FormApi->updateForm: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.FormApi()
body =  # Form | The form to be updated.
formUuid = formUuid_example # String | The UUID of the form to update.

try: 
    # Updates a form.
    api_instance.update_form(body, formUuid)
except ApiException as e:
    print("Exception when calling FormApi->updateForm: %s\n" % e)

Parameters

Path parameters
Name Description
formUuid*
String
The UUID of the form to update.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - The form has been updated successfully.

Status: 403 - The user has insufficient access to update the form.

Status: 404 - The form intended to update is not found.

Status: default - Internal Server Error


Group

addGroupToGroup

Adds a group to another group.


/group/{groupUuid}/group/{memberGroupUuid}

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/group/{groupUuid}/group/{memberGroupUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GroupApi;

import java.io.File;
import java.util.*;

public class GroupApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        GroupApi apiInstance = new GroupApi();
        String groupUuid = groupUuid_example; // String | The group to modify.
        String memberGroupUuid = memberGroupUuid_example; // String | The UUID of the group to add.
        try {
            createResponse result = apiInstance.addGroupToGroup(groupUuid, memberGroupUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupApi#addGroupToGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GroupApi;

public class GroupApiExample {

    public static void main(String[] args) {
        GroupApi apiInstance = new GroupApi();
        String groupUuid = groupUuid_example; // String | The group to modify.
        String memberGroupUuid = memberGroupUuid_example; // String | The UUID of the group to add.
        try {
            createResponse result = apiInstance.addGroupToGroup(groupUuid, memberGroupUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupApi#addGroupToGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *groupUuid = groupUuid_example; // The group to modify.
String *memberGroupUuid = memberGroupUuid_example; // The UUID of the group to add.

GroupApi *apiInstance = [[GroupApi alloc] init];

// Adds a group to another group.
[apiInstance addGroupToGroupWith:groupUuid
    memberGroupUuid:memberGroupUuid
              completionHandler: ^(createResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.GroupApi()
var groupUuid = groupUuid_example; // {{String}} The group to modify.
var memberGroupUuid = memberGroupUuid_example; // {{String}} The UUID of the group to add.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addGroupToGroup(groupUuid, memberGroupUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addGroupToGroupExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new GroupApi();
            var groupUuid = groupUuid_example;  // String | The group to modify.
            var memberGroupUuid = memberGroupUuid_example;  // String | The UUID of the group to add.

            try
            {
                // Adds a group to another group.
                createResponse result = apiInstance.addGroupToGroup(groupUuid, memberGroupUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GroupApi.addGroupToGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiGroupApi();
$groupUuid = groupUuid_example; // String | The group to modify.
$memberGroupUuid = memberGroupUuid_example; // String | The UUID of the group to add.

try {
    $result = $api_instance->addGroupToGroup($groupUuid, $memberGroupUuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupApi->addGroupToGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GroupApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::GroupApi->new();
my $groupUuid = groupUuid_example; # String | The group to modify.
my $memberGroupUuid = memberGroupUuid_example; # String | The UUID of the group to add.

eval { 
    my $result = $api_instance->addGroupToGroup(groupUuid => $groupUuid, memberGroupUuid => $memberGroupUuid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GroupApi->addGroupToGroup: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.GroupApi()
groupUuid = groupUuid_example # String | The group to modify.
memberGroupUuid = memberGroupUuid_example # String | The UUID of the group to add.

try: 
    # Adds a group to another group.
    api_response = api_instance.add_group_to_group(groupUuid, memberGroupUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GroupApi->addGroupToGroup: %s\n" % e)

Parameters

Path parameters
Name Description
groupUuid*
String
The group to modify.
Required
memberGroupUuid*
String
The UUID of the group to add.
Required

Responses

Status: 200 - Group had been added successfully.

Status: default - Internal Server Error


addUserToGroup

Add a user to a group.


/group/{groupUuid}/user/{memberUserUuid}

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/group/{groupUuid}/user/{memberUserUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GroupApi;

import java.io.File;
import java.util.*;

public class GroupApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        GroupApi apiInstance = new GroupApi();
        String groupUuid = groupUuid_example; // String | The group to modify.
        String memberUserUuid = memberUserUuid_example; // String | The UUID of the user to add.
        try {
            createResponse result = apiInstance.addUserToGroup(groupUuid, memberUserUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupApi#addUserToGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GroupApi;

public class GroupApiExample {

    public static void main(String[] args) {
        GroupApi apiInstance = new GroupApi();
        String groupUuid = groupUuid_example; // String | The group to modify.
        String memberUserUuid = memberUserUuid_example; // String | The UUID of the user to add.
        try {
            createResponse result = apiInstance.addUserToGroup(groupUuid, memberUserUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupApi#addUserToGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *groupUuid = groupUuid_example; // The group to modify.
String *memberUserUuid = memberUserUuid_example; // The UUID of the user to add.

GroupApi *apiInstance = [[GroupApi alloc] init];

// Add a user to a group.
[apiInstance addUserToGroupWith:groupUuid
    memberUserUuid:memberUserUuid
              completionHandler: ^(createResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.GroupApi()
var groupUuid = groupUuid_example; // {{String}} The group to modify.
var memberUserUuid = memberUserUuid_example; // {{String}} The UUID of the user to add.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addUserToGroup(groupUuid, memberUserUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addUserToGroupExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new GroupApi();
            var groupUuid = groupUuid_example;  // String | The group to modify.
            var memberUserUuid = memberUserUuid_example;  // String | The UUID of the user to add.

            try
            {
                // Add a user to a group.
                createResponse result = apiInstance.addUserToGroup(groupUuid, memberUserUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GroupApi.addUserToGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiGroupApi();
$groupUuid = groupUuid_example; // String | The group to modify.
$memberUserUuid = memberUserUuid_example; // String | The UUID of the user to add.

try {
    $result = $api_instance->addUserToGroup($groupUuid, $memberUserUuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupApi->addUserToGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GroupApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::GroupApi->new();
my $groupUuid = groupUuid_example; # String | The group to modify.
my $memberUserUuid = memberUserUuid_example; # String | The UUID of the user to add.

eval { 
    my $result = $api_instance->addUserToGroup(groupUuid => $groupUuid, memberUserUuid => $memberUserUuid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GroupApi->addUserToGroup: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.GroupApi()
groupUuid = groupUuid_example # String | The group to modify.
memberUserUuid = memberUserUuid_example # String | The UUID of the user to add.

try: 
    # Add a user to a group.
    api_response = api_instance.add_user_to_group(groupUuid, memberUserUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GroupApi->addUserToGroup: %s\n" % e)

Parameters

Path parameters
Name Description
groupUuid*
String
The group to modify.
Required
memberUserUuid*
String
The UUID of the user to add.
Required

Responses

Status: 200 - The user has been added to the group successfully.

Status: default - Internal Server Error


createGroup

Creates a group.


/group

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/group"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GroupApi;

import java.io.File;
import java.util.*;

public class GroupApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        GroupApi apiInstance = new GroupApi();
        Group body = ; // Group | The group to create.
        try {
            createResponse result = apiInstance.createGroup(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupApi#createGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GroupApi;

public class GroupApiExample {

    public static void main(String[] args) {
        GroupApi apiInstance = new GroupApi();
        Group body = ; // Group | The group to create.
        try {
            createResponse result = apiInstance.createGroup(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupApi#createGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
Group *body = ; // The group to create.

GroupApi *apiInstance = [[GroupApi alloc] init];

// Creates a group.
[apiInstance createGroupWith:body
              completionHandler: ^(createResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.GroupApi()
var body = ; // {{Group}} The group to create.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createGroup(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createGroupExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new GroupApi();
            var body = new Group(); // Group | The group to create.

            try
            {
                // Creates a group.
                createResponse result = apiInstance.createGroup(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GroupApi.createGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiGroupApi();
$body = ; // Group | The group to create.

try {
    $result = $api_instance->createGroup($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupApi->createGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GroupApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::GroupApi->new();
my $body = WWW::SwaggerClient::Object::Group->new(); # Group | The group to create.

eval { 
    my $result = $api_instance->createGroup(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GroupApi->createGroup: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.GroupApi()
body =  # Group | The group to create.

try: 
    # Creates a group.
    api_response = api_instance.create_group(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GroupApi->createGroup: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Created a group.

Status: 400 - Failed to parse byte data as X509 certificate.

Status: default - Internal Server Error


getGroupGraph

Gets the group graph.


/group/graph

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/group/graph"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GroupApi;

import java.io.File;
import java.util.*;

public class GroupApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        GroupApi apiInstance = new GroupApi();
        try {
            groupGraph result = apiInstance.getGroupGraph();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupApi#getGroupGraph");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GroupApi;

public class GroupApiExample {

    public static void main(String[] args) {
        GroupApi apiInstance = new GroupApi();
        try {
            groupGraph result = apiInstance.getGroupGraph();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupApi#getGroupGraph");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];

GroupApi *apiInstance = [[GroupApi alloc] init];

// Gets the group graph.
[apiInstance getGroupGraphWithCompletionHandler: 
              ^(groupGraph output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.GroupApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGroupGraph(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getGroupGraphExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new GroupApi();

            try
            {
                // Gets the group graph.
                groupGraph result = apiInstance.getGroupGraph();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GroupApi.getGroupGraph: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiGroupApi();

try {
    $result = $api_instance->getGroupGraph();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupApi->getGroupGraph: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GroupApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::GroupApi->new();

eval { 
    my $result = $api_instance->getGroupGraph();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GroupApi->getGroupGraph: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.GroupApi()

try: 
    # Gets the group graph.
    api_response = api_instance.get_group_graph()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GroupApi->getGroupGraph: %s\n" % e)

Parameters

Responses

Status: 200 - Message body contains group graph.

Status: default - Internal Server Error


getGroupGroupMembers

Gets the group members of a group.


/group/{groupUuid}/group

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/group/{groupUuid}/group"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GroupApi;

import java.io.File;
import java.util.*;

public class GroupApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        GroupApi apiInstance = new GroupApi();
        String groupUuid = groupUuid_example; // String | The UUID of the group to retrieve
        try {
            group result = apiInstance.getGroupGroupMembers(groupUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupApi#getGroupGroupMembers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GroupApi;

public class GroupApiExample {

    public static void main(String[] args) {
        GroupApi apiInstance = new GroupApi();
        String groupUuid = groupUuid_example; // String | The UUID of the group to retrieve
        try {
            group result = apiInstance.getGroupGroupMembers(groupUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupApi#getGroupGroupMembers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *groupUuid = groupUuid_example; // The UUID of the group to retrieve

GroupApi *apiInstance = [[GroupApi alloc] init];

// Gets the group members of a group.
[apiInstance getGroupGroupMembersWith:groupUuid
              completionHandler: ^(group output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.GroupApi()
var groupUuid = groupUuid_example; // {{String}} The UUID of the group to retrieve

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGroupGroupMembers(groupUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getGroupGroupMembersExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new GroupApi();
            var groupUuid = groupUuid_example;  // String | The UUID of the group to retrieve

            try
            {
                // Gets the group members of a group.
                group result = apiInstance.getGroupGroupMembers(groupUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GroupApi.getGroupGroupMembers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiGroupApi();
$groupUuid = groupUuid_example; // String | The UUID of the group to retrieve

try {
    $result = $api_instance->getGroupGroupMembers($groupUuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupApi->getGroupGroupMembers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GroupApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::GroupApi->new();
my $groupUuid = groupUuid_example; # String | The UUID of the group to retrieve

eval { 
    my $result = $api_instance->getGroupGroupMembers(groupUuid => $groupUuid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GroupApi->getGroupGroupMembers: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.GroupApi()
groupUuid = groupUuid_example # String | The UUID of the group to retrieve

try: 
    # Gets the group members of a group.
    api_response = api_instance.get_group_group_members(groupUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GroupApi->getGroupGroupMembers: %s\n" % e)

Parameters

Path parameters
Name Description
groupUuid*
String
The UUID of the group to retrieve
Required

Responses

Status: 200 - Fetched group members of a group and transmitted in message body.

Status: 400 - Failed to parse UUID.

Status: default - Internal Server Error


getGroupUserMembers

Gets the user members of a group.


/group/{groupUuid}/user

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/group/{groupUuid}/user?recursive="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GroupApi;

import java.io.File;
import java.util.*;

public class GroupApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        GroupApi apiInstance = new GroupApi();
        String groupUuid = groupUuid_example; // String | The UUID of the group to retrieve.
        Boolean recursive = true; // Boolean | Whether to retrieve member users of member groups.
        try {
            group result = apiInstance.getGroupUserMembers(groupUuid, recursive);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupApi#getGroupUserMembers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GroupApi;

public class GroupApiExample {

    public static void main(String[] args) {
        GroupApi apiInstance = new GroupApi();
        String groupUuid = groupUuid_example; // String | The UUID of the group to retrieve.
        Boolean recursive = true; // Boolean | Whether to retrieve member users of member groups.
        try {
            group result = apiInstance.getGroupUserMembers(groupUuid, recursive);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupApi#getGroupUserMembers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *groupUuid = groupUuid_example; // The UUID of the group to retrieve.
Boolean *recursive = true; // Whether to retrieve member users of member groups. (optional) (default to false)

GroupApi *apiInstance = [[GroupApi alloc] init];

// Gets the user members of a group.
[apiInstance getGroupUserMembersWith:groupUuid
    recursive:recursive
              completionHandler: ^(group output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.GroupApi()
var groupUuid = groupUuid_example; // {{String}} The UUID of the group to retrieve.
var opts = { 
  'recursive': true // {{Boolean}} Whether to retrieve member users of member groups.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGroupUserMembers(groupUuid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getGroupUserMembersExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new GroupApi();
            var groupUuid = groupUuid_example;  // String | The UUID of the group to retrieve.
            var recursive = true;  // Boolean | Whether to retrieve member users of member groups. (optional)  (default to false)

            try
            {
                // Gets the user members of a group.
                group result = apiInstance.getGroupUserMembers(groupUuid, recursive);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GroupApi.getGroupUserMembers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiGroupApi();
$groupUuid = groupUuid_example; // String | The UUID of the group to retrieve.
$recursive = true; // Boolean | Whether to retrieve member users of member groups.

try {
    $result = $api_instance->getGroupUserMembers($groupUuid, $recursive);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupApi->getGroupUserMembers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GroupApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::GroupApi->new();
my $groupUuid = groupUuid_example; # String | The UUID of the group to retrieve.
my $recursive = true; # Boolean | Whether to retrieve member users of member groups.

eval { 
    my $result = $api_instance->getGroupUserMembers(groupUuid => $groupUuid, recursive => $recursive);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GroupApi->getGroupUserMembers: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.GroupApi()
groupUuid = groupUuid_example # String | The UUID of the group to retrieve.
recursive = true # Boolean | Whether to retrieve member users of member groups. (optional) (default to false)

try: 
    # Gets the user members of a group.
    api_response = api_instance.get_group_user_members(groupUuid, recursive=recursive)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GroupApi->getGroupUserMembers: %s\n" % e)

Parameters

Path parameters
Name Description
groupUuid*
String
The UUID of the group to retrieve.
Required
Query parameters
Name Description
recursive
Boolean
Whether to retrieve member users of member groups.

Responses

Status: 200 - Fetched user members of a group and transmitted in message body.

Status: default - Internal Server Error


getGroups

Gets a list of groups.


/group

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/group"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GroupApi;

import java.io.File;
import java.util.*;

public class GroupApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        GroupApi apiInstance = new GroupApi();
        try {
            array[group] result = apiInstance.getGroups();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupApi#getGroups");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GroupApi;

public class GroupApiExample {

    public static void main(String[] args) {
        GroupApi apiInstance = new GroupApi();
        try {
            array[group] result = apiInstance.getGroups();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupApi#getGroups");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];

GroupApi *apiInstance = [[GroupApi alloc] init];

// Gets a list of groups.
[apiInstance getGroupsWithCompletionHandler: 
              ^(array[group] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.GroupApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGroups(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getGroupsExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new GroupApi();

            try
            {
                // Gets a list of groups.
                array[group] result = apiInstance.getGroups();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GroupApi.getGroups: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiGroupApi();

try {
    $result = $api_instance->getGroups();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupApi->getGroups: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GroupApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::GroupApi->new();

eval { 
    my $result = $api_instance->getGroups();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GroupApi->getGroups: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.GroupApi()

try: 
    # Gets a list of groups.
    api_response = api_instance.get_groups()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GroupApi->getGroups: %s\n" % e)

Parameters

Responses

Status: 200 - A list of groups.

Status: default - Internal Server Error


removeGroupFromGroup

Removes a group from a group.


/group/{groupUuid}/group/{memberGroupUuid}

Usage and SDK Samples

curl -X DELETE\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/group/{groupUuid}/group/{memberGroupUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GroupApi;

import java.io.File;
import java.util.*;

public class GroupApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        GroupApi apiInstance = new GroupApi();
        String groupUuid = groupUuid_example; // String | The UUID of the group to modify.
        String memberGroupUuid = memberGroupUuid_example; // String | The UUID of the group to remove.
        try {
            apiInstance.removeGroupFromGroup(groupUuid, memberGroupUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupApi#removeGroupFromGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GroupApi;

public class GroupApiExample {

    public static void main(String[] args) {
        GroupApi apiInstance = new GroupApi();
        String groupUuid = groupUuid_example; // String | The UUID of the group to modify.
        String memberGroupUuid = memberGroupUuid_example; // String | The UUID of the group to remove.
        try {
            apiInstance.removeGroupFromGroup(groupUuid, memberGroupUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupApi#removeGroupFromGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *groupUuid = groupUuid_example; // The UUID of the group to modify.
String *memberGroupUuid = memberGroupUuid_example; // The UUID of the group to remove.

GroupApi *apiInstance = [[GroupApi alloc] init];

// Removes a group from a group.
[apiInstance removeGroupFromGroupWith:groupUuid
    memberGroupUuid:memberGroupUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.GroupApi()
var groupUuid = groupUuid_example; // {{String}} The UUID of the group to modify.
var memberGroupUuid = memberGroupUuid_example; // {{String}} The UUID of the group to remove.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeGroupFromGroup(groupUuid, memberGroupUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class removeGroupFromGroupExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new GroupApi();
            var groupUuid = groupUuid_example;  // String | The UUID of the group to modify.
            var memberGroupUuid = memberGroupUuid_example;  // String | The UUID of the group to remove.

            try
            {
                // Removes a group from a group.
                apiInstance.removeGroupFromGroup(groupUuid, memberGroupUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GroupApi.removeGroupFromGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiGroupApi();
$groupUuid = groupUuid_example; // String | The UUID of the group to modify.
$memberGroupUuid = memberGroupUuid_example; // String | The UUID of the group to remove.

try {
    $api_instance->removeGroupFromGroup($groupUuid, $memberGroupUuid);
} catch (Exception $e) {
    echo 'Exception when calling GroupApi->removeGroupFromGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GroupApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::GroupApi->new();
my $groupUuid = groupUuid_example; # String | The UUID of the group to modify.
my $memberGroupUuid = memberGroupUuid_example; # String | The UUID of the group to remove.

eval { 
    $api_instance->removeGroupFromGroup(groupUuid => $groupUuid, memberGroupUuid => $memberGroupUuid);
};
if ($@) {
    warn "Exception when calling GroupApi->removeGroupFromGroup: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.GroupApi()
groupUuid = groupUuid_example # String | The UUID of the group to modify.
memberGroupUuid = memberGroupUuid_example # String | The UUID of the group to remove.

try: 
    # Removes a group from a group.
    api_instance.remove_group_from_group(groupUuid, memberGroupUuid)
except ApiException as e:
    print("Exception when calling GroupApi->removeGroupFromGroup: %s\n" % e)

Parameters

Path parameters
Name Description
groupUuid*
String
The UUID of the group to modify.
Required
memberGroupUuid*
String
The UUID of the group to remove.
Required

Responses

Status: 204 - The group was deleted successfully.

Status: default - Internal Server Error


removeUserFromGroup

Removes a user from a group.


/group/{groupUuid}/user/{memberUserUuid}

Usage and SDK Samples

curl -X DELETE\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/group/{groupUuid}/user/{memberUserUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GroupApi;

import java.io.File;
import java.util.*;

public class GroupApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        GroupApi apiInstance = new GroupApi();
        String groupUuid = groupUuid_example; // String | The UUID of the group to modify.
        String memberUserUuid = memberUserUuid_example; // String | The UUID of the user to remove.
        try {
            apiInstance.removeUserFromGroup(groupUuid, memberUserUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupApi#removeUserFromGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GroupApi;

public class GroupApiExample {

    public static void main(String[] args) {
        GroupApi apiInstance = new GroupApi();
        String groupUuid = groupUuid_example; // String | The UUID of the group to modify.
        String memberUserUuid = memberUserUuid_example; // String | The UUID of the user to remove.
        try {
            apiInstance.removeUserFromGroup(groupUuid, memberUserUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupApi#removeUserFromGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *groupUuid = groupUuid_example; // The UUID of the group to modify.
String *memberUserUuid = memberUserUuid_example; // The UUID of the user to remove.

GroupApi *apiInstance = [[GroupApi alloc] init];

// Removes a user from a group.
[apiInstance removeUserFromGroupWith:groupUuid
    memberUserUuid:memberUserUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.GroupApi()
var groupUuid = groupUuid_example; // {{String}} The UUID of the group to modify.
var memberUserUuid = memberUserUuid_example; // {{String}} The UUID of the user to remove.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeUserFromGroup(groupUuid, memberUserUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class removeUserFromGroupExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new GroupApi();
            var groupUuid = groupUuid_example;  // String | The UUID of the group to modify.
            var memberUserUuid = memberUserUuid_example;  // String | The UUID of the user to remove.

            try
            {
                // Removes a user from a group.
                apiInstance.removeUserFromGroup(groupUuid, memberUserUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GroupApi.removeUserFromGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiGroupApi();
$groupUuid = groupUuid_example; // String | The UUID of the group to modify.
$memberUserUuid = memberUserUuid_example; // String | The UUID of the user to remove.

try {
    $api_instance->removeUserFromGroup($groupUuid, $memberUserUuid);
} catch (Exception $e) {
    echo 'Exception when calling GroupApi->removeUserFromGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GroupApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::GroupApi->new();
my $groupUuid = groupUuid_example; # String | The UUID of the group to modify.
my $memberUserUuid = memberUserUuid_example; # String | The UUID of the user to remove.

eval { 
    $api_instance->removeUserFromGroup(groupUuid => $groupUuid, memberUserUuid => $memberUserUuid);
};
if ($@) {
    warn "Exception when calling GroupApi->removeUserFromGroup: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.GroupApi()
groupUuid = groupUuid_example # String | The UUID of the group to modify.
memberUserUuid = memberUserUuid_example # String | The UUID of the user to remove.

try: 
    # Removes a user from a group.
    api_instance.remove_user_from_group(groupUuid, memberUserUuid)
except ApiException as e:
    print("Exception when calling GroupApi->removeUserFromGroup: %s\n" % e)

Parameters

Path parameters
Name Description
groupUuid*
String
The UUID of the group to modify.
Required
memberUserUuid*
String
The UUID of the user to remove.
Required

Responses

Status: 204 - The user was deleted successfully.

Status: default - Internal Server Error


Meta

createMeta

Creates a metadata field definition.


/meta

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/meta"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MetaApi;

import java.io.File;
import java.util.*;

public class MetaApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        MetaApi apiInstance = new MetaApi();
        MetaName body = ; // MetaName | The metadata field to create.
        try {
            createResponse result = apiInstance.createMeta(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MetaApi#createMeta");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MetaApi;

public class MetaApiExample {

    public static void main(String[] args) {
        MetaApi apiInstance = new MetaApi();
        MetaName body = ; // MetaName | The metadata field to create.
        try {
            createResponse result = apiInstance.createMeta(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MetaApi#createMeta");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
MetaName *body = ; // The metadata field to create.

MetaApi *apiInstance = [[MetaApi alloc] init];

// Creates a metadata field definition.
[apiInstance createMetaWith:body
              completionHandler: ^(createResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.MetaApi()
var body = ; // {{MetaName}} The metadata field to create.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createMeta(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createMetaExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new MetaApi();
            var body = new MetaName(); // MetaName | The metadata field to create.

            try
            {
                // Creates a metadata field definition.
                createResponse result = apiInstance.createMeta(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MetaApi.createMeta: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiMetaApi();
$body = ; // MetaName | The metadata field to create.

try {
    $result = $api_instance->createMeta($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MetaApi->createMeta: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MetaApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::MetaApi->new();
my $body = WWW::SwaggerClient::Object::MetaName->new(); # MetaName | The metadata field to create.

eval { 
    my $result = $api_instance->createMeta(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MetaApi->createMeta: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.MetaApi()
body =  # MetaName | The metadata field to create.

try: 
    # Creates a metadata field definition.
    api_response = api_instance.create_meta(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MetaApi->createMeta: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Created the metadata field definition.

Status: 401 - Invalid authentication for this request.

Status: 403 - Session not authorised to create case.

Status: default - Internal Server Error


deleteMeta

Deletes a metadata item.


/meta/{metaUuid}

Usage and SDK Samples

curl -X DELETE\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/meta/{metaUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MetaApi;

import java.io.File;
import java.util.*;

public class MetaApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        MetaApi apiInstance = new MetaApi();
        String metaUuid = metaUuid_example; // String | The UUID of the metadata to delete.
        try {
            apiInstance.deleteMeta(metaUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling MetaApi#deleteMeta");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MetaApi;

public class MetaApiExample {

    public static void main(String[] args) {
        MetaApi apiInstance = new MetaApi();
        String metaUuid = metaUuid_example; // String | The UUID of the metadata to delete.
        try {
            apiInstance.deleteMeta(metaUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling MetaApi#deleteMeta");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *metaUuid = metaUuid_example; // The UUID of the metadata to delete.

MetaApi *apiInstance = [[MetaApi alloc] init];

// Deletes a metadata item.
[apiInstance deleteMetaWith:metaUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.MetaApi()
var metaUuid = metaUuid_example; // {{String}} The UUID of the metadata to delete.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteMeta(metaUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteMetaExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new MetaApi();
            var metaUuid = metaUuid_example;  // String | The UUID of the metadata to delete.

            try
            {
                // Deletes a metadata item.
                apiInstance.deleteMeta(metaUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MetaApi.deleteMeta: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiMetaApi();
$metaUuid = metaUuid_example; // String | The UUID of the metadata to delete.

try {
    $api_instance->deleteMeta($metaUuid);
} catch (Exception $e) {
    echo 'Exception when calling MetaApi->deleteMeta: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MetaApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::MetaApi->new();
my $metaUuid = metaUuid_example; # String | The UUID of the metadata to delete.

eval { 
    $api_instance->deleteMeta(metaUuid => $metaUuid);
};
if ($@) {
    warn "Exception when calling MetaApi->deleteMeta: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.MetaApi()
metaUuid = metaUuid_example # String | The UUID of the metadata to delete.

try: 
    # Deletes a metadata item.
    api_instance.delete_meta(metaUuid)
except ApiException as e:
    print("Exception when calling MetaApi->deleteMeta: %s\n" % e)

Parameters

Path parameters
Name Description
metaUuid*
String
The UUID of the metadata to delete.
Required

Responses

Status: 200 - The resource was deleted successfully.

Status: 401 - Invalid authentication for this request.

Status: 403 - The request does not have authorisation.

Status: 404 - Requested metadata not found or insufficient permissions to find.

Status: default - Internal Server Error


getMetas

Gets a list of metadata fields.


/meta

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/meta"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MetaApi;

import java.io.File;
import java.util.*;

public class MetaApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        MetaApi apiInstance = new MetaApi();
        try {
            array[metaName] result = apiInstance.getMetas();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MetaApi#getMetas");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MetaApi;

public class MetaApiExample {

    public static void main(String[] args) {
        MetaApi apiInstance = new MetaApi();
        try {
            array[metaName] result = apiInstance.getMetas();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MetaApi#getMetas");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];

MetaApi *apiInstance = [[MetaApi alloc] init];

// Gets a list of metadata fields.
[apiInstance getMetasWithCompletionHandler: 
              ^(array[metaName] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.MetaApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMetas(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMetasExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new MetaApi();

            try
            {
                // Gets a list of metadata fields.
                array[metaName] result = apiInstance.getMetas();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MetaApi.getMetas: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiMetaApi();

try {
    $result = $api_instance->getMetas();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MetaApi->getMetas: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MetaApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::MetaApi->new();

eval { 
    my $result = $api_instance->getMetas();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MetaApi->getMetas: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.MetaApi()

try: 
    # Gets a list of metadata fields.
    api_response = api_instance.get_metas()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MetaApi->getMetas: %s\n" % e)

Parameters

Responses

Status: 200 - Fetched the list of metadata fields and transmitted in the message body.

Status: default - Internal Server Error


updateMeta

Updates a metadata item.


/meta/{metaUuid}

Usage and SDK Samples

curl -X PUT\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/meta/{metaUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MetaApi;

import java.io.File;
import java.util.*;

public class MetaApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        MetaApi apiInstance = new MetaApi();
        MetaName body = ; // MetaName | The updated metadata field.
        String metaUuid = metaUuid_example; // String | The UUID of the metadata to delete.
        try {
            apiInstance.updateMeta(body, metaUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling MetaApi#updateMeta");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MetaApi;

public class MetaApiExample {

    public static void main(String[] args) {
        MetaApi apiInstance = new MetaApi();
        MetaName body = ; // MetaName | The updated metadata field.
        String metaUuid = metaUuid_example; // String | The UUID of the metadata to delete.
        try {
            apiInstance.updateMeta(body, metaUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling MetaApi#updateMeta");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
MetaName *body = ; // The updated metadata field.
String *metaUuid = metaUuid_example; // The UUID of the metadata to delete.

MetaApi *apiInstance = [[MetaApi alloc] init];

// Updates a metadata item.
[apiInstance updateMetaWith:body
    metaUuid:metaUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.MetaApi()
var body = ; // {{MetaName}} The updated metadata field.
var metaUuid = metaUuid_example; // {{String}} The UUID of the metadata to delete.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateMeta(bodymetaUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateMetaExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new MetaApi();
            var body = new MetaName(); // MetaName | The updated metadata field.
            var metaUuid = metaUuid_example;  // String | The UUID of the metadata to delete.

            try
            {
                // Updates a metadata item.
                apiInstance.updateMeta(body, metaUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MetaApi.updateMeta: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiMetaApi();
$body = ; // MetaName | The updated metadata field.
$metaUuid = metaUuid_example; // String | The UUID of the metadata to delete.

try {
    $api_instance->updateMeta($body, $metaUuid);
} catch (Exception $e) {
    echo 'Exception when calling MetaApi->updateMeta: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MetaApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::MetaApi->new();
my $body = WWW::SwaggerClient::Object::MetaName->new(); # MetaName | The updated metadata field.
my $metaUuid = metaUuid_example; # String | The UUID of the metadata to delete.

eval { 
    $api_instance->updateMeta(body => $body, metaUuid => $metaUuid);
};
if ($@) {
    warn "Exception when calling MetaApi->updateMeta: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.MetaApi()
body =  # MetaName | The updated metadata field.
metaUuid = metaUuid_example # String | The UUID of the metadata to delete.

try: 
    # Updates a metadata item.
    api_instance.update_meta(body, metaUuid)
except ApiException as e:
    print("Exception when calling MetaApi->updateMeta: %s\n" % e)

Parameters

Path parameters
Name Description
metaUuid*
String
The UUID of the metadata to delete.
Required
Body parameters
Name Description
body *

Responses

Status: 200 - The resource was updated successfully.

Status: 401 - Invalid authentication for this request.

Status: 403 - The request does not have authorisation.

Status: 404 - Requested metadata not found or insufficient permissions to find.

Status: default - Internal Server Error


Metrics

getMetricsCases

Gets a metrics report on cases. (This endpoint is currently disabled)


/metrics/cases

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/metrics/cases?start=&end="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.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: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        MetricsApi apiInstance = new MetricsApi();
        String start = start_example; // String | The start time as an RFC3339 timestamp
        String end = end_example; // String | The end time as an RFC3339 timestamp
        try {
            openCloseMetrics result = apiInstance.getMetricsCases(start, end);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MetricsApi#getMetricsCases");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MetricsApi;

public class MetricsApiExample {

    public static void main(String[] args) {
        MetricsApi apiInstance = new MetricsApi();
        String start = start_example; // String | The start time as an RFC3339 timestamp
        String end = end_example; // String | The end time as an RFC3339 timestamp
        try {
            openCloseMetrics result = apiInstance.getMetricsCases(start, end);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MetricsApi#getMetricsCases");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *start = start_example; // The start time as an RFC3339 timestamp
String *end = end_example; // The end time as an RFC3339 timestamp

MetricsApi *apiInstance = [[MetricsApi alloc] init];

[apiInstance getMetricsCasesWith:start
    end:end
              completionHandler: ^(openCloseMetrics output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.MetricsApi()
var start = start_example; // {{String}} The start time as an RFC3339 timestamp
var end = end_example; // {{String}} The end time as an RFC3339 timestamp

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMetricsCases(start, end, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMetricsCasesExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new MetricsApi();
            var start = start_example;  // String | The start time as an RFC3339 timestamp
            var end = end_example;  // String | The end time as an RFC3339 timestamp

            try
            {
                openCloseMetrics result = apiInstance.getMetricsCases(start, end);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MetricsApi.getMetricsCases: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiMetricsApi();
$start = start_example; // String | The start time as an RFC3339 timestamp
$end = end_example; // String | The end time as an RFC3339 timestamp

try {
    $result = $api_instance->getMetricsCases($start, $end);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MetricsApi->getMetricsCases: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MetricsApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::MetricsApi->new();
my $start = start_example; # String | The start time as an RFC3339 timestamp
my $end = end_example; # String | The end time as an RFC3339 timestamp

eval { 
    my $result = $api_instance->getMetricsCases(start => $start, end => $end);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MetricsApi->getMetricsCases: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.MetricsApi()
start = start_example # String | The start time as an RFC3339 timestamp
end = end_example # String | The end time as an RFC3339 timestamp

try: 
    api_response = api_instance.get_metrics_cases(start, end)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MetricsApi->getMetricsCases: %s\n" % e)

Parameters

Query parameters
Name Description
start*
String
The start time as an RFC3339 timestamp
Required
end*
String
The end time as an RFC3339 timestamp
Required

Responses

Status: 200 - A JSON-formatted report.

Status: default - Internal Server Error


getMetricsStatus

Gets a metrics report on case status timing.


/metrics/status

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/metrics/status?startPeriod=&endPeriod=&orgs="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.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: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        MetricsApi apiInstance = new MetricsApi();
        String startPeriod = startPeriod_example; // String | The start time as an RFC3339 timestamp
        String endPeriod = endPeriod_example; // String | The end time as an RFC3339 timestamp
        array[String] orgs = ; // array[String] | filter to which have these organisations
        try {
            metrics result = apiInstance.getMetricsStatus(startPeriod, endPeriod, orgs);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MetricsApi#getMetricsStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MetricsApi;

public class MetricsApiExample {

    public static void main(String[] args) {
        MetricsApi apiInstance = new MetricsApi();
        String startPeriod = startPeriod_example; // String | The start time as an RFC3339 timestamp
        String endPeriod = endPeriod_example; // String | The end time as an RFC3339 timestamp
        array[String] orgs = ; // array[String] | filter to which have these organisations
        try {
            metrics result = apiInstance.getMetricsStatus(startPeriod, endPeriod, orgs);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MetricsApi#getMetricsStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *startPeriod = startPeriod_example; // The start time as an RFC3339 timestamp
String *endPeriod = endPeriod_example; // The end time as an RFC3339 timestamp
array[String] *orgs = ; // filter to which have these organisations

MetricsApi *apiInstance = [[MetricsApi alloc] init];

// Gets a metrics report on case status timing.
[apiInstance getMetricsStatusWith:startPeriod
    endPeriod:endPeriod
    orgs:orgs
              completionHandler: ^(metrics output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.MetricsApi()
var startPeriod = startPeriod_example; // {{String}} The start time as an RFC3339 timestamp
var endPeriod = endPeriod_example; // {{String}} The end time as an RFC3339 timestamp
var orgs = ; // {{array[String]}} filter to which have these organisations

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMetricsStatus(startPeriod, endPeriod, orgs, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMetricsStatusExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new MetricsApi();
            var startPeriod = startPeriod_example;  // String | The start time as an RFC3339 timestamp
            var endPeriod = endPeriod_example;  // String | The end time as an RFC3339 timestamp
            var orgs = new array[String](); // array[String] | filter to which have these organisations

            try
            {
                // Gets a metrics report on case status timing.
                metrics result = apiInstance.getMetricsStatus(startPeriod, endPeriod, orgs);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MetricsApi.getMetricsStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiMetricsApi();
$startPeriod = startPeriod_example; // String | The start time as an RFC3339 timestamp
$endPeriod = endPeriod_example; // String | The end time as an RFC3339 timestamp
$orgs = ; // array[String] | filter to which have these organisations

try {
    $result = $api_instance->getMetricsStatus($startPeriod, $endPeriod, $orgs);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MetricsApi->getMetricsStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MetricsApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::MetricsApi->new();
my $startPeriod = startPeriod_example; # String | The start time as an RFC3339 timestamp
my $endPeriod = endPeriod_example; # String | The end time as an RFC3339 timestamp
my $orgs = []; # array[String] | filter to which have these organisations

eval { 
    my $result = $api_instance->getMetricsStatus(startPeriod => $startPeriod, endPeriod => $endPeriod, orgs => $orgs);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MetricsApi->getMetricsStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.MetricsApi()
startPeriod = startPeriod_example # String | The start time as an RFC3339 timestamp
endPeriod = endPeriod_example # String | The end time as an RFC3339 timestamp
orgs =  # array[String] | filter to which have these organisations

try: 
    # Gets a metrics report on case status timing.
    api_response = api_instance.get_metrics_status(startPeriod, endPeriod, orgs)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MetricsApi->getMetricsStatus: %s\n" % e)

Parameters

Query parameters
Name Description
startPeriod*
String
The start time as an RFC3339 timestamp
Required
endPeriod*
String
The end time as an RFC3339 timestamp
Required
orgs*
array[String]
filter to which have these organisations
Required

Responses

Status: 200 - A JSON-formatted report.

Status: default - Internal Server Error


getMetricsUsers

Gets a metrics report on users. (This endpoint is currently disabled)


/metrics/users

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/metrics/users"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.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: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        MetricsApi apiInstance = new MetricsApi();
        MetricsRequest body = ; // MetricsRequest | 
        try {
            metrics result = apiInstance.getMetricsUsers(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MetricsApi#getMetricsUsers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MetricsApi;

public class MetricsApiExample {

    public static void main(String[] args) {
        MetricsApi apiInstance = new MetricsApi();
        MetricsRequest body = ; // MetricsRequest | 
        try {
            metrics result = apiInstance.getMetricsUsers(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MetricsApi#getMetricsUsers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
MetricsRequest *body = ; // 

MetricsApi *apiInstance = [[MetricsApi alloc] init];

[apiInstance getMetricsUsersWith:body
              completionHandler: ^(metrics output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.MetricsApi()
var body = ; // {{MetricsRequest}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMetricsUsers(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMetricsUsersExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new MetricsApi();
            var body = new MetricsRequest(); // MetricsRequest | 

            try
            {
                metrics result = apiInstance.getMetricsUsers(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MetricsApi.getMetricsUsers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiMetricsApi();
$body = ; // MetricsRequest | 

try {
    $result = $api_instance->getMetricsUsers($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MetricsApi->getMetricsUsers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MetricsApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::MetricsApi->new();
my $body = WWW::SwaggerClient::Object::MetricsRequest->new(); # MetricsRequest | 

eval { 
    my $result = $api_instance->getMetricsUsers(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MetricsApi->getMetricsUsers: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.MetricsApi()
body =  # MetricsRequest | 

try: 
    api_response = api_instance.get_metrics_users(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MetricsApi->getMetricsUsers: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - A JSON-formatted report.

Status: default - Internal Server Error


getOpenCloseCases

Gets a metrics report on cases opened versus closed.


/metrics/openclose

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/metrics/openclose?startPeriod=&endPeriod=&orgs="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.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: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        MetricsApi apiInstance = new MetricsApi();
        String startPeriod = startPeriod_example; // String | The start time as an RFC3339 timestamp
        String endPeriod = endPeriod_example; // String | The end time as an RFC3339 timestamp
        String orgs = orgs_example; // String | The org to filter with
        try {
            openCloseMetrics result = apiInstance.getOpenCloseCases(startPeriod, endPeriod, orgs);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MetricsApi#getOpenCloseCases");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MetricsApi;

public class MetricsApiExample {

    public static void main(String[] args) {
        MetricsApi apiInstance = new MetricsApi();
        String startPeriod = startPeriod_example; // String | The start time as an RFC3339 timestamp
        String endPeriod = endPeriod_example; // String | The end time as an RFC3339 timestamp
        String orgs = orgs_example; // String | The org to filter with
        try {
            openCloseMetrics result = apiInstance.getOpenCloseCases(startPeriod, endPeriod, orgs);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MetricsApi#getOpenCloseCases");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *startPeriod = startPeriod_example; // The start time as an RFC3339 timestamp
String *endPeriod = endPeriod_example; // The end time as an RFC3339 timestamp
String *orgs = orgs_example; // The org to filter with (optional)

MetricsApi *apiInstance = [[MetricsApi alloc] init];

// Gets a metrics report on cases opened versus closed.
[apiInstance getOpenCloseCasesWith:startPeriod
    endPeriod:endPeriod
    orgs:orgs
              completionHandler: ^(openCloseMetrics output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.MetricsApi()
var startPeriod = startPeriod_example; // {{String}} The start time as an RFC3339 timestamp
var endPeriod = endPeriod_example; // {{String}} The end time as an RFC3339 timestamp
var opts = { 
  'orgs': orgs_example // {{String}} The org to filter with
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOpenCloseCases(startPeriod, endPeriod, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getOpenCloseCasesExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new MetricsApi();
            var startPeriod = startPeriod_example;  // String | The start time as an RFC3339 timestamp
            var endPeriod = endPeriod_example;  // String | The end time as an RFC3339 timestamp
            var orgs = orgs_example;  // String | The org to filter with (optional) 

            try
            {
                // Gets a metrics report on cases opened versus closed.
                openCloseMetrics result = apiInstance.getOpenCloseCases(startPeriod, endPeriod, orgs);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MetricsApi.getOpenCloseCases: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiMetricsApi();
$startPeriod = startPeriod_example; // String | The start time as an RFC3339 timestamp
$endPeriod = endPeriod_example; // String | The end time as an RFC3339 timestamp
$orgs = orgs_example; // String | The org to filter with

try {
    $result = $api_instance->getOpenCloseCases($startPeriod, $endPeriod, $orgs);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MetricsApi->getOpenCloseCases: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MetricsApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::MetricsApi->new();
my $startPeriod = startPeriod_example; # String | The start time as an RFC3339 timestamp
my $endPeriod = endPeriod_example; # String | The end time as an RFC3339 timestamp
my $orgs = orgs_example; # String | The org to filter with

eval { 
    my $result = $api_instance->getOpenCloseCases(startPeriod => $startPeriod, endPeriod => $endPeriod, orgs => $orgs);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MetricsApi->getOpenCloseCases: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.MetricsApi()
startPeriod = startPeriod_example # String | The start time as an RFC3339 timestamp
endPeriod = endPeriod_example # String | The end time as an RFC3339 timestamp
orgs = orgs_example # String | The org to filter with (optional)

try: 
    # Gets a metrics report on cases opened versus closed.
    api_response = api_instance.get_open_close_cases(startPeriod, endPeriod, orgs=orgs)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MetricsApi->getOpenCloseCases: %s\n" % e)

Parameters

Query parameters
Name Description
startPeriod*
String
The start time as an RFC3339 timestamp
Required
endPeriod*
String
The end time as an RFC3339 timestamp
Required
orgs
String
The org to filter with

Responses

Status: 200 - A JSON-formatted report.

Status: default - Internal Server Error


Notify

deleteErrorMessage

Deletes the error msg for the specified consumer


/notify/{service}/error/{msgUuid}

Usage and SDK Samples

curl -X DELETE\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/notify/{service}/error/{msgUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NotifyApi;

import java.io.File;
import java.util.*;

public class NotifyApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        NotifyApi apiInstance = new NotifyApi();
        String service = service_example; // String | The name of the consumer
        UUID msgUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The UUID of the error msg to be deleted
        try {
            apiInstance.deleteErrorMessage(service, msgUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotifyApi#deleteErrorMessage");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NotifyApi;

public class NotifyApiExample {

    public static void main(String[] args) {
        NotifyApi apiInstance = new NotifyApi();
        String service = service_example; // String | The name of the consumer
        UUID msgUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The UUID of the error msg to be deleted
        try {
            apiInstance.deleteErrorMessage(service, msgUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotifyApi#deleteErrorMessage");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *service = service_example; // The name of the consumer
UUID *msgUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The UUID of the error msg to be deleted

NotifyApi *apiInstance = [[NotifyApi alloc] init];

[apiInstance deleteErrorMessageWith:service
    msgUuid:msgUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.NotifyApi()
var service = service_example; // {{String}} The name of the consumer
var msgUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} The UUID of the error msg to be deleted

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteErrorMessage(service, msgUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteErrorMessageExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new NotifyApi();
            var service = service_example;  // String | The name of the consumer
            var msgUuid = new UUID(); // UUID | The UUID of the error msg to be deleted

            try
            {
                apiInstance.deleteErrorMessage(service, msgUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NotifyApi.deleteErrorMessage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiNotifyApi();
$service = service_example; // String | The name of the consumer
$msgUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The UUID of the error msg to be deleted

try {
    $api_instance->deleteErrorMessage($service, $msgUuid);
} catch (Exception $e) {
    echo 'Exception when calling NotifyApi->deleteErrorMessage: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NotifyApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::NotifyApi->new();
my $service = service_example; # String | The name of the consumer
my $msgUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The UUID of the error msg to be deleted

eval { 
    $api_instance->deleteErrorMessage(service => $service, msgUuid => $msgUuid);
};
if ($@) {
    warn "Exception when calling NotifyApi->deleteErrorMessage: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.NotifyApi()
service = service_example # String | The name of the consumer
msgUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The UUID of the error msg to be deleted

try: 
    api_instance.delete_error_message(service, msgUuid)
except ApiException as e:
    print("Exception when calling NotifyApi->deleteErrorMessage: %s\n" % e)

Parameters

Path parameters
Name Description
service*
String
The name of the consumer
Required
msgUuid*
UUID (uuid)
The UUID of the error msg to be deleted
Required

Responses

Status: 204 - Notification deleted.

Status: default - Internal Server Error


deleteMessage

Deletes the msg for the specified consumer


/notify/{service}/input/{msgUuid}

Usage and SDK Samples

curl -X DELETE\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/notify/{service}/input/{msgUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NotifyApi;

import java.io.File;
import java.util.*;

public class NotifyApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        NotifyApi apiInstance = new NotifyApi();
        String service = service_example; // String | The name of the consumer
        UUID msgUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The UUID of the msg to be deleted
        try {
            apiInstance.deleteMessage(service, msgUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotifyApi#deleteMessage");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NotifyApi;

public class NotifyApiExample {

    public static void main(String[] args) {
        NotifyApi apiInstance = new NotifyApi();
        String service = service_example; // String | The name of the consumer
        UUID msgUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The UUID of the msg to be deleted
        try {
            apiInstance.deleteMessage(service, msgUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotifyApi#deleteMessage");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *service = service_example; // The name of the consumer
UUID *msgUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The UUID of the msg to be deleted

NotifyApi *apiInstance = [[NotifyApi alloc] init];

[apiInstance deleteMessageWith:service
    msgUuid:msgUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.NotifyApi()
var service = service_example; // {{String}} The name of the consumer
var msgUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} The UUID of the msg to be deleted

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteMessage(service, msgUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteMessageExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new NotifyApi();
            var service = service_example;  // String | The name of the consumer
            var msgUuid = new UUID(); // UUID | The UUID of the msg to be deleted

            try
            {
                apiInstance.deleteMessage(service, msgUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NotifyApi.deleteMessage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiNotifyApi();
$service = service_example; // String | The name of the consumer
$msgUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The UUID of the msg to be deleted

try {
    $api_instance->deleteMessage($service, $msgUuid);
} catch (Exception $e) {
    echo 'Exception when calling NotifyApi->deleteMessage: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NotifyApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::NotifyApi->new();
my $service = service_example; # String | The name of the consumer
my $msgUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The UUID of the msg to be deleted

eval { 
    $api_instance->deleteMessage(service => $service, msgUuid => $msgUuid);
};
if ($@) {
    warn "Exception when calling NotifyApi->deleteMessage: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.NotifyApi()
service = service_example # String | The name of the consumer
msgUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The UUID of the msg to be deleted

try: 
    api_instance.delete_message(service, msgUuid)
except ApiException as e:
    print("Exception when calling NotifyApi->deleteMessage: %s\n" % e)

Parameters

Path parameters
Name Description
service*
String
The name of the consumer
Required
msgUuid*
UUID (uuid)
The UUID of the msg to be deleted
Required

Responses

Status: 204 - Notification deleted.

Status: default - Internal Server Error


getErrorMessages

Gets all error messages for the supplied consumer


/notify/{service}/error

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/notify/{service}/error"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NotifyApi;

import java.io.File;
import java.util.*;

public class NotifyApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        NotifyApi apiInstance = new NotifyApi();
        String service = service_example; // String | The name of the consumer
        try {
            array[pubsubErrorMessage] result = apiInstance.getErrorMessages(service);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotifyApi#getErrorMessages");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NotifyApi;

public class NotifyApiExample {

    public static void main(String[] args) {
        NotifyApi apiInstance = new NotifyApi();
        String service = service_example; // String | The name of the consumer
        try {
            array[pubsubErrorMessage] result = apiInstance.getErrorMessages(service);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotifyApi#getErrorMessages");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *service = service_example; // The name of the consumer

NotifyApi *apiInstance = [[NotifyApi alloc] init];

[apiInstance getErrorMessagesWith:service
              completionHandler: ^(array[pubsubErrorMessage] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.NotifyApi()
var service = service_example; // {{String}} The name of the consumer

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getErrorMessages(service, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getErrorMessagesExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new NotifyApi();
            var service = service_example;  // String | The name of the consumer

            try
            {
                array[pubsubErrorMessage] result = apiInstance.getErrorMessages(service);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NotifyApi.getErrorMessages: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiNotifyApi();
$service = service_example; // String | The name of the consumer

try {
    $result = $api_instance->getErrorMessages($service);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NotifyApi->getErrorMessages: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NotifyApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::NotifyApi->new();
my $service = service_example; # String | The name of the consumer

eval { 
    my $result = $api_instance->getErrorMessages(service => $service);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NotifyApi->getErrorMessages: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.NotifyApi()
service = service_example # String | The name of the consumer

try: 
    api_response = api_instance.get_error_messages(service)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NotifyApi->getErrorMessages: %s\n" % e)

Parameters

Path parameters
Name Description
service*
String
The name of the consumer
Required

Responses

Status: 200 - The messages have been retrieved and returned.

Status: default - Internal Server Error


getMessages

Gets all messages for the supplied consumer


/notify/{service}/input

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/notify/{service}/input"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NotifyApi;

import java.io.File;
import java.util.*;

public class NotifyApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        NotifyApi apiInstance = new NotifyApi();
        String service = service_example; // String | The name of the consumer
        try {
            array[pubsubMessage] result = apiInstance.getMessages(service);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotifyApi#getMessages");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NotifyApi;

public class NotifyApiExample {

    public static void main(String[] args) {
        NotifyApi apiInstance = new NotifyApi();
        String service = service_example; // String | The name of the consumer
        try {
            array[pubsubMessage] result = apiInstance.getMessages(service);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotifyApi#getMessages");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *service = service_example; // The name of the consumer

NotifyApi *apiInstance = [[NotifyApi alloc] init];

[apiInstance getMessagesWith:service
              completionHandler: ^(array[pubsubMessage] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.NotifyApi()
var service = service_example; // {{String}} The name of the consumer

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMessages(service, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMessagesExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new NotifyApi();
            var service = service_example;  // String | The name of the consumer

            try
            {
                array[pubsubMessage] result = apiInstance.getMessages(service);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NotifyApi.getMessages: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiNotifyApi();
$service = service_example; // String | The name of the consumer

try {
    $result = $api_instance->getMessages($service);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NotifyApi->getMessages: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NotifyApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::NotifyApi->new();
my $service = service_example; # String | The name of the consumer

eval { 
    my $result = $api_instance->getMessages(service => $service);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NotifyApi->getMessages: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.NotifyApi()
service = service_example # String | The name of the consumer

try: 
    api_response = api_instance.get_messages(service)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NotifyApi->getMessages: %s\n" % e)

Parameters

Path parameters
Name Description
service*
String
The name of the consumer
Required

Responses

Status: 200 - The messages have been retrieved and returned.

Status: default - Internal Server Error


notifyService

Sends a notification to a third-party service.


/notify/{service}

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/notify/{service}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NotifyApi;

import java.io.File;
import java.util.*;

public class NotifyApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        NotifyApi apiInstance = new NotifyApi();
        String service = service_example; // String | The name of the service to notify of payload.
        try {
            apiInstance.notifyService(service);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotifyApi#notifyService");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NotifyApi;

public class NotifyApiExample {

    public static void main(String[] args) {
        NotifyApi apiInstance = new NotifyApi();
        String service = service_example; // String | The name of the service to notify of payload.
        try {
            apiInstance.notifyService(service);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotifyApi#notifyService");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *service = service_example; // The name of the service to notify of payload.

NotifyApi *apiInstance = [[NotifyApi alloc] init];

// Sends a notification to a third-party service.
[apiInstance notifyServiceWith:service
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.NotifyApi()
var service = service_example; // {{String}} The name of the service to notify of payload.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.notifyService(service, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class notifyServiceExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new NotifyApi();
            var service = service_example;  // String | The name of the service to notify of payload.

            try
            {
                // Sends a notification to a third-party service.
                apiInstance.notifyService(service);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NotifyApi.notifyService: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiNotifyApi();
$service = service_example; // String | The name of the service to notify of payload.

try {
    $api_instance->notifyService($service);
} catch (Exception $e) {
    echo 'Exception when calling NotifyApi->notifyService: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NotifyApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::NotifyApi->new();
my $service = service_example; # String | The name of the service to notify of payload.

eval { 
    $api_instance->notifyService(service => $service);
};
if ($@) {
    warn "Exception when calling NotifyApi->notifyService: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.NotifyApi()
service = service_example # String | The name of the service to notify of payload.

try: 
    # Sends a notification to a third-party service.
    api_instance.notify_service(service)
except ApiException as e:
    print("Exception when calling NotifyApi->notifyService: %s\n" % e)

Parameters

Path parameters
Name Description
service*
String
The name of the service to notify of payload.
Required

Responses

Status: 204 - Notification sent.

Status: default - Internal Server Error


postErrorMessage

Posts an error message for the specified consumer


/notify/{service}/error

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/notify/{service}/error"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NotifyApi;

import java.io.File;
import java.util.*;

public class NotifyApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        NotifyApi apiInstance = new NotifyApi();
        String service = service_example; // String | The name of the service which has reported an error
        try {
            apiInstance.postErrorMessage(service);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotifyApi#postErrorMessage");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NotifyApi;

public class NotifyApiExample {

    public static void main(String[] args) {
        NotifyApi apiInstance = new NotifyApi();
        String service = service_example; // String | The name of the service which has reported an error
        try {
            apiInstance.postErrorMessage(service);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotifyApi#postErrorMessage");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *service = service_example; // The name of the service which has reported an error

NotifyApi *apiInstance = [[NotifyApi alloc] init];

[apiInstance postErrorMessageWith:service
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.NotifyApi()
var service = service_example; // {{String}} The name of the service which has reported an error

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.postErrorMessage(service, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class postErrorMessageExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new NotifyApi();
            var service = service_example;  // String | The name of the service which has reported an error

            try
            {
                apiInstance.postErrorMessage(service);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NotifyApi.postErrorMessage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiNotifyApi();
$service = service_example; // String | The name of the service which has reported an error

try {
    $api_instance->postErrorMessage($service);
} catch (Exception $e) {
    echo 'Exception when calling NotifyApi->postErrorMessage: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NotifyApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::NotifyApi->new();
my $service = service_example; # String | The name of the service which has reported an error

eval { 
    $api_instance->postErrorMessage(service => $service);
};
if ($@) {
    warn "Exception when calling NotifyApi->postErrorMessage: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.NotifyApi()
service = service_example # String | The name of the service which has reported an error

try: 
    api_instance.post_error_message(service)
except ApiException as e:
    print("Exception when calling NotifyApi->postErrorMessage: %s\n" % e)

Parameters

Path parameters
Name Description
service*
String
The name of the service which has reported an error
Required

Responses

Status: 204 - Notification stored.

Status: default - Internal Server Error


Org

createOrg

Creates an org.


/org

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/org"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OrgApi;

import java.io.File;
import java.util.*;

public class OrgApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        OrgApi apiInstance = new OrgApi();
        Org body = ; // Org | The org to create.
        try {
            createResponse result = apiInstance.createOrg(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrgApi#createOrg");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.OrgApi;

public class OrgApiExample {

    public static void main(String[] args) {
        OrgApi apiInstance = new OrgApi();
        Org body = ; // Org | The org to create.
        try {
            createResponse result = apiInstance.createOrg(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrgApi#createOrg");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
Org *body = ; // The org to create.

OrgApi *apiInstance = [[OrgApi alloc] init];

// Creates an org.
[apiInstance createOrgWith:body
              completionHandler: ^(createResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.OrgApi()
var body = ; // {{Org}} The org to create.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createOrg(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createOrgExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new OrgApi();
            var body = new Org(); // Org | The org to create.

            try
            {
                // Creates an org.
                createResponse result = apiInstance.createOrg(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrgApi.createOrg: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiOrgApi();
$body = ; // Org | The org to create.

try {
    $result = $api_instance->createOrg($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrgApi->createOrg: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OrgApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::OrgApi->new();
my $body = WWW::SwaggerClient::Object::Org->new(); # Org | The org to create.

eval { 
    my $result = $api_instance->createOrg(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrgApi->createOrg: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.OrgApi()
body =  # Org | The org to create.

try: 
    # Creates an org.
    api_response = api_instance.create_org(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrgApi->createOrg: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - The org has been created successfully.

Status: default - Internal Server Error


deleteOrg

Deletes an org.


/org/{orgUuid}

Usage and SDK Samples

curl -X DELETE\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/org/{orgUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OrgApi;

import java.io.File;
import java.util.*;

public class OrgApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        OrgApi apiInstance = new OrgApi();
        String orgUuid = orgUuid_example; // String | The org to delete.
        try {
            apiInstance.deleteOrg(orgUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrgApi#deleteOrg");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.OrgApi;

public class OrgApiExample {

    public static void main(String[] args) {
        OrgApi apiInstance = new OrgApi();
        String orgUuid = orgUuid_example; // String | The org to delete.
        try {
            apiInstance.deleteOrg(orgUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrgApi#deleteOrg");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *orgUuid = orgUuid_example; // The org to delete.

OrgApi *apiInstance = [[OrgApi alloc] init];

// Deletes an org.
[apiInstance deleteOrgWith:orgUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.OrgApi()
var orgUuid = orgUuid_example; // {{String}} The org to delete.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteOrg(orgUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteOrgExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new OrgApi();
            var orgUuid = orgUuid_example;  // String | The org to delete.

            try
            {
                // Deletes an org.
                apiInstance.deleteOrg(orgUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrgApi.deleteOrg: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiOrgApi();
$orgUuid = orgUuid_example; // String | The org to delete.

try {
    $api_instance->deleteOrg($orgUuid);
} catch (Exception $e) {
    echo 'Exception when calling OrgApi->deleteOrg: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OrgApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::OrgApi->new();
my $orgUuid = orgUuid_example; # String | The org to delete.

eval { 
    $api_instance->deleteOrg(orgUuid => $orgUuid);
};
if ($@) {
    warn "Exception when calling OrgApi->deleteOrg: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.OrgApi()
orgUuid = orgUuid_example # String | The org to delete.

try: 
    # Deletes an org.
    api_instance.delete_org(orgUuid)
except ApiException as e:
    print("Exception when calling OrgApi->deleteOrg: %s\n" % e)

Parameters

Path parameters
Name Description
orgUuid*
String
The org to delete.
Required

Responses

Status: 204 - The org has been deleted successfully.

Status: default - Internal Server Error


getOrg

Gets an org.


/org/{orgUuid}

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/org/{orgUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OrgApi;

import java.io.File;
import java.util.*;

public class OrgApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        OrgApi apiInstance = new OrgApi();
        String orgUuid = orgUuid_example; // String | The UUID of the org to retrieve.
        try {
            org result = apiInstance.getOrg(orgUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrgApi#getOrg");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.OrgApi;

public class OrgApiExample {

    public static void main(String[] args) {
        OrgApi apiInstance = new OrgApi();
        String orgUuid = orgUuid_example; // String | The UUID of the org to retrieve.
        try {
            org result = apiInstance.getOrg(orgUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrgApi#getOrg");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *orgUuid = orgUuid_example; // The UUID of the org to retrieve.

OrgApi *apiInstance = [[OrgApi alloc] init];

// Gets an org.
[apiInstance getOrgWith:orgUuid
              completionHandler: ^(org output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.OrgApi()
var orgUuid = orgUuid_example; // {{String}} The UUID of the org to retrieve.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrg(orgUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getOrgExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new OrgApi();
            var orgUuid = orgUuid_example;  // String | The UUID of the org to retrieve.

            try
            {
                // Gets an org.
                org result = apiInstance.getOrg(orgUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrgApi.getOrg: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiOrgApi();
$orgUuid = orgUuid_example; // String | The UUID of the org to retrieve.

try {
    $result = $api_instance->getOrg($orgUuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrgApi->getOrg: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OrgApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::OrgApi->new();
my $orgUuid = orgUuid_example; # String | The UUID of the org to retrieve.

eval { 
    my $result = $api_instance->getOrg(orgUuid => $orgUuid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrgApi->getOrg: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.OrgApi()
orgUuid = orgUuid_example # String | The UUID of the org to retrieve.

try: 
    # Gets an org.
    api_response = api_instance.get_org(orgUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrgApi->getOrg: %s\n" % e)

Parameters

Path parameters
Name Description
orgUuid*
String
The UUID of the org to retrieve.
Required

Responses

Status: 200 - Fetched the org and transmitted in the message body.

Status: default - Internal Server Error


getOrgs

Gets a list of orgs.


/org

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/org"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OrgApi;

import java.io.File;
import java.util.*;

public class OrgApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        OrgApi apiInstance = new OrgApi();
        try {
            array[org] result = apiInstance.getOrgs();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrgApi#getOrgs");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.OrgApi;

public class OrgApiExample {

    public static void main(String[] args) {
        OrgApi apiInstance = new OrgApi();
        try {
            array[org] result = apiInstance.getOrgs();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrgApi#getOrgs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];

OrgApi *apiInstance = [[OrgApi alloc] init];

// Gets a list of orgs.
[apiInstance getOrgsWithCompletionHandler: 
              ^(array[org] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.OrgApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrgs(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getOrgsExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new OrgApi();

            try
            {
                // Gets a list of orgs.
                array[org] result = apiInstance.getOrgs();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrgApi.getOrgs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiOrgApi();

try {
    $result = $api_instance->getOrgs();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrgApi->getOrgs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OrgApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::OrgApi->new();

eval { 
    my $result = $api_instance->getOrgs();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrgApi->getOrgs: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.OrgApi()

try: 
    # Gets a list of orgs.
    api_response = api_instance.get_orgs()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrgApi->getOrgs: %s\n" % e)

Parameters

Responses

Status: 200 - A list of orgs has been fetched and is transmitted in the message body.

Status: default - Internal Server Error


updateOrg

Updates an org.


/org/{orgUuid}

Usage and SDK Samples

curl -X PUT\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/org/{orgUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OrgApi;

import java.io.File;
import java.util.*;

public class OrgApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        OrgApi apiInstance = new OrgApi();
        Org body = ; // Org | The org body to update with.
        String orgUuid = orgUuid_example; // String | The UUID of the org to update.
        try {
            apiInstance.updateOrg(body, orgUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrgApi#updateOrg");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.OrgApi;

public class OrgApiExample {

    public static void main(String[] args) {
        OrgApi apiInstance = new OrgApi();
        Org body = ; // Org | The org body to update with.
        String orgUuid = orgUuid_example; // String | The UUID of the org to update.
        try {
            apiInstance.updateOrg(body, orgUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrgApi#updateOrg");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
Org *body = ; // The org body to update with.
String *orgUuid = orgUuid_example; // The UUID of the org to update.

OrgApi *apiInstance = [[OrgApi alloc] init];

// Updates an org.
[apiInstance updateOrgWith:body
    orgUuid:orgUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.OrgApi()
var body = ; // {{Org}} The org body to update with.
var orgUuid = orgUuid_example; // {{String}} The UUID of the org to update.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateOrg(bodyorgUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateOrgExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new OrgApi();
            var body = new Org(); // Org | The org body to update with.
            var orgUuid = orgUuid_example;  // String | The UUID of the org to update.

            try
            {
                // Updates an org.
                apiInstance.updateOrg(body, orgUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrgApi.updateOrg: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiOrgApi();
$body = ; // Org | The org body to update with.
$orgUuid = orgUuid_example; // String | The UUID of the org to update.

try {
    $api_instance->updateOrg($body, $orgUuid);
} catch (Exception $e) {
    echo 'Exception when calling OrgApi->updateOrg: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OrgApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::OrgApi->new();
my $body = WWW::SwaggerClient::Object::Org->new(); # Org | The org body to update with.
my $orgUuid = orgUuid_example; # String | The UUID of the org to update.

eval { 
    $api_instance->updateOrg(body => $body, orgUuid => $orgUuid);
};
if ($@) {
    warn "Exception when calling OrgApi->updateOrg: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.OrgApi()
body =  # Org | The org body to update with.
orgUuid = orgUuid_example # String | The UUID of the org to update.

try: 
    # Updates an org.
    api_instance.update_org(body, orgUuid)
except ApiException as e:
    print("Exception when calling OrgApi->updateOrg: %s\n" % e)

Parameters

Path parameters
Name Description
orgUuid*
String
The UUID of the org to update.
Required
Body parameters
Name Description
body *

Responses

Status: 200 - The org has been updated successfully.

Status: default - Internal Server Error


OrgProp

createOrgProp

Creates an org property,


/org-prop/{orgUuid}/{propName}

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/org-prop/{orgUuid}/{propName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OrgPropApi;

import java.io.File;
import java.util.*;

public class OrgPropApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        OrgPropApi apiInstance = new OrgPropApi();
        PropRequest body = ; // PropRequest | The org property to create.
        String orgUuid = orgUuid_example; // String | The UUID of the org whose property is being created.
        String propName = propName_example; // String | The name of the property to create.
        try {
            createResponse result = apiInstance.createOrgProp(body, orgUuid, propName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrgPropApi#createOrgProp");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.OrgPropApi;

public class OrgPropApiExample {

    public static void main(String[] args) {
        OrgPropApi apiInstance = new OrgPropApi();
        PropRequest body = ; // PropRequest | The org property to create.
        String orgUuid = orgUuid_example; // String | The UUID of the org whose property is being created.
        String propName = propName_example; // String | The name of the property to create.
        try {
            createResponse result = apiInstance.createOrgProp(body, orgUuid, propName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrgPropApi#createOrgProp");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
PropRequest *body = ; // The org property to create.
String *orgUuid = orgUuid_example; // The UUID of the org whose property is being created.
String *propName = propName_example; // The name of the property to create.

OrgPropApi *apiInstance = [[OrgPropApi alloc] init];

// Creates an org property,
[apiInstance createOrgPropWith:body
    orgUuid:orgUuid
    propName:propName
              completionHandler: ^(createResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.OrgPropApi()
var body = ; // {{PropRequest}} The org property to create.
var orgUuid = orgUuid_example; // {{String}} The UUID of the org whose property is being created.
var propName = propName_example; // {{String}} The name of the property to create.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createOrgProp(bodyorgUuidpropName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createOrgPropExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new OrgPropApi();
            var body = new PropRequest(); // PropRequest | The org property to create.
            var orgUuid = orgUuid_example;  // String | The UUID of the org whose property is being created.
            var propName = propName_example;  // String | The name of the property to create.

            try
            {
                // Creates an org property,
                createResponse result = apiInstance.createOrgProp(body, orgUuid, propName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrgPropApi.createOrgProp: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiOrgPropApi();
$body = ; // PropRequest | The org property to create.
$orgUuid = orgUuid_example; // String | The UUID of the org whose property is being created.
$propName = propName_example; // String | The name of the property to create.

try {
    $result = $api_instance->createOrgProp($body, $orgUuid, $propName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrgPropApi->createOrgProp: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OrgPropApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::OrgPropApi->new();
my $body = WWW::SwaggerClient::Object::PropRequest->new(); # PropRequest | The org property to create.
my $orgUuid = orgUuid_example; # String | The UUID of the org whose property is being created.
my $propName = propName_example; # String | The name of the property to create.

eval { 
    my $result = $api_instance->createOrgProp(body => $body, orgUuid => $orgUuid, propName => $propName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrgPropApi->createOrgProp: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.OrgPropApi()
body =  # PropRequest | The org property to create.
orgUuid = orgUuid_example # String | The UUID of the org whose property is being created.
propName = propName_example # String | The name of the property to create.

try: 
    # Creates an org property,
    api_response = api_instance.create_org_prop(body, orgUuid, propName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrgPropApi->createOrgProp: %s\n" % e)

Parameters

Path parameters
Name Description
orgUuid*
String
The UUID of the org whose property is being created.
Required
propName*
String
The name of the property to create.
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Org property has been successfully created.

Status: 401 - Invalid authentication for this request.

Status: 403 - The request is forbidden.

Status: 404 - Could not find the org or insufficient permissions to finds.

Status: default - Internal Server Error


deleteOrgProp

Deletes an org property.


/org-prop/{orgUuid}/{propName}

Usage and SDK Samples

curl -X DELETE\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/org-prop/{orgUuid}/{propName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OrgPropApi;

import java.io.File;
import java.util.*;

public class OrgPropApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        OrgPropApi apiInstance = new OrgPropApi();
        String orgUuid = orgUuid_example; // String | The UUID of the org whose property is being deleted.
        String propName = propName_example; // String | The name of the property to delete.
        try {
            apiInstance.deleteOrgProp(orgUuid, propName);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrgPropApi#deleteOrgProp");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.OrgPropApi;

public class OrgPropApiExample {

    public static void main(String[] args) {
        OrgPropApi apiInstance = new OrgPropApi();
        String orgUuid = orgUuid_example; // String | The UUID of the org whose property is being deleted.
        String propName = propName_example; // String | The name of the property to delete.
        try {
            apiInstance.deleteOrgProp(orgUuid, propName);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrgPropApi#deleteOrgProp");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *orgUuid = orgUuid_example; // The UUID of the org whose property is being deleted.
String *propName = propName_example; // The name of the property to delete.

OrgPropApi *apiInstance = [[OrgPropApi alloc] init];

// Deletes an org property.
[apiInstance deleteOrgPropWith:orgUuid
    propName:propName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.OrgPropApi()
var orgUuid = orgUuid_example; // {{String}} The UUID of the org whose property is being deleted.
var propName = propName_example; // {{String}} The name of the property to delete.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteOrgProp(orgUuid, propName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteOrgPropExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new OrgPropApi();
            var orgUuid = orgUuid_example;  // String | The UUID of the org whose property is being deleted.
            var propName = propName_example;  // String | The name of the property to delete.

            try
            {
                // Deletes an org property.
                apiInstance.deleteOrgProp(orgUuid, propName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrgPropApi.deleteOrgProp: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiOrgPropApi();
$orgUuid = orgUuid_example; // String | The UUID of the org whose property is being deleted.
$propName = propName_example; // String | The name of the property to delete.

try {
    $api_instance->deleteOrgProp($orgUuid, $propName);
} catch (Exception $e) {
    echo 'Exception when calling OrgPropApi->deleteOrgProp: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OrgPropApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::OrgPropApi->new();
my $orgUuid = orgUuid_example; # String | The UUID of the org whose property is being deleted.
my $propName = propName_example; # String | The name of the property to delete.

eval { 
    $api_instance->deleteOrgProp(orgUuid => $orgUuid, propName => $propName);
};
if ($@) {
    warn "Exception when calling OrgPropApi->deleteOrgProp: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.OrgPropApi()
orgUuid = orgUuid_example # String | The UUID of the org whose property is being deleted.
propName = propName_example # String | The name of the property to delete.

try: 
    # Deletes an org property.
    api_instance.delete_org_prop(orgUuid, propName)
except ApiException as e:
    print("Exception when calling OrgPropApi->deleteOrgProp: %s\n" % e)

Parameters

Path parameters
Name Description
orgUuid*
String
The UUID of the org whose property is being deleted.
Required
propName*
String
The name of the property to delete.
Required

Responses

Status: 204 - The resource was deleted successfully.

Status: 401 - Invalid authentication for this request.

Status: 404 - Could not find the org property or insufficient permissions to finds.

Status: default - Internal Server Error


getOrgProp

Gets an org property.


/org-prop/{orgUuid}/{propName}

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/org-prop/{orgUuid}/{propName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OrgPropApi;

import java.io.File;
import java.util.*;

public class OrgPropApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        OrgPropApi apiInstance = new OrgPropApi();
        String orgUuid = orgUuid_example; // String | The UUID of the org whose property is being retrieved.
        String propName = propName_example; // String | The name of the property to retrieve.
        try {
            orgProp result = apiInstance.getOrgProp(orgUuid, propName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrgPropApi#getOrgProp");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.OrgPropApi;

public class OrgPropApiExample {

    public static void main(String[] args) {
        OrgPropApi apiInstance = new OrgPropApi();
        String orgUuid = orgUuid_example; // String | The UUID of the org whose property is being retrieved.
        String propName = propName_example; // String | The name of the property to retrieve.
        try {
            orgProp result = apiInstance.getOrgProp(orgUuid, propName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrgPropApi#getOrgProp");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *orgUuid = orgUuid_example; // The UUID of the org whose property is being retrieved.
String *propName = propName_example; // The name of the property to retrieve.

OrgPropApi *apiInstance = [[OrgPropApi alloc] init];

// Gets an org property.
[apiInstance getOrgPropWith:orgUuid
    propName:propName
              completionHandler: ^(orgProp output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.OrgPropApi()
var orgUuid = orgUuid_example; // {{String}} The UUID of the org whose property is being retrieved.
var propName = propName_example; // {{String}} The name of the property to retrieve.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrgProp(orgUuid, propName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getOrgPropExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new OrgPropApi();
            var orgUuid = orgUuid_example;  // String | The UUID of the org whose property is being retrieved.
            var propName = propName_example;  // String | The name of the property to retrieve.

            try
            {
                // Gets an org property.
                orgProp result = apiInstance.getOrgProp(orgUuid, propName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrgPropApi.getOrgProp: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiOrgPropApi();
$orgUuid = orgUuid_example; // String | The UUID of the org whose property is being retrieved.
$propName = propName_example; // String | The name of the property to retrieve.

try {
    $result = $api_instance->getOrgProp($orgUuid, $propName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrgPropApi->getOrgProp: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OrgPropApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::OrgPropApi->new();
my $orgUuid = orgUuid_example; # String | The UUID of the org whose property is being retrieved.
my $propName = propName_example; # String | The name of the property to retrieve.

eval { 
    my $result = $api_instance->getOrgProp(orgUuid => $orgUuid, propName => $propName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrgPropApi->getOrgProp: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.OrgPropApi()
orgUuid = orgUuid_example # String | The UUID of the org whose property is being retrieved.
propName = propName_example # String | The name of the property to retrieve.

try: 
    # Gets an org property.
    api_response = api_instance.get_org_prop(orgUuid, propName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrgPropApi->getOrgProp: %s\n" % e)

Parameters

Path parameters
Name Description
orgUuid*
String
The UUID of the org whose property is being retrieved.
Required
propName*
String
The name of the property to retrieve.
Required

Responses

Status: 200 - Fetched the org property and transmitted in the message body.

Status: 401 - Invalid authentication for this request.

Status: 404 - Could not find the org property or insufficient permissions to finds.

Status: default - Internal Server Error


getOrgProps

Gets a list of org properties.


/org-prop/{orgUuid}

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/org-prop/{orgUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OrgPropApi;

import java.io.File;
import java.util.*;

public class OrgPropApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        OrgPropApi apiInstance = new OrgPropApi();
        String orgUuid = orgUuid_example; // String | The UUID of the org whose properties are being retrieved.
        try {
            array[orgProp] result = apiInstance.getOrgProps(orgUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrgPropApi#getOrgProps");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.OrgPropApi;

public class OrgPropApiExample {

    public static void main(String[] args) {
        OrgPropApi apiInstance = new OrgPropApi();
        String orgUuid = orgUuid_example; // String | The UUID of the org whose properties are being retrieved.
        try {
            array[orgProp] result = apiInstance.getOrgProps(orgUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrgPropApi#getOrgProps");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *orgUuid = orgUuid_example; // The UUID of the org whose properties are being retrieved.

OrgPropApi *apiInstance = [[OrgPropApi alloc] init];

// Gets a list of org properties.
[apiInstance getOrgPropsWith:orgUuid
              completionHandler: ^(array[orgProp] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.OrgPropApi()
var orgUuid = orgUuid_example; // {{String}} The UUID of the org whose properties are being retrieved.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrgProps(orgUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getOrgPropsExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new OrgPropApi();
            var orgUuid = orgUuid_example;  // String | The UUID of the org whose properties are being retrieved.

            try
            {
                // Gets a list of org properties.
                array[orgProp] result = apiInstance.getOrgProps(orgUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrgPropApi.getOrgProps: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiOrgPropApi();
$orgUuid = orgUuid_example; // String | The UUID of the org whose properties are being retrieved.

try {
    $result = $api_instance->getOrgProps($orgUuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrgPropApi->getOrgProps: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OrgPropApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::OrgPropApi->new();
my $orgUuid = orgUuid_example; # String | The UUID of the org whose properties are being retrieved.

eval { 
    my $result = $api_instance->getOrgProps(orgUuid => $orgUuid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrgPropApi->getOrgProps: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.OrgPropApi()
orgUuid = orgUuid_example # String | The UUID of the org whose properties are being retrieved.

try: 
    # Gets a list of org properties.
    api_response = api_instance.get_org_props(orgUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrgPropApi->getOrgProps: %s\n" % e)

Parameters

Path parameters
Name Description
orgUuid*
String
The UUID of the org whose properties are being retrieved.
Required

Responses

Status: 200 - Fetched the list of org properties and transmitted in the message body.

Status: 401 - Invalid authentication for this request.

Status: 404 - Could not find the list of org properties or insufficient permissions to find.

Status: default - Internal Server Error


updateOrgProp

Updates an org property.


/org-prop/{orgUuid}/{propName}

Usage and SDK Samples

curl -X PUT\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/org-prop/{orgUuid}/{propName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OrgPropApi;

import java.io.File;
import java.util.*;

public class OrgPropApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        OrgPropApi apiInstance = new OrgPropApi();
        PropUpdateRequest body = ; // PropUpdateRequest | The updated org property.
        String orgUuid = orgUuid_example; // String | The UUID of the org whose property is being updated.
        String propName = propName_example; // String | The name of the property to update.
        try {
            apiInstance.updateOrgProp(body, orgUuid, propName);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrgPropApi#updateOrgProp");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.OrgPropApi;

public class OrgPropApiExample {

    public static void main(String[] args) {
        OrgPropApi apiInstance = new OrgPropApi();
        PropUpdateRequest body = ; // PropUpdateRequest | The updated org property.
        String orgUuid = orgUuid_example; // String | The UUID of the org whose property is being updated.
        String propName = propName_example; // String | The name of the property to update.
        try {
            apiInstance.updateOrgProp(body, orgUuid, propName);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrgPropApi#updateOrgProp");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
PropUpdateRequest *body = ; // The updated org property.
String *orgUuid = orgUuid_example; // The UUID of the org whose property is being updated.
String *propName = propName_example; // The name of the property to update.

OrgPropApi *apiInstance = [[OrgPropApi alloc] init];

// Updates an org property.
[apiInstance updateOrgPropWith:body
    orgUuid:orgUuid
    propName:propName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.OrgPropApi()
var body = ; // {{PropUpdateRequest}} The updated org property.
var orgUuid = orgUuid_example; // {{String}} The UUID of the org whose property is being updated.
var propName = propName_example; // {{String}} The name of the property to update.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateOrgProp(bodyorgUuidpropName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateOrgPropExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new OrgPropApi();
            var body = new PropUpdateRequest(); // PropUpdateRequest | The updated org property.
            var orgUuid = orgUuid_example;  // String | The UUID of the org whose property is being updated.
            var propName = propName_example;  // String | The name of the property to update.

            try
            {
                // Updates an org property.
                apiInstance.updateOrgProp(body, orgUuid, propName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrgPropApi.updateOrgProp: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiOrgPropApi();
$body = ; // PropUpdateRequest | The updated org property.
$orgUuid = orgUuid_example; // String | The UUID of the org whose property is being updated.
$propName = propName_example; // String | The name of the property to update.

try {
    $api_instance->updateOrgProp($body, $orgUuid, $propName);
} catch (Exception $e) {
    echo 'Exception when calling OrgPropApi->updateOrgProp: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OrgPropApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::OrgPropApi->new();
my $body = WWW::SwaggerClient::Object::PropUpdateRequest->new(); # PropUpdateRequest | The updated org property.
my $orgUuid = orgUuid_example; # String | The UUID of the org whose property is being updated.
my $propName = propName_example; # String | The name of the property to update.

eval { 
    $api_instance->updateOrgProp(body => $body, orgUuid => $orgUuid, propName => $propName);
};
if ($@) {
    warn "Exception when calling OrgPropApi->updateOrgProp: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.OrgPropApi()
body =  # PropUpdateRequest | The updated org property.
orgUuid = orgUuid_example # String | The UUID of the org whose property is being updated.
propName = propName_example # String | The name of the property to update.

try: 
    # Updates an org property.
    api_instance.update_org_prop(body, orgUuid, propName)
except ApiException as e:
    print("Exception when calling OrgPropApi->updateOrgProp: %s\n" % e)

Parameters

Path parameters
Name Description
orgUuid*
String
The UUID of the org whose property is being updated.
Required
propName*
String
The name of the property to update.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - The org property was updated successfully.

Status: 401 - Invalid authentication for this request.

Status: 403 - Session not authorised.

Status: default - Internal Server Error


Party

createThirdPartyCacheDetails

Fetches cache for third party integration cache.


/third-party/{service}

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/third-party/{service}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PartyApi;

import java.io.File;
import java.util.*;

public class PartyApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        PartyApi apiInstance = new PartyApi();
        String service = service_example; // String | The name of the service to create.
        try {
            createResponse result = apiInstance.createThirdPartyCacheDetails(service);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PartyApi#createThirdPartyCacheDetails");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PartyApi;

public class PartyApiExample {

    public static void main(String[] args) {
        PartyApi apiInstance = new PartyApi();
        String service = service_example; // String | The name of the service to create.
        try {
            createResponse result = apiInstance.createThirdPartyCacheDetails(service);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PartyApi#createThirdPartyCacheDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *service = service_example; // The name of the service to create.

PartyApi *apiInstance = [[PartyApi alloc] init];

// Fetches cache for third party integration cache.
[apiInstance createThirdPartyCacheDetailsWith:service
              completionHandler: ^(createResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.PartyApi()
var service = service_example; // {{String}} The name of the service to create.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createThirdPartyCacheDetails(service, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createThirdPartyCacheDetailsExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new PartyApi();
            var service = service_example;  // String | The name of the service to create.

            try
            {
                // Fetches cache for third party integration cache.
                createResponse result = apiInstance.createThirdPartyCacheDetails(service);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PartyApi.createThirdPartyCacheDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiPartyApi();
$service = service_example; // String | The name of the service to create.

try {
    $result = $api_instance->createThirdPartyCacheDetails($service);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PartyApi->createThirdPartyCacheDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PartyApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::PartyApi->new();
my $service = service_example; # String | The name of the service to create.

eval { 
    my $result = $api_instance->createThirdPartyCacheDetails(service => $service);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PartyApi->createThirdPartyCacheDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.PartyApi()
service = service_example # String | The name of the service to create.

try: 
    # Fetches cache for third party integration cache.
    api_response = api_instance.create_third_party_cache_details(service)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PartyApi->createThirdPartyCacheDetails: %s\n" % e)

Parameters

Path parameters
Name Description
service*
String
The name of the service to create.
Required

Responses

Status: 200 - UUID of new service tracking record.

Status: default - Internal Server Error


createThirdPartyCacheItem

Creates a new cache item for third party integration.


/third-party/{service}/cache

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/third-party/{service}/cache"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PartyApi;

import java.io.File;
import java.util.*;

public class PartyApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        PartyApi apiInstance = new PartyApi();
        String service = service_example; // String | The name of the service to fetch cache for.
        ThirdpartyCacheItem body = ; // ThirdpartyCacheItem | The details of the cache to create.
        try {
            createResponse result = apiInstance.createThirdPartyCacheItem(service, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PartyApi#createThirdPartyCacheItem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PartyApi;

public class PartyApiExample {

    public static void main(String[] args) {
        PartyApi apiInstance = new PartyApi();
        String service = service_example; // String | The name of the service to fetch cache for.
        ThirdpartyCacheItem body = ; // ThirdpartyCacheItem | The details of the cache to create.
        try {
            createResponse result = apiInstance.createThirdPartyCacheItem(service, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PartyApi#createThirdPartyCacheItem");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *service = service_example; // The name of the service to fetch cache for.
ThirdpartyCacheItem *body = ; // The details of the cache to create. (optional)

PartyApi *apiInstance = [[PartyApi alloc] init];

// Creates a new cache item for third party integration.
[apiInstance createThirdPartyCacheItemWith:service
    body:body
              completionHandler: ^(createResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.PartyApi()
var service = service_example; // {{String}} The name of the service to fetch cache for.
var opts = { 
  'body':  // {{ThirdpartyCacheItem}} The details of the cache to create.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createThirdPartyCacheItem(service, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createThirdPartyCacheItemExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new PartyApi();
            var service = service_example;  // String | The name of the service to fetch cache for.
            var body = new ThirdpartyCacheItem(); // ThirdpartyCacheItem | The details of the cache to create. (optional) 

            try
            {
                // Creates a new cache item for third party integration.
                createResponse result = apiInstance.createThirdPartyCacheItem(service, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PartyApi.createThirdPartyCacheItem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiPartyApi();
$service = service_example; // String | The name of the service to fetch cache for.
$body = ; // ThirdpartyCacheItem | The details of the cache to create.

try {
    $result = $api_instance->createThirdPartyCacheItem($service, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PartyApi->createThirdPartyCacheItem: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PartyApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::PartyApi->new();
my $service = service_example; # String | The name of the service to fetch cache for.
my $body = WWW::SwaggerClient::Object::ThirdpartyCacheItem->new(); # ThirdpartyCacheItem | The details of the cache to create.

eval { 
    my $result = $api_instance->createThirdPartyCacheItem(service => $service, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PartyApi->createThirdPartyCacheItem: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.PartyApi()
service = service_example # String | The name of the service to fetch cache for.
body =  # ThirdpartyCacheItem | The details of the cache to create. (optional)

try: 
    # Creates a new cache item for third party integration.
    api_response = api_instance.create_third_party_cache_item(service, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PartyApi->createThirdPartyCacheItem: %s\n" % e)

Parameters

Path parameters
Name Description
service*
String
The name of the service to fetch cache for.
Required
Body parameters
Name Description
body

Responses

Status: 200 - UUID of created cache item.

Status: default - Internal Server Error


deleteThirdPartyCacheItem

Deletes an item from the third party cache.


/third-party/{service}/cache/{itemUuid}

Usage and SDK Samples

curl -X DELETE\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/third-party/{service}/cache/{itemUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PartyApi;

import java.io.File;
import java.util.*;

public class PartyApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        PartyApi apiInstance = new PartyApi();
        String service = service_example; // String | The name of the service to update item on.
        String itemUuid = itemUuid_example; // String | The name of the service to fetch cache for.
        try {
            apiInstance.deleteThirdPartyCacheItem(service, itemUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling PartyApi#deleteThirdPartyCacheItem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PartyApi;

public class PartyApiExample {

    public static void main(String[] args) {
        PartyApi apiInstance = new PartyApi();
        String service = service_example; // String | The name of the service to update item on.
        String itemUuid = itemUuid_example; // String | The name of the service to fetch cache for.
        try {
            apiInstance.deleteThirdPartyCacheItem(service, itemUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling PartyApi#deleteThirdPartyCacheItem");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *service = service_example; // The name of the service to update item on.
String *itemUuid = itemUuid_example; // The name of the service to fetch cache for.

PartyApi *apiInstance = [[PartyApi alloc] init];

// Deletes an item from the third party cache.
[apiInstance deleteThirdPartyCacheItemWith:service
    itemUuid:itemUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.PartyApi()
var service = service_example; // {{String}} The name of the service to update item on.
var itemUuid = itemUuid_example; // {{String}} The name of the service to fetch cache for.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteThirdPartyCacheItem(service, itemUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteThirdPartyCacheItemExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new PartyApi();
            var service = service_example;  // String | The name of the service to update item on.
            var itemUuid = itemUuid_example;  // String | The name of the service to fetch cache for.

            try
            {
                // Deletes an item from the third party cache.
                apiInstance.deleteThirdPartyCacheItem(service, itemUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PartyApi.deleteThirdPartyCacheItem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiPartyApi();
$service = service_example; // String | The name of the service to update item on.
$itemUuid = itemUuid_example; // String | The name of the service to fetch cache for.

try {
    $api_instance->deleteThirdPartyCacheItem($service, $itemUuid);
} catch (Exception $e) {
    echo 'Exception when calling PartyApi->deleteThirdPartyCacheItem: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PartyApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::PartyApi->new();
my $service = service_example; # String | The name of the service to update item on.
my $itemUuid = itemUuid_example; # String | The name of the service to fetch cache for.

eval { 
    $api_instance->deleteThirdPartyCacheItem(service => $service, itemUuid => $itemUuid);
};
if ($@) {
    warn "Exception when calling PartyApi->deleteThirdPartyCacheItem: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.PartyApi()
service = service_example # String | The name of the service to update item on.
itemUuid = itemUuid_example # String | The name of the service to fetch cache for.

try: 
    # Deletes an item from the third party cache.
    api_instance.delete_third_party_cache_item(service, itemUuid)
except ApiException as e:
    print("Exception when calling PartyApi->deleteThirdPartyCacheItem: %s\n" % e)

Parameters

Path parameters
Name Description
service*
String
The name of the service to update item on.
Required
itemUuid*
String
The name of the service to fetch cache for.
Required

Responses

Status: 204 - Successfully updated the item in the third party cache.

Status: default - Internal Server Error


getThirdPartyDetailsAndCache

Fetches cache for third party integration cache.


/third-party/{service}

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/third-party/{service}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PartyApi;

import java.io.File;
import java.util.*;

public class PartyApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        PartyApi apiInstance = new PartyApi();
        String service = service_example; // String | The name of the service to fetch cache for.
        try {
            thirdpartyFullCache result = apiInstance.getThirdPartyDetailsAndCache(service);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PartyApi#getThirdPartyDetailsAndCache");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PartyApi;

public class PartyApiExample {

    public static void main(String[] args) {
        PartyApi apiInstance = new PartyApi();
        String service = service_example; // String | The name of the service to fetch cache for.
        try {
            thirdpartyFullCache result = apiInstance.getThirdPartyDetailsAndCache(service);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PartyApi#getThirdPartyDetailsAndCache");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *service = service_example; // The name of the service to fetch cache for.

PartyApi *apiInstance = [[PartyApi alloc] init];

// Fetches cache for third party integration cache.
[apiInstance getThirdPartyDetailsAndCacheWith:service
              completionHandler: ^(thirdpartyFullCache output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.PartyApi()
var service = service_example; // {{String}} The name of the service to fetch cache for.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getThirdPartyDetailsAndCache(service, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getThirdPartyDetailsAndCacheExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new PartyApi();
            var service = service_example;  // String | The name of the service to fetch cache for.

            try
            {
                // Fetches cache for third party integration cache.
                thirdpartyFullCache result = apiInstance.getThirdPartyDetailsAndCache(service);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PartyApi.getThirdPartyDetailsAndCache: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiPartyApi();
$service = service_example; // String | The name of the service to fetch cache for.

try {
    $result = $api_instance->getThirdPartyDetailsAndCache($service);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PartyApi->getThirdPartyDetailsAndCache: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PartyApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::PartyApi->new();
my $service = service_example; # String | The name of the service to fetch cache for.

eval { 
    my $result = $api_instance->getThirdPartyDetailsAndCache(service => $service);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PartyApi->getThirdPartyDetailsAndCache: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.PartyApi()
service = service_example # String | The name of the service to fetch cache for.

try: 
    # Fetches cache for third party integration cache.
    api_response = api_instance.get_third_party_details_and_cache(service)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PartyApi->getThirdPartyDetailsAndCache: %s\n" % e)

Parameters

Path parameters
Name Description
service*
String
The name of the service to fetch cache for.
Required

Responses

Status: 200 - Fetched service details and list of cached items and transmitted in message body.

Status: 404 - Requested cache not found or insufficient permissions to finds.

Status: default - Internal Server Error


updateThirdPartyCacheDetails

Updates details of integrated service.


/third-party/{service}

Usage and SDK Samples

curl -X PUT\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/third-party/{service}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PartyApi;

import java.io.File;
import java.util.*;

public class PartyApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        PartyApi apiInstance = new PartyApi();
        String service = service_example; // String | The name of the service to fetch cache for.
        ThirdpartyCache body = ; // ThirdpartyCache | The details to update (only last_sync can be updated).
        try {
            apiInstance.updateThirdPartyCacheDetails(service, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling PartyApi#updateThirdPartyCacheDetails");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PartyApi;

public class PartyApiExample {

    public static void main(String[] args) {
        PartyApi apiInstance = new PartyApi();
        String service = service_example; // String | The name of the service to fetch cache for.
        ThirdpartyCache body = ; // ThirdpartyCache | The details to update (only last_sync can be updated).
        try {
            apiInstance.updateThirdPartyCacheDetails(service, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling PartyApi#updateThirdPartyCacheDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *service = service_example; // The name of the service to fetch cache for.
ThirdpartyCache *body = ; // The details to update (only last_sync can be updated). (optional)

PartyApi *apiInstance = [[PartyApi alloc] init];

// Updates details of integrated service.
[apiInstance updateThirdPartyCacheDetailsWith:service
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.PartyApi()
var service = service_example; // {{String}} The name of the service to fetch cache for.
var opts = { 
  'body':  // {{ThirdpartyCache}} The details to update (only last_sync can be updated).
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateThirdPartyCacheDetails(service, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateThirdPartyCacheDetailsExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new PartyApi();
            var service = service_example;  // String | The name of the service to fetch cache for.
            var body = new ThirdpartyCache(); // ThirdpartyCache | The details to update (only last_sync can be updated). (optional) 

            try
            {
                // Updates details of integrated service.
                apiInstance.updateThirdPartyCacheDetails(service, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PartyApi.updateThirdPartyCacheDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiPartyApi();
$service = service_example; // String | The name of the service to fetch cache for.
$body = ; // ThirdpartyCache | The details to update (only last_sync can be updated).

try {
    $api_instance->updateThirdPartyCacheDetails($service, $body);
} catch (Exception $e) {
    echo 'Exception when calling PartyApi->updateThirdPartyCacheDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PartyApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::PartyApi->new();
my $service = service_example; # String | The name of the service to fetch cache for.
my $body = WWW::SwaggerClient::Object::ThirdpartyCache->new(); # ThirdpartyCache | The details to update (only last_sync can be updated).

eval { 
    $api_instance->updateThirdPartyCacheDetails(service => $service, body => $body);
};
if ($@) {
    warn "Exception when calling PartyApi->updateThirdPartyCacheDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.PartyApi()
service = service_example # String | The name of the service to fetch cache for.
body =  # ThirdpartyCache | The details to update (only last_sync can be updated). (optional)

try: 
    # Updates details of integrated service.
    api_instance.update_third_party_cache_details(service, body=body)
except ApiException as e:
    print("Exception when calling PartyApi->updateThirdPartyCacheDetails: %s\n" % e)

Parameters

Path parameters
Name Description
service*
String
The name of the service to fetch cache for.
Required
Body parameters
Name Description
body

Responses

Status: 204 - Details successfully updated.

Status: default - Internal Server Error


updateThirdPartyCacheItem

Updates a cache item for a third party integration cache.


/third-party/{service}/cache/{itemUuid}

Usage and SDK Samples

curl -X PUT\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/third-party/{service}/cache/{itemUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PartyApi;

import java.io.File;
import java.util.*;

public class PartyApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        PartyApi apiInstance = new PartyApi();
        String service = service_example; // String | The name of the service to update item on.
        String itemUuid = itemUuid_example; // String | The UUID of the item to update.
        ThirdpartyCacheItem body = ; // ThirdpartyCacheItem | The details to update (only checksum can be updated).
        try {
            apiInstance.updateThirdPartyCacheItem(service, itemUuid, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling PartyApi#updateThirdPartyCacheItem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PartyApi;

public class PartyApiExample {

    public static void main(String[] args) {
        PartyApi apiInstance = new PartyApi();
        String service = service_example; // String | The name of the service to update item on.
        String itemUuid = itemUuid_example; // String | The UUID of the item to update.
        ThirdpartyCacheItem body = ; // ThirdpartyCacheItem | The details to update (only checksum can be updated).
        try {
            apiInstance.updateThirdPartyCacheItem(service, itemUuid, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling PartyApi#updateThirdPartyCacheItem");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *service = service_example; // The name of the service to update item on.
String *itemUuid = itemUuid_example; // The UUID of the item to update.
ThirdpartyCacheItem *body = ; // The details to update (only checksum can be updated). (optional)

PartyApi *apiInstance = [[PartyApi alloc] init];

// Updates a cache item for a third party integration cache.
[apiInstance updateThirdPartyCacheItemWith:service
    itemUuid:itemUuid
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.PartyApi()
var service = service_example; // {{String}} The name of the service to update item on.
var itemUuid = itemUuid_example; // {{String}} The UUID of the item to update.
var opts = { 
  'body':  // {{ThirdpartyCacheItem}} The details to update (only checksum can be updated).
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateThirdPartyCacheItem(serviceitemUuid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateThirdPartyCacheItemExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new PartyApi();
            var service = service_example;  // String | The name of the service to update item on.
            var itemUuid = itemUuid_example;  // String | The UUID of the item to update.
            var body = new ThirdpartyCacheItem(); // ThirdpartyCacheItem | The details to update (only checksum can be updated). (optional) 

            try
            {
                // Updates a cache item for a third party integration cache.
                apiInstance.updateThirdPartyCacheItem(service, itemUuid, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PartyApi.updateThirdPartyCacheItem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiPartyApi();
$service = service_example; // String | The name of the service to update item on.
$itemUuid = itemUuid_example; // String | The UUID of the item to update.
$body = ; // ThirdpartyCacheItem | The details to update (only checksum can be updated).

try {
    $api_instance->updateThirdPartyCacheItem($service, $itemUuid, $body);
} catch (Exception $e) {
    echo 'Exception when calling PartyApi->updateThirdPartyCacheItem: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PartyApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::PartyApi->new();
my $service = service_example; # String | The name of the service to update item on.
my $itemUuid = itemUuid_example; # String | The UUID of the item to update.
my $body = WWW::SwaggerClient::Object::ThirdpartyCacheItem->new(); # ThirdpartyCacheItem | The details to update (only checksum can be updated).

eval { 
    $api_instance->updateThirdPartyCacheItem(service => $service, itemUuid => $itemUuid, body => $body);
};
if ($@) {
    warn "Exception when calling PartyApi->updateThirdPartyCacheItem: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.PartyApi()
service = service_example # String | The name of the service to update item on.
itemUuid = itemUuid_example # String | The UUID of the item to update.
body =  # ThirdpartyCacheItem | The details to update (only checksum can be updated). (optional)

try: 
    # Updates a cache item for a third party integration cache.
    api_instance.update_third_party_cache_item(service, itemUuid, body=body)
except ApiException as e:
    print("Exception when calling PartyApi->updateThirdPartyCacheItem: %s\n" % e)

Parameters

Path parameters
Name Description
service*
String
The name of the service to update item on.
Required
itemUuid*
String
The UUID of the item to update.
Required
Body parameters
Name Description
body

Responses

Status: 204 - Cache item successfully updated.

Status: default - Internal Server Error


Playbook

addActionToPlaybook

Adds an action to a playbook.


/playbook/{playbookUuid}/playbook-action/{playbookActionUuid}

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/playbook/{playbookUuid}/playbook-action/{playbookActionUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlaybookApi;

import java.io.File;
import java.util.*;

public class PlaybookApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        PlaybookApi apiInstance = new PlaybookApi();
        PlaybookControlFlowRequest body = ; // PlaybookControlFlowRequest | The control flow details for the acton in the playbook
        String playbookUuid = playbookUuid_example; // String | The playbook to add to.
        String playbookActionUuid = playbookActionUuid_example; // String | The playbook action to add.
        try {
            apiInstance.addActionToPlaybook(body, playbookUuid, playbookActionUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaybookApi#addActionToPlaybook");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlaybookApi;

public class PlaybookApiExample {

    public static void main(String[] args) {
        PlaybookApi apiInstance = new PlaybookApi();
        PlaybookControlFlowRequest body = ; // PlaybookControlFlowRequest | The control flow details for the acton in the playbook
        String playbookUuid = playbookUuid_example; // String | The playbook to add to.
        String playbookActionUuid = playbookActionUuid_example; // String | The playbook action to add.
        try {
            apiInstance.addActionToPlaybook(body, playbookUuid, playbookActionUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaybookApi#addActionToPlaybook");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
PlaybookControlFlowRequest *body = ; // The control flow details for the acton in the playbook
String *playbookUuid = playbookUuid_example; // The playbook to add to.
String *playbookActionUuid = playbookActionUuid_example; // The playbook action to add.

PlaybookApi *apiInstance = [[PlaybookApi alloc] init];

// Adds an action to a playbook.
[apiInstance addActionToPlaybookWith:body
    playbookUuid:playbookUuid
    playbookActionUuid:playbookActionUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.PlaybookApi()
var body = ; // {{PlaybookControlFlowRequest}} The control flow details for the acton in the playbook
var playbookUuid = playbookUuid_example; // {{String}} The playbook to add to.
var playbookActionUuid = playbookActionUuid_example; // {{String}} The playbook action to add.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.addActionToPlaybook(bodyplaybookUuidplaybookActionUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addActionToPlaybookExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new PlaybookApi();
            var body = new PlaybookControlFlowRequest(); // PlaybookControlFlowRequest | The control flow details for the acton in the playbook
            var playbookUuid = playbookUuid_example;  // String | The playbook to add to.
            var playbookActionUuid = playbookActionUuid_example;  // String | The playbook action to add.

            try
            {
                // Adds an action to a playbook.
                apiInstance.addActionToPlaybook(body, playbookUuid, playbookActionUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlaybookApi.addActionToPlaybook: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiPlaybookApi();
$body = ; // PlaybookControlFlowRequest | The control flow details for the acton in the playbook
$playbookUuid = playbookUuid_example; // String | The playbook to add to.
$playbookActionUuid = playbookActionUuid_example; // String | The playbook action to add.

try {
    $api_instance->addActionToPlaybook($body, $playbookUuid, $playbookActionUuid);
} catch (Exception $e) {
    echo 'Exception when calling PlaybookApi->addActionToPlaybook: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PlaybookApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::PlaybookApi->new();
my $body = WWW::SwaggerClient::Object::PlaybookControlFlowRequest->new(); # PlaybookControlFlowRequest | The control flow details for the acton in the playbook
my $playbookUuid = playbookUuid_example; # String | The playbook to add to.
my $playbookActionUuid = playbookActionUuid_example; # String | The playbook action to add.

eval { 
    $api_instance->addActionToPlaybook(body => $body, playbookUuid => $playbookUuid, playbookActionUuid => $playbookActionUuid);
};
if ($@) {
    warn "Exception when calling PlaybookApi->addActionToPlaybook: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.PlaybookApi()
body =  # PlaybookControlFlowRequest | The control flow details for the acton in the playbook
playbookUuid = playbookUuid_example # String | The playbook to add to.
playbookActionUuid = playbookActionUuid_example # String | The playbook action to add.

try: 
    # Adds an action to a playbook.
    api_instance.add_action_to_playbook(body, playbookUuid, playbookActionUuid)
except ApiException as e:
    print("Exception when calling PlaybookApi->addActionToPlaybook: %s\n" % e)

Parameters

Path parameters
Name Description
playbookUuid*
String
The playbook to add to.
Required
playbookActionUuid*
String
The playbook action to add.
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Action added to playbook successfully.

Status: default - Internal Server Error


addTagToPlaybook

Adds a tag to a playbook.


/playbook/{playbookUuid}/case-tag/{caseTagUuid}

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/playbook/{playbookUuid}/case-tag/{caseTagUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlaybookApi;

import java.io.File;
import java.util.*;

public class PlaybookApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        PlaybookApi apiInstance = new PlaybookApi();
        String playbookUuid = playbookUuid_example; // String | The playbook to add to.
        String caseTagUuid = caseTagUuid_example; // String | The tag to add.
        try {
            apiInstance.addTagToPlaybook(playbookUuid, caseTagUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaybookApi#addTagToPlaybook");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlaybookApi;

public class PlaybookApiExample {

    public static void main(String[] args) {
        PlaybookApi apiInstance = new PlaybookApi();
        String playbookUuid = playbookUuid_example; // String | The playbook to add to.
        String caseTagUuid = caseTagUuid_example; // String | The tag to add.
        try {
            apiInstance.addTagToPlaybook(playbookUuid, caseTagUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaybookApi#addTagToPlaybook");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *playbookUuid = playbookUuid_example; // The playbook to add to.
String *caseTagUuid = caseTagUuid_example; // The tag to add.

PlaybookApi *apiInstance = [[PlaybookApi alloc] init];

// Adds a tag to a playbook.
[apiInstance addTagToPlaybookWith:playbookUuid
    caseTagUuid:caseTagUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.PlaybookApi()
var playbookUuid = playbookUuid_example; // {{String}} The playbook to add to.
var caseTagUuid = caseTagUuid_example; // {{String}} The tag to add.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.addTagToPlaybook(playbookUuid, caseTagUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addTagToPlaybookExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new PlaybookApi();
            var playbookUuid = playbookUuid_example;  // String | The playbook to add to.
            var caseTagUuid = caseTagUuid_example;  // String | The tag to add.

            try
            {
                // Adds a tag to a playbook.
                apiInstance.addTagToPlaybook(playbookUuid, caseTagUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlaybookApi.addTagToPlaybook: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiPlaybookApi();
$playbookUuid = playbookUuid_example; // String | The playbook to add to.
$caseTagUuid = caseTagUuid_example; // String | The tag to add.

try {
    $api_instance->addTagToPlaybook($playbookUuid, $caseTagUuid);
} catch (Exception $e) {
    echo 'Exception when calling PlaybookApi->addTagToPlaybook: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PlaybookApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::PlaybookApi->new();
my $playbookUuid = playbookUuid_example; # String | The playbook to add to.
my $caseTagUuid = caseTagUuid_example; # String | The tag to add.

eval { 
    $api_instance->addTagToPlaybook(playbookUuid => $playbookUuid, caseTagUuid => $caseTagUuid);
};
if ($@) {
    warn "Exception when calling PlaybookApi->addTagToPlaybook: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.PlaybookApi()
playbookUuid = playbookUuid_example # String | The playbook to add to.
caseTagUuid = caseTagUuid_example # String | The tag to add.

try: 
    # Adds a tag to a playbook.
    api_instance.add_tag_to_playbook(playbookUuid, caseTagUuid)
except ApiException as e:
    print("Exception when calling PlaybookApi->addTagToPlaybook: %s\n" % e)

Parameters

Path parameters
Name Description
playbookUuid*
String
The playbook to add to.
Required
caseTagUuid*
String
The tag to add.
Required

Responses

Status: 201 - Added the tag to the playbook successfully.

Status: default - Internal Server Error


createPlaybook

Creates a playbook.


/playbook

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/playbook"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlaybookApi;

import java.io.File;
import java.util.*;

public class PlaybookApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        PlaybookApi apiInstance = new PlaybookApi();
        PlaybookRequest body = ; // PlaybookRequest | The playbook to create.
        try {
            createResponse result = apiInstance.createPlaybook(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaybookApi#createPlaybook");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlaybookApi;

public class PlaybookApiExample {

    public static void main(String[] args) {
        PlaybookApi apiInstance = new PlaybookApi();
        PlaybookRequest body = ; // PlaybookRequest | The playbook to create.
        try {
            createResponse result = apiInstance.createPlaybook(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaybookApi#createPlaybook");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
PlaybookRequest *body = ; // The playbook to create.

PlaybookApi *apiInstance = [[PlaybookApi alloc] init];

// Creates a playbook.
[apiInstance createPlaybookWith:body
              completionHandler: ^(createResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.PlaybookApi()
var body = ; // {{PlaybookRequest}} The playbook to create.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createPlaybook(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createPlaybookExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new PlaybookApi();
            var body = new PlaybookRequest(); // PlaybookRequest | The playbook to create.

            try
            {
                // Creates a playbook.
                createResponse result = apiInstance.createPlaybook(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlaybookApi.createPlaybook: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiPlaybookApi();
$body = ; // PlaybookRequest | The playbook to create.

try {
    $result = $api_instance->createPlaybook($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PlaybookApi->createPlaybook: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PlaybookApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::PlaybookApi->new();
my $body = WWW::SwaggerClient::Object::PlaybookRequest->new(); # PlaybookRequest | The playbook to create.

eval { 
    my $result = $api_instance->createPlaybook(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PlaybookApi->createPlaybook: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.PlaybookApi()
body =  # PlaybookRequest | The playbook to create.

try: 
    # Creates a playbook.
    api_response = api_instance.create_playbook(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlaybookApi->createPlaybook: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Playbook successfully created.

Status: default - Internal Server Error


createPlaybookFile

Creates a playbook by upload file.


/playbook/file/upload

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/playbook/file/upload?validate_only="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlaybookApi;

import java.io.File;
import java.util.*;

public class PlaybookApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        PlaybookApi apiInstance = new PlaybookApi();
        AtcPlaybook body = ; // AtcPlaybook | The playbook file content to create.
        Boolean validateOnly = true; // Boolean | Only validate the playbook, does not save to database".
        try {
            apiInstance.createPlaybookFile(body, validateOnly);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaybookApi#createPlaybookFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlaybookApi;

public class PlaybookApiExample {

    public static void main(String[] args) {
        PlaybookApi apiInstance = new PlaybookApi();
        AtcPlaybook body = ; // AtcPlaybook | The playbook file content to create.
        Boolean validateOnly = true; // Boolean | Only validate the playbook, does not save to database".
        try {
            apiInstance.createPlaybookFile(body, validateOnly);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaybookApi#createPlaybookFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
AtcPlaybook *body = ; // The playbook file content to create.
Boolean *validateOnly = true; // Only validate the playbook, does not save to database". (optional) (default to false)

PlaybookApi *apiInstance = [[PlaybookApi alloc] init];

// Creates a playbook by upload file.
[apiInstance createPlaybookFileWith:body
    validateOnly:validateOnly
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.PlaybookApi()
var body = ; // {{AtcPlaybook}} The playbook file content to create.
var opts = { 
  'validateOnly': true // {{Boolean}} Only validate the playbook, does not save to database".
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createPlaybookFile(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createPlaybookFileExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new PlaybookApi();
            var body = new AtcPlaybook(); // AtcPlaybook | The playbook file content to create.
            var validateOnly = true;  // Boolean | Only validate the playbook, does not save to database". (optional)  (default to false)

            try
            {
                // Creates a playbook by upload file.
                apiInstance.createPlaybookFile(body, validateOnly);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlaybookApi.createPlaybookFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiPlaybookApi();
$body = ; // AtcPlaybook | The playbook file content to create.
$validateOnly = true; // Boolean | Only validate the playbook, does not save to database".

try {
    $api_instance->createPlaybookFile($body, $validateOnly);
} catch (Exception $e) {
    echo 'Exception when calling PlaybookApi->createPlaybookFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PlaybookApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::PlaybookApi->new();
my $body = WWW::SwaggerClient::Object::AtcPlaybook->new(); # AtcPlaybook | The playbook file content to create.
my $validateOnly = true; # Boolean | Only validate the playbook, does not save to database".

eval { 
    $api_instance->createPlaybookFile(body => $body, validateOnly => $validateOnly);
};
if ($@) {
    warn "Exception when calling PlaybookApi->createPlaybookFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.PlaybookApi()
body =  # AtcPlaybook | The playbook file content to create.
validateOnly = true # Boolean | Only validate the playbook, does not save to database". (optional) (default to false)

try: 
    # Creates a playbook by upload file.
    api_instance.create_playbook_file(body, validateOnly=validateOnly)
except ApiException as e:
    print("Exception when calling PlaybookApi->createPlaybookFile: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
validate_only
Boolean
Only validate the playbook, does not save to database".

Responses

Status: 200 - Playbook successfully validate.

Status: 201 - Playbook successfully created.

Status: 400 - Invalid CACAO playbook

Status: default - Internal Server Error


deletePlaybook

Deletes a playbook.


/playbook/{playbookUuid}

Usage and SDK Samples

curl -X DELETE\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/playbook/{playbookUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlaybookApi;

import java.io.File;
import java.util.*;

public class PlaybookApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        PlaybookApi apiInstance = new PlaybookApi();
        String playbookUuid = playbookUuid_example; // String | The UUID of the playbook to delete.
        try {
            apiInstance.deletePlaybook(playbookUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaybookApi#deletePlaybook");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlaybookApi;

public class PlaybookApiExample {

    public static void main(String[] args) {
        PlaybookApi apiInstance = new PlaybookApi();
        String playbookUuid = playbookUuid_example; // String | The UUID of the playbook to delete.
        try {
            apiInstance.deletePlaybook(playbookUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaybookApi#deletePlaybook");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *playbookUuid = playbookUuid_example; // The UUID of the playbook to delete.

PlaybookApi *apiInstance = [[PlaybookApi alloc] init];

// Deletes a playbook.
[apiInstance deletePlaybookWith:playbookUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.PlaybookApi()
var playbookUuid = playbookUuid_example; // {{String}} The UUID of the playbook to delete.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deletePlaybook(playbookUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deletePlaybookExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new PlaybookApi();
            var playbookUuid = playbookUuid_example;  // String | The UUID of the playbook to delete.

            try
            {
                // Deletes a playbook.
                apiInstance.deletePlaybook(playbookUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlaybookApi.deletePlaybook: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiPlaybookApi();
$playbookUuid = playbookUuid_example; // String | The UUID of the playbook to delete.

try {
    $api_instance->deletePlaybook($playbookUuid);
} catch (Exception $e) {
    echo 'Exception when calling PlaybookApi->deletePlaybook: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PlaybookApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::PlaybookApi->new();
my $playbookUuid = playbookUuid_example; # String | The UUID of the playbook to delete.

eval { 
    $api_instance->deletePlaybook(playbookUuid => $playbookUuid);
};
if ($@) {
    warn "Exception when calling PlaybookApi->deletePlaybook: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.PlaybookApi()
playbookUuid = playbookUuid_example # String | The UUID of the playbook to delete.

try: 
    # Deletes a playbook.
    api_instance.delete_playbook(playbookUuid)
except ApiException as e:
    print("Exception when calling PlaybookApi->deletePlaybook: %s\n" % e)

Parameters

Path parameters
Name Description
playbookUuid*
String
The UUID of the playbook to delete.
Required

Responses

Status: 204 - The playbook was deleted successfully.

Status: default - Internal Server Error


duplicatePlaybook

Duplicate a playbook.


/playbook/{playbookUuid}

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/playbook/{playbookUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlaybookApi;

import java.io.File;
import java.util.*;

public class PlaybookApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        PlaybookApi apiInstance = new PlaybookApi();
        String playbookUuid = playbookUuid_example; // String | The UUID of the playbook to duplicate.
        try {
            playbookResponse result = apiInstance.duplicatePlaybook(playbookUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaybookApi#duplicatePlaybook");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlaybookApi;

public class PlaybookApiExample {

    public static void main(String[] args) {
        PlaybookApi apiInstance = new PlaybookApi();
        String playbookUuid = playbookUuid_example; // String | The UUID of the playbook to duplicate.
        try {
            playbookResponse result = apiInstance.duplicatePlaybook(playbookUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaybookApi#duplicatePlaybook");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *playbookUuid = playbookUuid_example; // The UUID of the playbook to duplicate.

PlaybookApi *apiInstance = [[PlaybookApi alloc] init];

// Duplicate a playbook.
[apiInstance duplicatePlaybookWith:playbookUuid
              completionHandler: ^(playbookResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.PlaybookApi()
var playbookUuid = playbookUuid_example; // {{String}} The UUID of the playbook to duplicate.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.duplicatePlaybook(playbookUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class duplicatePlaybookExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new PlaybookApi();
            var playbookUuid = playbookUuid_example;  // String | The UUID of the playbook to duplicate.

            try
            {
                // Duplicate a playbook.
                playbookResponse result = apiInstance.duplicatePlaybook(playbookUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlaybookApi.duplicatePlaybook: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiPlaybookApi();
$playbookUuid = playbookUuid_example; // String | The UUID of the playbook to duplicate.

try {
    $result = $api_instance->duplicatePlaybook($playbookUuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PlaybookApi->duplicatePlaybook: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PlaybookApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::PlaybookApi->new();
my $playbookUuid = playbookUuid_example; # String | The UUID of the playbook to duplicate.

eval { 
    my $result = $api_instance->duplicatePlaybook(playbookUuid => $playbookUuid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PlaybookApi->duplicatePlaybook: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.PlaybookApi()
playbookUuid = playbookUuid_example # String | The UUID of the playbook to duplicate.

try: 
    # Duplicate a playbook.
    api_response = api_instance.duplicate_playbook(playbookUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlaybookApi->duplicatePlaybook: %s\n" % e)

Parameters

Path parameters
Name Description
playbookUuid*
String
The UUID of the playbook to duplicate.
Required

Responses

Status: 201 - Playbook successfully duplicate.

Status: default - Internal Server Error


exportPlaybook

Exporting a playbook to file.


/playbook/file/{playbookUuid}

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/playbook/file/{playbookUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlaybookApi;

import java.io.File;
import java.util.*;

public class PlaybookApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        PlaybookApi apiInstance = new PlaybookApi();
        String playbookUuid = playbookUuid_example; // String | The uuid of playbook to export.
        try {
            createResponse result = apiInstance.exportPlaybook(playbookUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaybookApi#exportPlaybook");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlaybookApi;

public class PlaybookApiExample {

    public static void main(String[] args) {
        PlaybookApi apiInstance = new PlaybookApi();
        String playbookUuid = playbookUuid_example; // String | The uuid of playbook to export.
        try {
            createResponse result = apiInstance.exportPlaybook(playbookUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaybookApi#exportPlaybook");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *playbookUuid = playbookUuid_example; // The uuid of playbook to export.

PlaybookApi *apiInstance = [[PlaybookApi alloc] init];

// Exporting a playbook to file.
[apiInstance exportPlaybookWith:playbookUuid
              completionHandler: ^(createResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.PlaybookApi()
var playbookUuid = playbookUuid_example; // {{String}} The uuid of playbook to export.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.exportPlaybook(playbookUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class exportPlaybookExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new PlaybookApi();
            var playbookUuid = playbookUuid_example;  // String | The uuid of playbook to export.

            try
            {
                // Exporting a playbook to file.
                createResponse result = apiInstance.exportPlaybook(playbookUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlaybookApi.exportPlaybook: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiPlaybookApi();
$playbookUuid = playbookUuid_example; // String | The uuid of playbook to export.

try {
    $result = $api_instance->exportPlaybook($playbookUuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PlaybookApi->exportPlaybook: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PlaybookApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::PlaybookApi->new();
my $playbookUuid = playbookUuid_example; # String | The uuid of playbook to export.

eval { 
    my $result = $api_instance->exportPlaybook(playbookUuid => $playbookUuid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PlaybookApi->exportPlaybook: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.PlaybookApi()
playbookUuid = playbookUuid_example # String | The uuid of playbook to export.

try: 
    # Exporting a playbook to file.
    api_response = api_instance.export_playbook(playbookUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlaybookApi->exportPlaybook: %s\n" % e)

Parameters

Path parameters
Name Description
playbookUuid*
String
The uuid of playbook to export.
Required

Responses

Status: 200 - Playbook successfully export.

Status: default - Internal Server Error


getPlaybook

Gets a playbook.


/playbook/{playbookUuid}

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/playbook/{playbookUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlaybookApi;

import java.io.File;
import java.util.*;

public class PlaybookApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        PlaybookApi apiInstance = new PlaybookApi();
        String playbookUuid = playbookUuid_example; // String | The UUID of the playbook to retrieve
        try {
            playbookResponse result = apiInstance.getPlaybook(playbookUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaybookApi#getPlaybook");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlaybookApi;

public class PlaybookApiExample {

    public static void main(String[] args) {
        PlaybookApi apiInstance = new PlaybookApi();
        String playbookUuid = playbookUuid_example; // String | The UUID of the playbook to retrieve
        try {
            playbookResponse result = apiInstance.getPlaybook(playbookUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaybookApi#getPlaybook");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *playbookUuid = playbookUuid_example; // The UUID of the playbook to retrieve

PlaybookApi *apiInstance = [[PlaybookApi alloc] init];

// Gets a playbook.
[apiInstance getPlaybookWith:playbookUuid
              completionHandler: ^(playbookResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.PlaybookApi()
var playbookUuid = playbookUuid_example; // {{String}} The UUID of the playbook to retrieve

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPlaybook(playbookUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPlaybookExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new PlaybookApi();
            var playbookUuid = playbookUuid_example;  // String | The UUID of the playbook to retrieve

            try
            {
                // Gets a playbook.
                playbookResponse result = apiInstance.getPlaybook(playbookUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlaybookApi.getPlaybook: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiPlaybookApi();
$playbookUuid = playbookUuid_example; // String | The UUID of the playbook to retrieve

try {
    $result = $api_instance->getPlaybook($playbookUuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PlaybookApi->getPlaybook: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PlaybookApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::PlaybookApi->new();
my $playbookUuid = playbookUuid_example; # String | The UUID of the playbook to retrieve

eval { 
    my $result = $api_instance->getPlaybook(playbookUuid => $playbookUuid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PlaybookApi->getPlaybook: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.PlaybookApi()
playbookUuid = playbookUuid_example # String | The UUID of the playbook to retrieve

try: 
    # Gets a playbook.
    api_response = api_instance.get_playbook(playbookUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlaybookApi->getPlaybook: %s\n" % e)

Parameters

Path parameters
Name Description
playbookUuid*
String
The UUID of the playbook to retrieve
Required

Responses

Status: 200 - Fetched the playbook and transmitted in the message body.

Status: default - Internal Server Error


getPlaybooks

Gets a list of playbooks.


/playbook

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/playbook"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlaybookApi;

import java.io.File;
import java.util.*;

public class PlaybookApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        PlaybookApi apiInstance = new PlaybookApi();
        try {
            array[playbookResponse] result = apiInstance.getPlaybooks();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaybookApi#getPlaybooks");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlaybookApi;

public class PlaybookApiExample {

    public static void main(String[] args) {
        PlaybookApi apiInstance = new PlaybookApi();
        try {
            array[playbookResponse] result = apiInstance.getPlaybooks();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaybookApi#getPlaybooks");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];

PlaybookApi *apiInstance = [[PlaybookApi alloc] init];

// Gets a list of playbooks.
[apiInstance getPlaybooksWithCompletionHandler: 
              ^(array[playbookResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.PlaybookApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPlaybooks(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPlaybooksExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new PlaybookApi();

            try
            {
                // Gets a list of playbooks.
                array[playbookResponse] result = apiInstance.getPlaybooks();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlaybookApi.getPlaybooks: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiPlaybookApi();

try {
    $result = $api_instance->getPlaybooks();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PlaybookApi->getPlaybooks: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PlaybookApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::PlaybookApi->new();

eval { 
    my $result = $api_instance->getPlaybooks();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PlaybookApi->getPlaybooks: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.PlaybookApi()

try: 
    # Gets a list of playbooks.
    api_response = api_instance.get_playbooks()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlaybookApi->getPlaybooks: %s\n" % e)

Parameters

Responses

Status: 200 - Fetched a list of playbooks and transmitted in the message body.

Status: default - Internal Server Error


removeActionFromPlaybook

Removes an action from a playbook.


/playbook/{playbookUuid}/playbook-action/{playbookActionUuid}

Usage and SDK Samples

curl -X DELETE\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/playbook/{playbookUuid}/playbook-action/{playbookActionUuid}?position="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlaybookApi;

import java.io.File;
import java.util.*;

public class PlaybookApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        PlaybookApi apiInstance = new PlaybookApi();
        String playbookUuid = playbookUuid_example; // String | The playbook to remove from.
        String playbookActionUuid = playbookActionUuid_example; // String | The playbook action to remove.
        String position = position_example; // String | The position to remove the playbook action from.
        try {
            apiInstance.removeActionFromPlaybook(playbookUuid, playbookActionUuid, position);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaybookApi#removeActionFromPlaybook");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlaybookApi;

public class PlaybookApiExample {

    public static void main(String[] args) {
        PlaybookApi apiInstance = new PlaybookApi();
        String playbookUuid = playbookUuid_example; // String | The playbook to remove from.
        String playbookActionUuid = playbookActionUuid_example; // String | The playbook action to remove.
        String position = position_example; // String | The position to remove the playbook action from.
        try {
            apiInstance.removeActionFromPlaybook(playbookUuid, playbookActionUuid, position);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaybookApi#removeActionFromPlaybook");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *playbookUuid = playbookUuid_example; // The playbook to remove from.
String *playbookActionUuid = playbookActionUuid_example; // The playbook action to remove.
String *position = position_example; // The position to remove the playbook action from. (optional)

PlaybookApi *apiInstance = [[PlaybookApi alloc] init];

// Removes an action from a playbook.
[apiInstance removeActionFromPlaybookWith:playbookUuid
    playbookActionUuid:playbookActionUuid
    position:position
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.PlaybookApi()
var playbookUuid = playbookUuid_example; // {{String}} The playbook to remove from.
var playbookActionUuid = playbookActionUuid_example; // {{String}} The playbook action to remove.
var opts = { 
  'position': position_example // {{String}} The position to remove the playbook action from.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeActionFromPlaybook(playbookUuid, playbookActionUuid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class removeActionFromPlaybookExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new PlaybookApi();
            var playbookUuid = playbookUuid_example;  // String | The playbook to remove from.
            var playbookActionUuid = playbookActionUuid_example;  // String | The playbook action to remove.
            var position = position_example;  // String | The position to remove the playbook action from. (optional) 

            try
            {
                // Removes an action from a playbook.
                apiInstance.removeActionFromPlaybook(playbookUuid, playbookActionUuid, position);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlaybookApi.removeActionFromPlaybook: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiPlaybookApi();
$playbookUuid = playbookUuid_example; // String | The playbook to remove from.
$playbookActionUuid = playbookActionUuid_example; // String | The playbook action to remove.
$position = position_example; // String | The position to remove the playbook action from.

try {
    $api_instance->removeActionFromPlaybook($playbookUuid, $playbookActionUuid, $position);
} catch (Exception $e) {
    echo 'Exception when calling PlaybookApi->removeActionFromPlaybook: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PlaybookApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::PlaybookApi->new();
my $playbookUuid = playbookUuid_example; # String | The playbook to remove from.
my $playbookActionUuid = playbookActionUuid_example; # String | The playbook action to remove.
my $position = position_example; # String | The position to remove the playbook action from.

eval { 
    $api_instance->removeActionFromPlaybook(playbookUuid => $playbookUuid, playbookActionUuid => $playbookActionUuid, position => $position);
};
if ($@) {
    warn "Exception when calling PlaybookApi->removeActionFromPlaybook: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.PlaybookApi()
playbookUuid = playbookUuid_example # String | The playbook to remove from.
playbookActionUuid = playbookActionUuid_example # String | The playbook action to remove.
position = position_example # String | The position to remove the playbook action from. (optional)

try: 
    # Removes an action from a playbook.
    api_instance.remove_action_from_playbook(playbookUuid, playbookActionUuid, position=position)
except ApiException as e:
    print("Exception when calling PlaybookApi->removeActionFromPlaybook: %s\n" % e)

Parameters

Path parameters
Name Description
playbookUuid*
String
The playbook to remove from.
Required
playbookActionUuid*
String
The playbook action to remove.
Required
Query parameters
Name Description
position
String
The position to remove the playbook action from.

Responses

Status: 204 - The action was deleted from the playbook successfully.

Status: default - Internal Server Error


removeTagFromPlaybook

Removes a tag from a playbook.


/playbook/{playbookUuid}/case-tag/{caseTagUuid}

Usage and SDK Samples

curl -X DELETE\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/playbook/{playbookUuid}/case-tag/{caseTagUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlaybookApi;

import java.io.File;
import java.util.*;

public class PlaybookApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        PlaybookApi apiInstance = new PlaybookApi();
        String playbookUuid = playbookUuid_example; // String | The playbook to remove from.
        String caseTagUuid = caseTagUuid_example; // String | The tag to remove.
        try {
            apiInstance.removeTagFromPlaybook(playbookUuid, caseTagUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaybookApi#removeTagFromPlaybook");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlaybookApi;

public class PlaybookApiExample {

    public static void main(String[] args) {
        PlaybookApi apiInstance = new PlaybookApi();
        String playbookUuid = playbookUuid_example; // String | The playbook to remove from.
        String caseTagUuid = caseTagUuid_example; // String | The tag to remove.
        try {
            apiInstance.removeTagFromPlaybook(playbookUuid, caseTagUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaybookApi#removeTagFromPlaybook");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *playbookUuid = playbookUuid_example; // The playbook to remove from.
String *caseTagUuid = caseTagUuid_example; // The tag to remove.

PlaybookApi *apiInstance = [[PlaybookApi alloc] init];

// Removes a tag from a playbook.
[apiInstance removeTagFromPlaybookWith:playbookUuid
    caseTagUuid:caseTagUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.PlaybookApi()
var playbookUuid = playbookUuid_example; // {{String}} The playbook to remove from.
var caseTagUuid = caseTagUuid_example; // {{String}} The tag to remove.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeTagFromPlaybook(playbookUuid, caseTagUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class removeTagFromPlaybookExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new PlaybookApi();
            var playbookUuid = playbookUuid_example;  // String | The playbook to remove from.
            var caseTagUuid = caseTagUuid_example;  // String | The tag to remove.

            try
            {
                // Removes a tag from a playbook.
                apiInstance.removeTagFromPlaybook(playbookUuid, caseTagUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlaybookApi.removeTagFromPlaybook: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiPlaybookApi();
$playbookUuid = playbookUuid_example; // String | The playbook to remove from.
$caseTagUuid = caseTagUuid_example; // String | The tag to remove.

try {
    $api_instance->removeTagFromPlaybook($playbookUuid, $caseTagUuid);
} catch (Exception $e) {
    echo 'Exception when calling PlaybookApi->removeTagFromPlaybook: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PlaybookApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::PlaybookApi->new();
my $playbookUuid = playbookUuid_example; # String | The playbook to remove from.
my $caseTagUuid = caseTagUuid_example; # String | The tag to remove.

eval { 
    $api_instance->removeTagFromPlaybook(playbookUuid => $playbookUuid, caseTagUuid => $caseTagUuid);
};
if ($@) {
    warn "Exception when calling PlaybookApi->removeTagFromPlaybook: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.PlaybookApi()
playbookUuid = playbookUuid_example # String | The playbook to remove from.
caseTagUuid = caseTagUuid_example # String | The tag to remove.

try: 
    # Removes a tag from a playbook.
    api_instance.remove_tag_from_playbook(playbookUuid, caseTagUuid)
except ApiException as e:
    print("Exception when calling PlaybookApi->removeTagFromPlaybook: %s\n" % e)

Parameters

Path parameters
Name Description
playbookUuid*
String
The playbook to remove from.
Required
caseTagUuid*
String
The tag to remove.
Required

Responses

Status: 204 - The resource was deleted successfully.

Status: default - Internal Server Error


updatePlaybook

Updates a playbook.


/playbook/{playbookUuid}

Usage and SDK Samples

curl -X PUT\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/playbook/{playbookUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlaybookApi;

import java.io.File;
import java.util.*;

public class PlaybookApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        PlaybookApi apiInstance = new PlaybookApi();
        PlaybookRequest body = ; // PlaybookRequest | The updated playbook
        String playbookUuid = playbookUuid_example; // String | The UUID of the playbook to update.
        try {
            apiInstance.updatePlaybook(body, playbookUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaybookApi#updatePlaybook");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlaybookApi;

public class PlaybookApiExample {

    public static void main(String[] args) {
        PlaybookApi apiInstance = new PlaybookApi();
        PlaybookRequest body = ; // PlaybookRequest | The updated playbook
        String playbookUuid = playbookUuid_example; // String | The UUID of the playbook to update.
        try {
            apiInstance.updatePlaybook(body, playbookUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaybookApi#updatePlaybook");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
PlaybookRequest *body = ; // The updated playbook
String *playbookUuid = playbookUuid_example; // The UUID of the playbook to update.

PlaybookApi *apiInstance = [[PlaybookApi alloc] init];

// Updates a playbook.
[apiInstance updatePlaybookWith:body
    playbookUuid:playbookUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.PlaybookApi()
var body = ; // {{PlaybookRequest}} The updated playbook
var playbookUuid = playbookUuid_example; // {{String}} The UUID of the playbook to update.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updatePlaybook(bodyplaybookUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updatePlaybookExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new PlaybookApi();
            var body = new PlaybookRequest(); // PlaybookRequest | The updated playbook
            var playbookUuid = playbookUuid_example;  // String | The UUID of the playbook to update.

            try
            {
                // Updates a playbook.
                apiInstance.updatePlaybook(body, playbookUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlaybookApi.updatePlaybook: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiPlaybookApi();
$body = ; // PlaybookRequest | The updated playbook
$playbookUuid = playbookUuid_example; // String | The UUID of the playbook to update.

try {
    $api_instance->updatePlaybook($body, $playbookUuid);
} catch (Exception $e) {
    echo 'Exception when calling PlaybookApi->updatePlaybook: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PlaybookApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::PlaybookApi->new();
my $body = WWW::SwaggerClient::Object::PlaybookRequest->new(); # PlaybookRequest | The updated playbook
my $playbookUuid = playbookUuid_example; # String | The UUID of the playbook to update.

eval { 
    $api_instance->updatePlaybook(body => $body, playbookUuid => $playbookUuid);
};
if ($@) {
    warn "Exception when calling PlaybookApi->updatePlaybook: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.PlaybookApi()
body =  # PlaybookRequest | The updated playbook
playbookUuid = playbookUuid_example # String | The UUID of the playbook to update.

try: 
    # Updates a playbook.
    api_instance.update_playbook(body, playbookUuid)
except ApiException as e:
    print("Exception when calling PlaybookApi->updatePlaybook: %s\n" % e)

Parameters

Path parameters
Name Description
playbookUuid*
String
The UUID of the playbook to update.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - The resource was updated successfully.

Status: default - Internal Server Error


PlaybookAction

createPlaybookAction

Creates a playbook action.


/playbook-action

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/playbook-action"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlaybookActionApi;

import java.io.File;
import java.util.*;

public class PlaybookActionApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        PlaybookActionApi apiInstance = new PlaybookActionApi();
        PlaybookActionRequest body = ; // PlaybookActionRequest | The action to add to the playbook.
        try {
            createResponse result = apiInstance.createPlaybookAction(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaybookActionApi#createPlaybookAction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlaybookActionApi;

public class PlaybookActionApiExample {

    public static void main(String[] args) {
        PlaybookActionApi apiInstance = new PlaybookActionApi();
        PlaybookActionRequest body = ; // PlaybookActionRequest | The action to add to the playbook.
        try {
            createResponse result = apiInstance.createPlaybookAction(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaybookActionApi#createPlaybookAction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
PlaybookActionRequest *body = ; // The action to add to the playbook.

PlaybookActionApi *apiInstance = [[PlaybookActionApi alloc] init];

// Creates a playbook action.
[apiInstance createPlaybookActionWith:body
              completionHandler: ^(createResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.PlaybookActionApi()
var body = ; // {{PlaybookActionRequest}} The action to add to the playbook.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createPlaybookAction(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createPlaybookActionExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new PlaybookActionApi();
            var body = new PlaybookActionRequest(); // PlaybookActionRequest | The action to add to the playbook.

            try
            {
                // Creates a playbook action.
                createResponse result = apiInstance.createPlaybookAction(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlaybookActionApi.createPlaybookAction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiPlaybookActionApi();
$body = ; // PlaybookActionRequest | The action to add to the playbook.

try {
    $result = $api_instance->createPlaybookAction($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PlaybookActionApi->createPlaybookAction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PlaybookActionApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::PlaybookActionApi->new();
my $body = WWW::SwaggerClient::Object::PlaybookActionRequest->new(); # PlaybookActionRequest | The action to add to the playbook.

eval { 
    my $result = $api_instance->createPlaybookAction(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PlaybookActionApi->createPlaybookAction: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.PlaybookActionApi()
body =  # PlaybookActionRequest | The action to add to the playbook.

try: 
    # Creates a playbook action.
    api_response = api_instance.create_playbook_action(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlaybookActionApi->createPlaybookAction: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Playbook action created successfully.

Status: default - Internal Server Error


createPlaybookActionTag

Create a playbook action tag map.


/playbook-action/{uuid}/case-tag/{tagUuid}

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/playbook-action/{uuid}/case-tag/{tagUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlaybookActionApi;

import java.io.File;
import java.util.*;

public class PlaybookActionApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        PlaybookActionApi apiInstance = new PlaybookActionApi();
        String uuid = uuid_example; // String | The UUID of the playbook action to create.
        String tagUuid = tagUuid_example; // String | The UUID of the tag to create.
        try {
            apiInstance.createPlaybookActionTag(uuid, tagUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaybookActionApi#createPlaybookActionTag");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlaybookActionApi;

public class PlaybookActionApiExample {

    public static void main(String[] args) {
        PlaybookActionApi apiInstance = new PlaybookActionApi();
        String uuid = uuid_example; // String | The UUID of the playbook action to create.
        String tagUuid = tagUuid_example; // String | The UUID of the tag to create.
        try {
            apiInstance.createPlaybookActionTag(uuid, tagUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaybookActionApi#createPlaybookActionTag");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *uuid = uuid_example; // The UUID of the playbook action to create.
String *tagUuid = tagUuid_example; // The UUID of the tag to create.

PlaybookActionApi *apiInstance = [[PlaybookActionApi alloc] init];

// Create a playbook action tag map.
[apiInstance createPlaybookActionTagWith:uuid
    tagUuid:tagUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.PlaybookActionApi()
var uuid = uuid_example; // {{String}} The UUID of the playbook action to create.
var tagUuid = tagUuid_example; // {{String}} The UUID of the tag to create.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createPlaybookActionTag(uuid, tagUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createPlaybookActionTagExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new PlaybookActionApi();
            var uuid = uuid_example;  // String | The UUID of the playbook action to create.
            var tagUuid = tagUuid_example;  // String | The UUID of the tag to create.

            try
            {
                // Create a playbook action tag map.
                apiInstance.createPlaybookActionTag(uuid, tagUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlaybookActionApi.createPlaybookActionTag: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiPlaybookActionApi();
$uuid = uuid_example; // String | The UUID of the playbook action to create.
$tagUuid = tagUuid_example; // String | The UUID of the tag to create.

try {
    $api_instance->createPlaybookActionTag($uuid, $tagUuid);
} catch (Exception $e) {
    echo 'Exception when calling PlaybookActionApi->createPlaybookActionTag: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PlaybookActionApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::PlaybookActionApi->new();
my $uuid = uuid_example; # String | The UUID of the playbook action to create.
my $tagUuid = tagUuid_example; # String | The UUID of the tag to create.

eval { 
    $api_instance->createPlaybookActionTag(uuid => $uuid, tagUuid => $tagUuid);
};
if ($@) {
    warn "Exception when calling PlaybookActionApi->createPlaybookActionTag: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.PlaybookActionApi()
uuid = uuid_example # String | The UUID of the playbook action to create.
tagUuid = tagUuid_example # String | The UUID of the tag to create.

try: 
    # Create a playbook action tag map.
    api_instance.create_playbook_action_tag(uuid, tagUuid)
except ApiException as e:
    print("Exception when calling PlaybookActionApi->createPlaybookActionTag: %s\n" % e)

Parameters

Path parameters
Name Description
uuid*
String
The UUID of the playbook action to create.
Required
tagUuid*
String
The UUID of the tag to create.
Required

Responses

Status: 200 - The resource was created successfully.

Status: default - Internal Server Error


deletePlaybookAction

Deletes a playbook action.


/playbook-action/{uuid}

Usage and SDK Samples

curl -X DELETE\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/playbook-action/{uuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlaybookActionApi;

import java.io.File;
import java.util.*;

public class PlaybookActionApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        PlaybookActionApi apiInstance = new PlaybookActionApi();
        String uuid = uuid_example; // String | The UUID of the playbook action to delete.
        try {
            apiInstance.deletePlaybookAction(uuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaybookActionApi#deletePlaybookAction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlaybookActionApi;

public class PlaybookActionApiExample {

    public static void main(String[] args) {
        PlaybookActionApi apiInstance = new PlaybookActionApi();
        String uuid = uuid_example; // String | The UUID of the playbook action to delete.
        try {
            apiInstance.deletePlaybookAction(uuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaybookActionApi#deletePlaybookAction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *uuid = uuid_example; // The UUID of the playbook action to delete.

PlaybookActionApi *apiInstance = [[PlaybookActionApi alloc] init];

// Deletes a playbook action.
[apiInstance deletePlaybookActionWith:uuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.PlaybookActionApi()
var uuid = uuid_example; // {{String}} The UUID of the playbook action to delete.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deletePlaybookAction(uuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deletePlaybookActionExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new PlaybookActionApi();
            var uuid = uuid_example;  // String | The UUID of the playbook action to delete.

            try
            {
                // Deletes a playbook action.
                apiInstance.deletePlaybookAction(uuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlaybookActionApi.deletePlaybookAction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiPlaybookActionApi();
$uuid = uuid_example; // String | The UUID of the playbook action to delete.

try {
    $api_instance->deletePlaybookAction($uuid);
} catch (Exception $e) {
    echo 'Exception when calling PlaybookActionApi->deletePlaybookAction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PlaybookActionApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::PlaybookActionApi->new();
my $uuid = uuid_example; # String | The UUID of the playbook action to delete.

eval { 
    $api_instance->deletePlaybookAction(uuid => $uuid);
};
if ($@) {
    warn "Exception when calling PlaybookActionApi->deletePlaybookAction: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.PlaybookActionApi()
uuid = uuid_example # String | The UUID of the playbook action to delete.

try: 
    # Deletes a playbook action.
    api_instance.delete_playbook_action(uuid)
except ApiException as e:
    print("Exception when calling PlaybookActionApi->deletePlaybookAction: %s\n" % e)

Parameters

Path parameters
Name Description
uuid*
String
The UUID of the playbook action to delete.
Required

Responses

Status: 204 - The resource was deleted successfully.

Status: default - Internal Server Error


deletePlaybookActionTag

Deletes a playbook action tag map.


/playbook-action/{uuid}/case-tag/{tagUuid}

Usage and SDK Samples

curl -X DELETE\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/playbook-action/{uuid}/case-tag/{tagUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlaybookActionApi;

import java.io.File;
import java.util.*;

public class PlaybookActionApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        PlaybookActionApi apiInstance = new PlaybookActionApi();
        String uuid = uuid_example; // String | The UUID of the playbook action to delete.
        String tagUuid = tagUuid_example; // String | The UUID of the tag to delete.
        try {
            apiInstance.deletePlaybookActionTag(uuid, tagUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaybookActionApi#deletePlaybookActionTag");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlaybookActionApi;

public class PlaybookActionApiExample {

    public static void main(String[] args) {
        PlaybookActionApi apiInstance = new PlaybookActionApi();
        String uuid = uuid_example; // String | The UUID of the playbook action to delete.
        String tagUuid = tagUuid_example; // String | The UUID of the tag to delete.
        try {
            apiInstance.deletePlaybookActionTag(uuid, tagUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaybookActionApi#deletePlaybookActionTag");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *uuid = uuid_example; // The UUID of the playbook action to delete.
String *tagUuid = tagUuid_example; // The UUID of the tag to delete.

PlaybookActionApi *apiInstance = [[PlaybookActionApi alloc] init];

// Deletes a playbook action tag map.
[apiInstance deletePlaybookActionTagWith:uuid
    tagUuid:tagUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.PlaybookActionApi()
var uuid = uuid_example; // {{String}} The UUID of the playbook action to delete.
var tagUuid = tagUuid_example; // {{String}} The UUID of the tag to delete.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deletePlaybookActionTag(uuid, tagUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deletePlaybookActionTagExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new PlaybookActionApi();
            var uuid = uuid_example;  // String | The UUID of the playbook action to delete.
            var tagUuid = tagUuid_example;  // String | The UUID of the tag to delete.

            try
            {
                // Deletes a playbook action tag map.
                apiInstance.deletePlaybookActionTag(uuid, tagUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlaybookActionApi.deletePlaybookActionTag: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiPlaybookActionApi();
$uuid = uuid_example; // String | The UUID of the playbook action to delete.
$tagUuid = tagUuid_example; // String | The UUID of the tag to delete.

try {
    $api_instance->deletePlaybookActionTag($uuid, $tagUuid);
} catch (Exception $e) {
    echo 'Exception when calling PlaybookActionApi->deletePlaybookActionTag: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PlaybookActionApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::PlaybookActionApi->new();
my $uuid = uuid_example; # String | The UUID of the playbook action to delete.
my $tagUuid = tagUuid_example; # String | The UUID of the tag to delete.

eval { 
    $api_instance->deletePlaybookActionTag(uuid => $uuid, tagUuid => $tagUuid);
};
if ($@) {
    warn "Exception when calling PlaybookActionApi->deletePlaybookActionTag: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.PlaybookActionApi()
uuid = uuid_example # String | The UUID of the playbook action to delete.
tagUuid = tagUuid_example # String | The UUID of the tag to delete.

try: 
    # Deletes a playbook action tag map.
    api_instance.delete_playbook_action_tag(uuid, tagUuid)
except ApiException as e:
    print("Exception when calling PlaybookActionApi->deletePlaybookActionTag: %s\n" % e)

Parameters

Path parameters
Name Description
uuid*
String
The UUID of the playbook action to delete.
Required
tagUuid*
String
The UUID of the tag to delete.
Required

Responses

Status: 204 - The resource was deleted successfully.

Status: default - Internal Server Error


getPlaybookAction

Gets a playbook action.


/playbook-action/{uuid}

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/playbook-action/{uuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlaybookActionApi;

import java.io.File;
import java.util.*;

public class PlaybookActionApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        PlaybookActionApi apiInstance = new PlaybookActionApi();
        String uuid = uuid_example; // String | The UUID of the playbook action to retrieve.
        try {
            playbookActionResponse result = apiInstance.getPlaybookAction(uuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaybookActionApi#getPlaybookAction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlaybookActionApi;

public class PlaybookActionApiExample {

    public static void main(String[] args) {
        PlaybookActionApi apiInstance = new PlaybookActionApi();
        String uuid = uuid_example; // String | The UUID of the playbook action to retrieve.
        try {
            playbookActionResponse result = apiInstance.getPlaybookAction(uuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaybookActionApi#getPlaybookAction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *uuid = uuid_example; // The UUID of the playbook action to retrieve.

PlaybookActionApi *apiInstance = [[PlaybookActionApi alloc] init];

// Gets a playbook action.
[apiInstance getPlaybookActionWith:uuid
              completionHandler: ^(playbookActionResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.PlaybookActionApi()
var uuid = uuid_example; // {{String}} The UUID of the playbook action to retrieve.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPlaybookAction(uuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPlaybookActionExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new PlaybookActionApi();
            var uuid = uuid_example;  // String | The UUID of the playbook action to retrieve.

            try
            {
                // Gets a playbook action.
                playbookActionResponse result = apiInstance.getPlaybookAction(uuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlaybookActionApi.getPlaybookAction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiPlaybookActionApi();
$uuid = uuid_example; // String | The UUID of the playbook action to retrieve.

try {
    $result = $api_instance->getPlaybookAction($uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PlaybookActionApi->getPlaybookAction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PlaybookActionApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::PlaybookActionApi->new();
my $uuid = uuid_example; # String | The UUID of the playbook action to retrieve.

eval { 
    my $result = $api_instance->getPlaybookAction(uuid => $uuid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PlaybookActionApi->getPlaybookAction: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.PlaybookActionApi()
uuid = uuid_example # String | The UUID of the playbook action to retrieve.

try: 
    # Gets a playbook action.
    api_response = api_instance.get_playbook_action(uuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlaybookActionApi->getPlaybookAction: %s\n" % e)

Parameters

Path parameters
Name Description
uuid*
String
The UUID of the playbook action to retrieve.
Required

Responses

Status: 200 - Fetched the playbook action and transmitted in the message body.

Status: default - Internal Server Error


getPlaybookActions

Gets a list of playbook actions.


/playbook-action

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/playbook-action"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlaybookActionApi;

import java.io.File;
import java.util.*;

public class PlaybookActionApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        PlaybookActionApi apiInstance = new PlaybookActionApi();
        try {
            array[playbookActionResponse] result = apiInstance.getPlaybookActions();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaybookActionApi#getPlaybookActions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlaybookActionApi;

public class PlaybookActionApiExample {

    public static void main(String[] args) {
        PlaybookActionApi apiInstance = new PlaybookActionApi();
        try {
            array[playbookActionResponse] result = apiInstance.getPlaybookActions();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaybookActionApi#getPlaybookActions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];

PlaybookActionApi *apiInstance = [[PlaybookActionApi alloc] init];

// Gets a list of playbook actions.
[apiInstance getPlaybookActionsWithCompletionHandler: 
              ^(array[playbookActionResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.PlaybookActionApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPlaybookActions(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPlaybookActionsExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new PlaybookActionApi();

            try
            {
                // Gets a list of playbook actions.
                array[playbookActionResponse] result = apiInstance.getPlaybookActions();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlaybookActionApi.getPlaybookActions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiPlaybookActionApi();

try {
    $result = $api_instance->getPlaybookActions();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PlaybookActionApi->getPlaybookActions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PlaybookActionApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::PlaybookActionApi->new();

eval { 
    my $result = $api_instance->getPlaybookActions();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PlaybookActionApi->getPlaybookActions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.PlaybookActionApi()

try: 
    # Gets a list of playbook actions.
    api_response = api_instance.get_playbook_actions()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlaybookActionApi->getPlaybookActions: %s\n" % e)

Parameters

Responses

Status: 200 - Fetched the list of playbook actions and transmitted in message body.

Status: default - Internal Server Error


updatePlaybookAction

Updates a playbook action.


/playbook-action/{uuid}

Usage and SDK Samples

curl -X PUT\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/playbook-action/{uuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlaybookActionApi;

import java.io.File;
import java.util.*;

public class PlaybookActionApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        PlaybookActionApi apiInstance = new PlaybookActionApi();
        PlaybookActionRequest body = ; // PlaybookActionRequest | The playbook action to be updated.
        String uuid = uuid_example; // String | The UUID of the playbook action to update.
        try {
            apiInstance.updatePlaybookAction(body, uuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaybookActionApi#updatePlaybookAction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlaybookActionApi;

public class PlaybookActionApiExample {

    public static void main(String[] args) {
        PlaybookActionApi apiInstance = new PlaybookActionApi();
        PlaybookActionRequest body = ; // PlaybookActionRequest | The playbook action to be updated.
        String uuid = uuid_example; // String | The UUID of the playbook action to update.
        try {
            apiInstance.updatePlaybookAction(body, uuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaybookActionApi#updatePlaybookAction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
PlaybookActionRequest *body = ; // The playbook action to be updated.
String *uuid = uuid_example; // The UUID of the playbook action to update.

PlaybookActionApi *apiInstance = [[PlaybookActionApi alloc] init];

// Updates a playbook action.
[apiInstance updatePlaybookActionWith:body
    uuid:uuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.PlaybookActionApi()
var body = ; // {{PlaybookActionRequest}} The playbook action to be updated.
var uuid = uuid_example; // {{String}} The UUID of the playbook action to update.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updatePlaybookAction(bodyuuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updatePlaybookActionExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new PlaybookActionApi();
            var body = new PlaybookActionRequest(); // PlaybookActionRequest | The playbook action to be updated.
            var uuid = uuid_example;  // String | The UUID of the playbook action to update.

            try
            {
                // Updates a playbook action.
                apiInstance.updatePlaybookAction(body, uuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlaybookActionApi.updatePlaybookAction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiPlaybookActionApi();
$body = ; // PlaybookActionRequest | The playbook action to be updated.
$uuid = uuid_example; // String | The UUID of the playbook action to update.

try {
    $api_instance->updatePlaybookAction($body, $uuid);
} catch (Exception $e) {
    echo 'Exception when calling PlaybookActionApi->updatePlaybookAction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PlaybookActionApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::PlaybookActionApi->new();
my $body = WWW::SwaggerClient::Object::PlaybookActionRequest->new(); # PlaybookActionRequest | The playbook action to be updated.
my $uuid = uuid_example; # String | The UUID of the playbook action to update.

eval { 
    $api_instance->updatePlaybookAction(body => $body, uuid => $uuid);
};
if ($@) {
    warn "Exception when calling PlaybookActionApi->updatePlaybookAction: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.PlaybookActionApi()
body =  # PlaybookActionRequest | The playbook action to be updated.
uuid = uuid_example # String | The UUID of the playbook action to update.

try: 
    # Updates a playbook action.
    api_instance.update_playbook_action(body, uuid)
except ApiException as e:
    print("Exception when calling PlaybookActionApi->updatePlaybookAction: %s\n" % e)

Parameters

Path parameters
Name Description
uuid*
String
The UUID of the playbook action to update.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - The playbook action has been updated successfully.

Status: default - Internal Server Error


Report

getAnalystReport

NOTE: THIS REPORT TYPE IS CURRENTLY DEACTIVATED AND ALL REQUESTS WILL RECEIVE A RESPONSE OF 503 - SERVICE UNAVAILABLE

Generates an analyst report for given users, over a time period.


/report/analyst/

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/report/analyst/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportApi;

import java.io.File;
import java.util.*;

public class ReportApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        ReportApi apiInstance = new ReportApi();
        AnalystReportRequest body = ; // AnalystReportRequest | 
        try {
            reportOpenCaseRecord result = apiInstance.getAnalystReport(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportApi#getAnalystReport");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReportApi;

public class ReportApiExample {

    public static void main(String[] args) {
        ReportApi apiInstance = new ReportApi();
        AnalystReportRequest body = ; // AnalystReportRequest | 
        try {
            reportOpenCaseRecord result = apiInstance.getAnalystReport(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportApi#getAnalystReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
AnalystReportRequest *body = ; // 

ReportApi *apiInstance = [[ReportApi alloc] init];

// NOTE: THIS REPORT TYPE IS CURRENTLY DEACTIVATED AND ALL REQUESTS WILL
RECEIVE A RESPONSE OF 503 - SERVICE UNAVAILABLE
[apiInstance getAnalystReportWith:body
              completionHandler: ^(reportOpenCaseRecord output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.ReportApi()
var body = ; // {{AnalystReportRequest}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAnalystReport(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAnalystReportExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new ReportApi();
            var body = new AnalystReportRequest(); // AnalystReportRequest | 

            try
            {
                // NOTE: THIS REPORT TYPE IS CURRENTLY DEACTIVATED AND ALL REQUESTS WILL
RECEIVE A RESPONSE OF 503 - SERVICE UNAVAILABLE
                reportOpenCaseRecord result = apiInstance.getAnalystReport(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportApi.getAnalystReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiReportApi();
$body = ; // AnalystReportRequest | 

try {
    $result = $api_instance->getAnalystReport($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportApi->getAnalystReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ReportApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ReportApi->new();
my $body = WWW::SwaggerClient::Object::AnalystReportRequest->new(); # AnalystReportRequest | 

eval { 
    my $result = $api_instance->getAnalystReport(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReportApi->getAnalystReport: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ReportApi()
body =  # AnalystReportRequest | 

try: 
    # NOTE: THIS REPORT TYPE IS CURRENTLY DEACTIVATED AND ALL REQUESTS WILL
RECEIVE A RESPONSE OF 503 - SERVICE UNAVAILABLE
    api_response = api_instance.get_analyst_report(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReportApi->getAnalystReport: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Report successfully generated.

Status: 404 - Requested analyst report not found or insufficient permissions to finds.

Status: 406 - Cannot find any content following the criteria given by the user.

Status: 415 - The media format of the requested data is not supported.

Status: default - Internal Server Error


getCaseDetailsReport

Generates a Case Details report for given users and additional parameters, over a time period.


/report/mttx/

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/report/mttx/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportApi;

import java.io.File;
import java.util.*;

public class ReportApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        ReportApi apiInstance = new ReportApi();
        CaseDetailsReportRequest body = ; // CaseDetailsReportRequest | 
        try {
            reportOpenCaseRecord result = apiInstance.getCaseDetailsReport(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportApi#getCaseDetailsReport");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReportApi;

public class ReportApiExample {

    public static void main(String[] args) {
        ReportApi apiInstance = new ReportApi();
        CaseDetailsReportRequest body = ; // CaseDetailsReportRequest | 
        try {
            reportOpenCaseRecord result = apiInstance.getCaseDetailsReport(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportApi#getCaseDetailsReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
CaseDetailsReportRequest *body = ; // 

ReportApi *apiInstance = [[ReportApi alloc] init];

// Generates a Case Details report for given users and additional parameters, over a time period.
[apiInstance getCaseDetailsReportWith:body
              completionHandler: ^(reportOpenCaseRecord output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.ReportApi()
var body = ; // {{CaseDetailsReportRequest}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCaseDetailsReport(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCaseDetailsReportExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new ReportApi();
            var body = new CaseDetailsReportRequest(); // CaseDetailsReportRequest | 

            try
            {
                // Generates a Case Details report for given users and additional parameters, over a time period.
                reportOpenCaseRecord result = apiInstance.getCaseDetailsReport(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportApi.getCaseDetailsReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiReportApi();
$body = ; // CaseDetailsReportRequest | 

try {
    $result = $api_instance->getCaseDetailsReport($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportApi->getCaseDetailsReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ReportApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ReportApi->new();
my $body = WWW::SwaggerClient::Object::CaseDetailsReportRequest->new(); # CaseDetailsReportRequest | 

eval { 
    my $result = $api_instance->getCaseDetailsReport(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReportApi->getCaseDetailsReport: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ReportApi()
body =  # CaseDetailsReportRequest | 

try: 
    # Generates a Case Details report for given users and additional parameters, over a time period.
    api_response = api_instance.get_case_details_report(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReportApi->getCaseDetailsReport: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Report successfully generated.

Status: 400 - Uuid does not represent a valid UUID.

Status: 404 - Requested Case Details report not found or insufficient permissions to finds.

Status: 406 - Cannot find any content following the criteria given by the user.

Status: 415 - The format of the requested data is not supported.

Status: default - Internal Server Error


getCaseReport

Generates a report for a given case.


/report/case/{caseUuid}

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/report/case/{caseUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportApi;

import java.io.File;
import java.util.*;

public class ReportApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        ReportApi apiInstance = new ReportApi();
        CaseReportRequest body = ; // CaseReportRequest | 
        String caseUuid = caseUuid_example; // String | The UUID of the case to generate a report for.
        try {
            reportOpenCaseRecord result = apiInstance.getCaseReport(body, caseUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportApi#getCaseReport");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReportApi;

public class ReportApiExample {

    public static void main(String[] args) {
        ReportApi apiInstance = new ReportApi();
        CaseReportRequest body = ; // CaseReportRequest | 
        String caseUuid = caseUuid_example; // String | The UUID of the case to generate a report for.
        try {
            reportOpenCaseRecord result = apiInstance.getCaseReport(body, caseUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportApi#getCaseReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
CaseReportRequest *body = ; // 
String *caseUuid = caseUuid_example; // The UUID of the case to generate a report for.

ReportApi *apiInstance = [[ReportApi alloc] init];

// Generates a report for a given case.
[apiInstance getCaseReportWith:body
    caseUuid:caseUuid
              completionHandler: ^(reportOpenCaseRecord output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.ReportApi()
var body = ; // {{CaseReportRequest}} 
var caseUuid = caseUuid_example; // {{String}} The UUID of the case to generate a report for.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCaseReport(bodycaseUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCaseReportExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new ReportApi();
            var body = new CaseReportRequest(); // CaseReportRequest | 
            var caseUuid = caseUuid_example;  // String | The UUID of the case to generate a report for.

            try
            {
                // Generates a report for a given case.
                reportOpenCaseRecord result = apiInstance.getCaseReport(body, caseUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportApi.getCaseReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiReportApi();
$body = ; // CaseReportRequest | 
$caseUuid = caseUuid_example; // String | The UUID of the case to generate a report for.

try {
    $result = $api_instance->getCaseReport($body, $caseUuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportApi->getCaseReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ReportApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ReportApi->new();
my $body = WWW::SwaggerClient::Object::CaseReportRequest->new(); # CaseReportRequest | 
my $caseUuid = caseUuid_example; # String | The UUID of the case to generate a report for.

eval { 
    my $result = $api_instance->getCaseReport(body => $body, caseUuid => $caseUuid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReportApi->getCaseReport: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ReportApi()
body =  # CaseReportRequest | 
caseUuid = caseUuid_example # String | The UUID of the case to generate a report for.

try: 
    # Generates a report for a given case.
    api_response = api_instance.get_case_report(body, caseUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReportApi->getCaseReport: %s\n" % e)

Parameters

Path parameters
Name Description
caseUuid*
String
The UUID of the case to generate a report for.
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Fetched the report for the given case and transmitted in the message body.

Status: default - Internal Server Error


getGroupReport

Generates a summary of current groups.


/report/group

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/report/group"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportApi;

import java.io.File;
import java.util.*;

public class ReportApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        ReportApi apiInstance = new ReportApi();
        try {
            apiInstance.getGroupReport();
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportApi#getGroupReport");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReportApi;

public class ReportApiExample {

    public static void main(String[] args) {
        ReportApi apiInstance = new ReportApi();
        try {
            apiInstance.getGroupReport();
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportApi#getGroupReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];

ReportApi *apiInstance = [[ReportApi alloc] init];

// Generates a summary of current groups.
[apiInstance getGroupReportWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.ReportApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getGroupReport(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getGroupReportExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new ReportApi();

            try
            {
                // Generates a summary of current groups.
                apiInstance.getGroupReport();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportApi.getGroupReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiReportApi();

try {
    $api_instance->getGroupReport();
} catch (Exception $e) {
    echo 'Exception when calling ReportApi->getGroupReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ReportApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ReportApi->new();

eval { 
    $api_instance->getGroupReport();
};
if ($@) {
    warn "Exception when calling ReportApi->getGroupReport: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ReportApi()

try: 
    # Generates a summary of current groups.
    api_instance.get_group_report()
except ApiException as e:
    print("Exception when calling ReportApi->getGroupReport: %s\n" % e)

Parameters

Responses

Status: 201 - Report successfully generated.

Status: 404 - Requested group report not found or insufficient permissions to find.

Status: 406 - Cannot find any content following the criteria given by the user.

Status: 415 - The media format of the requested data is not supported.

Status: default - Internal Server Error


getHeatMapReport

Generates an heatmap report for given tag frequencies together on a case, over a time period.


/report/heatmap/

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/report/heatmap/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportApi;

import java.io.File;
import java.util.*;

public class ReportApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        ReportApi apiInstance = new ReportApi();
        HeatmapReportRequest body = ; // HeatmapReportRequest | 
        try {
            heatmapReportRequest result = apiInstance.getHeatMapReport(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportApi#getHeatMapReport");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReportApi;

public class ReportApiExample {

    public static void main(String[] args) {
        ReportApi apiInstance = new ReportApi();
        HeatmapReportRequest body = ; // HeatmapReportRequest | 
        try {
            heatmapReportRequest result = apiInstance.getHeatMapReport(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportApi#getHeatMapReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
HeatmapReportRequest *body = ; // 

ReportApi *apiInstance = [[ReportApi alloc] init];

// Generates an heatmap report for given tag frequencies together on a case, over a time period.
[apiInstance getHeatMapReportWith:body
              completionHandler: ^(heatmapReportRequest output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.ReportApi()
var body = ; // {{HeatmapReportRequest}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getHeatMapReport(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getHeatMapReportExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new ReportApi();
            var body = new HeatmapReportRequest(); // HeatmapReportRequest | 

            try
            {
                // Generates an heatmap report for given tag frequencies together on a case, over a time period.
                heatmapReportRequest result = apiInstance.getHeatMapReport(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportApi.getHeatMapReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiReportApi();
$body = ; // HeatmapReportRequest | 

try {
    $result = $api_instance->getHeatMapReport($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportApi->getHeatMapReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ReportApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ReportApi->new();
my $body = WWW::SwaggerClient::Object::HeatmapReportRequest->new(); # HeatmapReportRequest | 

eval { 
    my $result = $api_instance->getHeatMapReport(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReportApi->getHeatMapReport: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ReportApi()
body =  # HeatmapReportRequest | 

try: 
    # Generates an heatmap report for given tag frequencies together on a case, over a time period.
    api_response = api_instance.get_heat_map_report(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReportApi->getHeatMapReport: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Report successfully generated.

Status: 404 - Requested heatmap report not found.

Status: default - Internal Server Error


getSummaryReport

Generates a summary report for a given organisation, over a time period.


/report/summary/

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: docx,markdown"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/report/summary/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportApi;

import java.io.File;
import java.util.*;

public class ReportApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        ReportApi apiInstance = new ReportApi();
        CaseSummaryReportRequest body = ; // CaseSummaryReportRequest | 
        try {
            reportOpenCaseRecord result = apiInstance.getSummaryReport(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportApi#getSummaryReport");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReportApi;

public class ReportApiExample {

    public static void main(String[] args) {
        ReportApi apiInstance = new ReportApi();
        CaseSummaryReportRequest body = ; // CaseSummaryReportRequest | 
        try {
            reportOpenCaseRecord result = apiInstance.getSummaryReport(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportApi#getSummaryReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
CaseSummaryReportRequest *body = ; // 

ReportApi *apiInstance = [[ReportApi alloc] init];

// Generates a summary report for a given organisation, over a time period.
[apiInstance getSummaryReportWith:body
              completionHandler: ^(reportOpenCaseRecord output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.ReportApi()
var body = ; // {{CaseSummaryReportRequest}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSummaryReport(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSummaryReportExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new ReportApi();
            var body = new CaseSummaryReportRequest(); // CaseSummaryReportRequest | 

            try
            {
                // Generates a summary report for a given organisation, over a time period.
                reportOpenCaseRecord result = apiInstance.getSummaryReport(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportApi.getSummaryReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiReportApi();
$body = ; // CaseSummaryReportRequest | 

try {
    $result = $api_instance->getSummaryReport($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportApi->getSummaryReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ReportApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ReportApi->new();
my $body = WWW::SwaggerClient::Object::CaseSummaryReportRequest->new(); # CaseSummaryReportRequest | 

eval { 
    my $result = $api_instance->getSummaryReport(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReportApi->getSummaryReport: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ReportApi()
body =  # CaseSummaryReportRequest | 

try: 
    # Generates a summary report for a given organisation, over a time period.
    api_response = api_instance.get_summary_report(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReportApi->getSummaryReport: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Report successfully generated.

Status: 400 - Bad request, invalid request data

Status: 404 - Requested summary report not found or insufficient permissions to finds.

Status: 406 - Cannot find any content following the criteria given by the user.

Status: 415 - The media format of the requested data is not supported.

Status: default - Internal Server Error


getTimeToStateReport

Generates a report for time taken for cases to arrive at a given state.


/metrics/time-to-state

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/metrics/time-to-state"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportApi;

import java.io.File;
import java.util.*;

public class ReportApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        ReportApi apiInstance = new ReportApi();
        TimeToStateMetricsRequest body = ; // TimeToStateMetricsRequest | 
        try {
            array[timeToStateMetrics] result = apiInstance.getTimeToStateReport(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportApi#getTimeToStateReport");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReportApi;

public class ReportApiExample {

    public static void main(String[] args) {
        ReportApi apiInstance = new ReportApi();
        TimeToStateMetricsRequest body = ; // TimeToStateMetricsRequest | 
        try {
            array[timeToStateMetrics] result = apiInstance.getTimeToStateReport(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportApi#getTimeToStateReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
TimeToStateMetricsRequest *body = ; // 

ReportApi *apiInstance = [[ReportApi alloc] init];

// Generates a report for time taken for cases to arrive at a given state.
[apiInstance getTimeToStateReportWith:body
              completionHandler: ^(array[timeToStateMetrics] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.ReportApi()
var body = ; // {{TimeToStateMetricsRequest}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTimeToStateReport(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTimeToStateReportExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new ReportApi();
            var body = new TimeToStateMetricsRequest(); // TimeToStateMetricsRequest | 

            try
            {
                // Generates a report for time taken for cases to arrive at a given state.
                array[timeToStateMetrics] result = apiInstance.getTimeToStateReport(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportApi.getTimeToStateReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiReportApi();
$body = ; // TimeToStateMetricsRequest | 

try {
    $result = $api_instance->getTimeToStateReport($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportApi->getTimeToStateReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ReportApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ReportApi->new();
my $body = WWW::SwaggerClient::Object::TimeToStateMetricsRequest->new(); # TimeToStateMetricsRequest | 

eval { 
    my $result = $api_instance->getTimeToStateReport(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReportApi->getTimeToStateReport: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ReportApi()
body =  # TimeToStateMetricsRequest | 

try: 
    # Generates a report for time taken for cases to arrive at a given state.
    api_response = api_instance.get_time_to_state_report(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReportApi->getTimeToStateReport: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - Report successfully generated.

Status: default - Internal Server Error


getUserReport

Generates a summary of current user accounts.


/report/user

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/report/user"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportApi;

import java.io.File;
import java.util.*;

public class ReportApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        ReportApi apiInstance = new ReportApi();
        try {
            apiInstance.getUserReport();
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportApi#getUserReport");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReportApi;

public class ReportApiExample {

    public static void main(String[] args) {
        ReportApi apiInstance = new ReportApi();
        try {
            apiInstance.getUserReport();
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportApi#getUserReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];

ReportApi *apiInstance = [[ReportApi alloc] init];

// Generates a summary of current user accounts.
[apiInstance getUserReportWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.ReportApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getUserReport(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getUserReportExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new ReportApi();

            try
            {
                // Generates a summary of current user accounts.
                apiInstance.getUserReport();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportApi.getUserReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiReportApi();

try {
    $api_instance->getUserReport();
} catch (Exception $e) {
    echo 'Exception when calling ReportApi->getUserReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ReportApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ReportApi->new();

eval { 
    $api_instance->getUserReport();
};
if ($@) {
    warn "Exception when calling ReportApi->getUserReport: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ReportApi()

try: 
    # Generates a summary of current user accounts.
    api_instance.get_user_report()
except ApiException as e:
    print("Exception when calling ReportApi->getUserReport: %s\n" % e)

Parameters

Responses

Status: 201 - Report successfully generated.

Status: 404 - Requested user report not found or insufficient permissions to find.

Status: 406 - Cannot find any content following the criteria given by the user.

Status: 415 - The media format of the requested data is not supported.

Status: default - Internal Server Error


Sla

createSla

Creates an SLAs


/sla

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/sla"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SlaApi;

import java.io.File;
import java.util.*;

public class SlaApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        SlaApi apiInstance = new SlaApi();
        Sla body = ; // Sla | The SLA to create.
        try {
            sla result = apiInstance.createSla(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SlaApi#createSla");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SlaApi;

public class SlaApiExample {

    public static void main(String[] args) {
        SlaApi apiInstance = new SlaApi();
        Sla body = ; // Sla | The SLA to create.
        try {
            sla result = apiInstance.createSla(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SlaApi#createSla");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
Sla *body = ; // The SLA to create.

SlaApi *apiInstance = [[SlaApi alloc] init];

[apiInstance createSlaWith:body
              completionHandler: ^(sla output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.SlaApi()
var body = ; // {{Sla}} The SLA to create.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createSla(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createSlaExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new SlaApi();
            var body = new Sla(); // Sla | The SLA to create.

            try
            {
                sla result = apiInstance.createSla(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SlaApi.createSla: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiSlaApi();
$body = ; // Sla | The SLA to create.

try {
    $result = $api_instance->createSla($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SlaApi->createSla: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SlaApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::SlaApi->new();
my $body = WWW::SwaggerClient::Object::Sla->new(); # Sla | The SLA to create.

eval { 
    my $result = $api_instance->createSla(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SlaApi->createSla: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.SlaApi()
body =  # Sla | The SLA to create.

try: 
    api_response = api_instance.create_sla(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SlaApi->createSla: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - SLA has been created successfully.

Status: 401 - Invalid authentication for this request.

Status: 403 - Invalid authorization for this request.

Status: default - Internal Server Error


deleteSla

Deletes an SLA.


/sla/{slaUuid}

Usage and SDK Samples

curl -X DELETE\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/sla/{slaUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SlaApi;

import java.io.File;
import java.util.*;

public class SlaApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        SlaApi apiInstance = new SlaApi();
        String slaUuid = slaUuid_example; // String | The UUID of the SLA to delete.
        try {
            apiInstance.deleteSla(slaUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling SlaApi#deleteSla");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SlaApi;

public class SlaApiExample {

    public static void main(String[] args) {
        SlaApi apiInstance = new SlaApi();
        String slaUuid = slaUuid_example; // String | The UUID of the SLA to delete.
        try {
            apiInstance.deleteSla(slaUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling SlaApi#deleteSla");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *slaUuid = slaUuid_example; // The UUID of the SLA to delete.

SlaApi *apiInstance = [[SlaApi alloc] init];

// Deletes an SLA.
[apiInstance deleteSlaWith:slaUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.SlaApi()
var slaUuid = slaUuid_example; // {{String}} The UUID of the SLA to delete.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteSla(slaUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteSlaExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new SlaApi();
            var slaUuid = slaUuid_example;  // String | The UUID of the SLA to delete.

            try
            {
                // Deletes an SLA.
                apiInstance.deleteSla(slaUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SlaApi.deleteSla: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiSlaApi();
$slaUuid = slaUuid_example; // String | The UUID of the SLA to delete.

try {
    $api_instance->deleteSla($slaUuid);
} catch (Exception $e) {
    echo 'Exception when calling SlaApi->deleteSla: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SlaApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::SlaApi->new();
my $slaUuid = slaUuid_example; # String | The UUID of the SLA to delete.

eval { 
    $api_instance->deleteSla(slaUuid => $slaUuid);
};
if ($@) {
    warn "Exception when calling SlaApi->deleteSla: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.SlaApi()
slaUuid = slaUuid_example # String | The UUID of the SLA to delete.

try: 
    # Deletes an SLA.
    api_instance.delete_sla(slaUuid)
except ApiException as e:
    print("Exception when calling SlaApi->deleteSla: %s\n" % e)

Parameters

Path parameters
Name Description
slaUuid*
String
The UUID of the SLA to delete.
Required

Responses

Status: 204 - Successfully deleted the SLA.

Status: 401 - Invalid authentication for this request.

Status: 403 - Invalid authorization for this request.

Status: default - Internal Server Error


getCaseSlaWarnings

Gets a list of SLA warnings for a case.


/case/{caseUuid}/sla-warning

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/case/{caseUuid}/sla-warning"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SlaApi;

import java.io.File;
import java.util.*;

public class SlaApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        SlaApi apiInstance = new SlaApi();
        String caseUuid = caseUuid_example; // String | The UUID of the case.
        try {
            array[sla] result = apiInstance.getCaseSlaWarnings(caseUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SlaApi#getCaseSlaWarnings");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SlaApi;

public class SlaApiExample {

    public static void main(String[] args) {
        SlaApi apiInstance = new SlaApi();
        String caseUuid = caseUuid_example; // String | The UUID of the case.
        try {
            array[sla] result = apiInstance.getCaseSlaWarnings(caseUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SlaApi#getCaseSlaWarnings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *caseUuid = caseUuid_example; // The UUID of the case.

SlaApi *apiInstance = [[SlaApi alloc] init];

// Gets a list of SLA warnings for a case.
[apiInstance getCaseSlaWarningsWith:caseUuid
              completionHandler: ^(array[sla] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.SlaApi()
var caseUuid = caseUuid_example; // {{String}} The UUID of the case.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCaseSlaWarnings(caseUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCaseSlaWarningsExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new SlaApi();
            var caseUuid = caseUuid_example;  // String | The UUID of the case.

            try
            {
                // Gets a list of SLA warnings for a case.
                array[sla] result = apiInstance.getCaseSlaWarnings(caseUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SlaApi.getCaseSlaWarnings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiSlaApi();
$caseUuid = caseUuid_example; // String | The UUID of the case.

try {
    $result = $api_instance->getCaseSlaWarnings($caseUuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SlaApi->getCaseSlaWarnings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SlaApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::SlaApi->new();
my $caseUuid = caseUuid_example; # String | The UUID of the case.

eval { 
    my $result = $api_instance->getCaseSlaWarnings(caseUuid => $caseUuid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SlaApi->getCaseSlaWarnings: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.SlaApi()
caseUuid = caseUuid_example # String | The UUID of the case.

try: 
    # Gets a list of SLA warnings for a case.
    api_response = api_instance.get_case_sla_warnings(caseUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SlaApi->getCaseSlaWarnings: %s\n" % e)

Parameters

Path parameters
Name Description
caseUuid*
String
The UUID of the case.
Required

Responses

Status: 200 - Fetched the list of SLA warnings and transmitted in the message body.

Status: 401 - Invalid authentication for this request.

Status: 403 - Invalid authorization for this request.

Status: default - Internal Server Error


getCaseSlas

Gets a list of SLAs for a case.


/case/{caseUuid}/sla

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/case/{caseUuid}/sla"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SlaApi;

import java.io.File;
import java.util.*;

public class SlaApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        SlaApi apiInstance = new SlaApi();
        String caseUuid = caseUuid_example; // String | The UUID of the case.
        try {
            array[sla] result = apiInstance.getCaseSlas(caseUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SlaApi#getCaseSlas");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SlaApi;

public class SlaApiExample {

    public static void main(String[] args) {
        SlaApi apiInstance = new SlaApi();
        String caseUuid = caseUuid_example; // String | The UUID of the case.
        try {
            array[sla] result = apiInstance.getCaseSlas(caseUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SlaApi#getCaseSlas");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *caseUuid = caseUuid_example; // The UUID of the case.

SlaApi *apiInstance = [[SlaApi alloc] init];

// Gets a list of SLAs for a case.
[apiInstance getCaseSlasWith:caseUuid
              completionHandler: ^(array[sla] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.SlaApi()
var caseUuid = caseUuid_example; // {{String}} The UUID of the case.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCaseSlas(caseUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCaseSlasExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new SlaApi();
            var caseUuid = caseUuid_example;  // String | The UUID of the case.

            try
            {
                // Gets a list of SLAs for a case.
                array[sla] result = apiInstance.getCaseSlas(caseUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SlaApi.getCaseSlas: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiSlaApi();
$caseUuid = caseUuid_example; // String | The UUID of the case.

try {
    $result = $api_instance->getCaseSlas($caseUuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SlaApi->getCaseSlas: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SlaApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::SlaApi->new();
my $caseUuid = caseUuid_example; # String | The UUID of the case.

eval { 
    my $result = $api_instance->getCaseSlas(caseUuid => $caseUuid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SlaApi->getCaseSlas: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.SlaApi()
caseUuid = caseUuid_example # String | The UUID of the case.

try: 
    # Gets a list of SLAs for a case.
    api_response = api_instance.get_case_slas(caseUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SlaApi->getCaseSlas: %s\n" % e)

Parameters

Path parameters
Name Description
caseUuid*
String
The UUID of the case.
Required

Responses

Status: 200 - Fetched the list of SLAs and transmitted in the message body.

Status: 401 - Invalid authentication for this request.

Status: 403 - Invalid authorization for this request.

Status: default - Internal Server Error


getSlas

Gets a list of SLAs.


/sla

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/sla?org="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SlaApi;

import java.io.File;
import java.util.*;

public class SlaApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        SlaApi apiInstance = new SlaApi();
        String org = org_example; // String | If set, filter by organisation UUID.
        try {
            array[sla] result = apiInstance.getSlas(org);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SlaApi#getSlas");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SlaApi;

public class SlaApiExample {

    public static void main(String[] args) {
        SlaApi apiInstance = new SlaApi();
        String org = org_example; // String | If set, filter by organisation UUID.
        try {
            array[sla] result = apiInstance.getSlas(org);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SlaApi#getSlas");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *org = org_example; // If set, filter by organisation UUID. (optional)

SlaApi *apiInstance = [[SlaApi alloc] init];

// Gets a list of SLAs.
[apiInstance getSlasWith:org
              completionHandler: ^(array[sla] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.SlaApi()
var opts = { 
  'org': org_example // {{String}} If set, filter by organisation UUID.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSlas(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSlasExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new SlaApi();
            var org = org_example;  // String | If set, filter by organisation UUID. (optional) 

            try
            {
                // Gets a list of SLAs.
                array[sla] result = apiInstance.getSlas(org);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SlaApi.getSlas: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiSlaApi();
$org = org_example; // String | If set, filter by organisation UUID.

try {
    $result = $api_instance->getSlas($org);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SlaApi->getSlas: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SlaApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::SlaApi->new();
my $org = org_example; # String | If set, filter by organisation UUID.

eval { 
    my $result = $api_instance->getSlas(org => $org);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SlaApi->getSlas: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.SlaApi()
org = org_example # String | If set, filter by organisation UUID. (optional)

try: 
    # Gets a list of SLAs.
    api_response = api_instance.get_slas(org=org)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SlaApi->getSlas: %s\n" % e)

Parameters

Query parameters
Name Description
org
String
If set, filter by organisation UUID.

Responses

Status: 200 - Fetched the list of SLAs and transmitted in the message body.

Status: 401 - Invalid authentication for this request.

Status: 403 - Invalid authorization for this request.

Status: default - Internal Server Error


updateSla

Updates an SLA.


/sla/{slaUuid}

Usage and SDK Samples

curl -X PUT\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/sla/{slaUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SlaApi;

import java.io.File;
import java.util.*;

public class SlaApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        SlaApi apiInstance = new SlaApi();
        Sla body = ; // Sla | The SLA to update.
        String slaUuid = slaUuid_example; // String | The UUID of the SLA to update.
        try {
            apiInstance.updateSla(body, slaUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling SlaApi#updateSla");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SlaApi;

public class SlaApiExample {

    public static void main(String[] args) {
        SlaApi apiInstance = new SlaApi();
        Sla body = ; // Sla | The SLA to update.
        String slaUuid = slaUuid_example; // String | The UUID of the SLA to update.
        try {
            apiInstance.updateSla(body, slaUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling SlaApi#updateSla");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
Sla *body = ; // The SLA to update.
String *slaUuid = slaUuid_example; // The UUID of the SLA to update.

SlaApi *apiInstance = [[SlaApi alloc] init];

// Updates an SLA.
[apiInstance updateSlaWith:body
    slaUuid:slaUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.SlaApi()
var body = ; // {{Sla}} The SLA to update.
var slaUuid = slaUuid_example; // {{String}} The UUID of the SLA to update.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateSla(bodyslaUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateSlaExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new SlaApi();
            var body = new Sla(); // Sla | The SLA to update.
            var slaUuid = slaUuid_example;  // String | The UUID of the SLA to update.

            try
            {
                // Updates an SLA.
                apiInstance.updateSla(body, slaUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SlaApi.updateSla: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiSlaApi();
$body = ; // Sla | The SLA to update.
$slaUuid = slaUuid_example; // String | The UUID of the SLA to update.

try {
    $api_instance->updateSla($body, $slaUuid);
} catch (Exception $e) {
    echo 'Exception when calling SlaApi->updateSla: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SlaApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::SlaApi->new();
my $body = WWW::SwaggerClient::Object::Sla->new(); # Sla | The SLA to update.
my $slaUuid = slaUuid_example; # String | The UUID of the SLA to update.

eval { 
    $api_instance->updateSla(body => $body, slaUuid => $slaUuid);
};
if ($@) {
    warn "Exception when calling SlaApi->updateSla: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.SlaApi()
body =  # Sla | The SLA to update.
slaUuid = slaUuid_example # String | The UUID of the SLA to update.

try: 
    # Updates an SLA.
    api_instance.update_sla(body, slaUuid)
except ApiException as e:
    print("Exception when calling SlaApi->updateSla: %s\n" % e)

Parameters

Path parameters
Name Description
slaUuid*
String
The UUID of the SLA to update.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - Successfully updated the SLA.

Status: 401 - Invalid authentication for this request.

Status: 403 - Invalid authorization for this request.

Status: default - Internal Server Error


Stix

createAsset

Creates a asset in STIX.


/stix/asset

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/stix/asset"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StixApi;

import java.io.File;
import java.util.*;

public class StixApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        StixApi apiInstance = new StixApi();
        CreateAssetRequest body = ; // CreateAssetRequest | The asset to create.
        try {
            createResponse result = apiInstance.createAsset(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StixApi#createAsset");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StixApi;

public class StixApiExample {

    public static void main(String[] args) {
        StixApi apiInstance = new StixApi();
        CreateAssetRequest body = ; // CreateAssetRequest | The asset to create.
        try {
            createResponse result = apiInstance.createAsset(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StixApi#createAsset");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
CreateAssetRequest *body = ; // The asset to create.

StixApi *apiInstance = [[StixApi alloc] init];

// Creates a asset in STIX.
[apiInstance createAssetWith:body
              completionHandler: ^(createResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.StixApi()
var body = ; // {{CreateAssetRequest}} The asset to create.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAsset(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createAssetExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new StixApi();
            var body = new CreateAssetRequest(); // CreateAssetRequest | The asset to create.

            try
            {
                // Creates a asset in STIX.
                createResponse result = apiInstance.createAsset(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StixApi.createAsset: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiStixApi();
$body = ; // CreateAssetRequest | The asset to create.

try {
    $result = $api_instance->createAsset($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StixApi->createAsset: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StixApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::StixApi->new();
my $body = WWW::SwaggerClient::Object::CreateAssetRequest->new(); # CreateAssetRequest | The asset to create.

eval { 
    my $result = $api_instance->createAsset(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StixApi->createAsset: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.StixApi()
body =  # CreateAssetRequest | The asset to create.

try: 
    # Creates a asset in STIX.
    api_response = api_instance.create_asset(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StixApi->createAsset: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - asset has been created successfully.

Status: 401 - Invalid authentication for this request.

Status: 403 - The request does not have authorisation.

Status: default - Internal Server Error


createAssetsFromCsv

Creates assets in STIX.

CSV requires a header row in the following order: Type, Name, Email, Phone, Organisation


/stix/asset/bulk

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: text/csv"\
"http://localhost/cydarm-api/stix/asset/bulk"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StixApi;

import java.io.File;
import java.util.*;

public class StixApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        StixApi apiInstance = new StixApi();
        Object body = ; // Object | CSV file with a list of assets to create.
        try {
            createObjectResponse result = apiInstance.createAssetsFromCsv(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StixApi#createAssetsFromCsv");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StixApi;

public class StixApiExample {

    public static void main(String[] args) {
        StixApi apiInstance = new StixApi();
        Object body = ; // Object | CSV file with a list of assets to create.
        try {
            createObjectResponse result = apiInstance.createAssetsFromCsv(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StixApi#createAssetsFromCsv");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
Object *body = ; // CSV file with a list of assets to create.

StixApi *apiInstance = [[StixApi alloc] init];

// Creates assets in STIX.
[apiInstance createAssetsFromCsvWith:body
              completionHandler: ^(createObjectResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.StixApi()
var body = ; // {{Object}} CSV file with a list of assets to create.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAssetsFromCsv(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createAssetsFromCsvExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new StixApi();
            var body = new Object(); // Object | CSV file with a list of assets to create.

            try
            {
                // Creates assets in STIX.
                createObjectResponse result = apiInstance.createAssetsFromCsv(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StixApi.createAssetsFromCsv: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiStixApi();
$body = ; // Object | CSV file with a list of assets to create.

try {
    $result = $api_instance->createAssetsFromCsv($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StixApi->createAssetsFromCsv: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StixApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::StixApi->new();
my $body = WWW::SwaggerClient::Object::Object->new(); # Object | CSV file with a list of assets to create.

eval { 
    my $result = $api_instance->createAssetsFromCsv(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StixApi->createAssetsFromCsv: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.StixApi()
body =  # Object | CSV file with a list of assets to create.

try: 
    # Creates assets in STIX.
    api_response = api_instance.create_assets_from_csv(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StixApi->createAssetsFromCsv: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Assets have been created.

Status: 400 - Bad request

Status: 401 - Invalid authentication for this request.

Status: 403 - The request does not have authorisation.

Status: default - Internal Server Error


createContact

Creates a contact in STIX.


/stix/contact

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/stix/contact"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StixApi;

import java.io.File;
import java.util.*;

public class StixApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        StixApi apiInstance = new StixApi();
        CreateContactRequest body = ; // CreateContactRequest | The contact to create.
        try {
            createResponse result = apiInstance.createContact(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StixApi#createContact");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StixApi;

public class StixApiExample {

    public static void main(String[] args) {
        StixApi apiInstance = new StixApi();
        CreateContactRequest body = ; // CreateContactRequest | The contact to create.
        try {
            createResponse result = apiInstance.createContact(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StixApi#createContact");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
CreateContactRequest *body = ; // The contact to create.

StixApi *apiInstance = [[StixApi alloc] init];

// Creates a contact in STIX.
[apiInstance createContactWith:body
              completionHandler: ^(createResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.StixApi()
var body = ; // {{CreateContactRequest}} The contact to create.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createContact(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createContactExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new StixApi();
            var body = new CreateContactRequest(); // CreateContactRequest | The contact to create.

            try
            {
                // Creates a contact in STIX.
                createResponse result = apiInstance.createContact(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StixApi.createContact: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiStixApi();
$body = ; // CreateContactRequest | The contact to create.

try {
    $result = $api_instance->createContact($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StixApi->createContact: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StixApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::StixApi->new();
my $body = WWW::SwaggerClient::Object::CreateContactRequest->new(); # CreateContactRequest | The contact to create.

eval { 
    my $result = $api_instance->createContact(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StixApi->createContact: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.StixApi()
body =  # CreateContactRequest | The contact to create.

try: 
    # Creates a contact in STIX.
    api_response = api_instance.create_contact(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StixApi->createContact: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - contact has been created successfully.

Status: 401 - Invalid authentication for this request.


createContactsFromCsv

Creates contacts in STIX.

CSV requires a header row in the following order: Type, Name, Email, Phone, Organisation


/stix/contact/bulk

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: text/csv"\
"http://localhost/cydarm-api/stix/contact/bulk"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StixApi;

import java.io.File;
import java.util.*;

public class StixApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        StixApi apiInstance = new StixApi();
        Object body = ; // Object | CSV file with a list of contacts to create.
        try {
            createObjectResponse result = apiInstance.createContactsFromCsv(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StixApi#createContactsFromCsv");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StixApi;

public class StixApiExample {

    public static void main(String[] args) {
        StixApi apiInstance = new StixApi();
        Object body = ; // Object | CSV file with a list of contacts to create.
        try {
            createObjectResponse result = apiInstance.createContactsFromCsv(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StixApi#createContactsFromCsv");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
Object *body = ; // CSV file with a list of contacts to create.

StixApi *apiInstance = [[StixApi alloc] init];

// Creates contacts in STIX.
[apiInstance createContactsFromCsvWith:body
              completionHandler: ^(createObjectResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.StixApi()
var body = ; // {{Object}} CSV file with a list of contacts to create.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createContactsFromCsv(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createContactsFromCsvExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new StixApi();
            var body = new Object(); // Object | CSV file with a list of contacts to create.

            try
            {
                // Creates contacts in STIX.
                createObjectResponse result = apiInstance.createContactsFromCsv(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StixApi.createContactsFromCsv: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiStixApi();
$body = ; // Object | CSV file with a list of contacts to create.

try {
    $result = $api_instance->createContactsFromCsv($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StixApi->createContactsFromCsv: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StixApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::StixApi->new();
my $body = WWW::SwaggerClient::Object::Object->new(); # Object | CSV file with a list of contacts to create.

eval { 
    my $result = $api_instance->createContactsFromCsv(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StixApi->createContactsFromCsv: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.StixApi()
body =  # Object | CSV file with a list of contacts to create.

try: 
    # Creates contacts in STIX.
    api_response = api_instance.create_contacts_from_csv(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StixApi->createContactsFromCsv: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Contacts have been created.

Status: 400 - Bad request

Status: 401 - Invalid authentication for this request.

Status: 403 - The request does not have authorisation.

Status: default - Internal Server Error


deleteAsset

Deletes a asset.


/stix/asset/{assetUuid}

Usage and SDK Samples

curl -X DELETE\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/stix/asset/{assetUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StixApi;

import java.io.File;
import java.util.*;

public class StixApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        StixApi apiInstance = new StixApi();
        String assetUuid = assetUuid_example; // String | The UUID of the asset object to delete.
        try {
            apiInstance.deleteAsset(assetUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling StixApi#deleteAsset");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StixApi;

public class StixApiExample {

    public static void main(String[] args) {
        StixApi apiInstance = new StixApi();
        String assetUuid = assetUuid_example; // String | The UUID of the asset object to delete.
        try {
            apiInstance.deleteAsset(assetUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling StixApi#deleteAsset");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *assetUuid = assetUuid_example; // The UUID of the asset object to delete.

StixApi *apiInstance = [[StixApi alloc] init];

// Deletes a asset.
[apiInstance deleteAssetWith:assetUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.StixApi()
var assetUuid = assetUuid_example; // {{String}} The UUID of the asset object to delete.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteAsset(assetUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteAssetExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new StixApi();
            var assetUuid = assetUuid_example;  // String | The UUID of the asset object to delete.

            try
            {
                // Deletes a asset.
                apiInstance.deleteAsset(assetUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StixApi.deleteAsset: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiStixApi();
$assetUuid = assetUuid_example; // String | The UUID of the asset object to delete.

try {
    $api_instance->deleteAsset($assetUuid);
} catch (Exception $e) {
    echo 'Exception when calling StixApi->deleteAsset: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StixApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::StixApi->new();
my $assetUuid = assetUuid_example; # String | The UUID of the asset object to delete.

eval { 
    $api_instance->deleteAsset(assetUuid => $assetUuid);
};
if ($@) {
    warn "Exception when calling StixApi->deleteAsset: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.StixApi()
assetUuid = assetUuid_example # String | The UUID of the asset object to delete.

try: 
    # Deletes a asset.
    api_instance.delete_asset(assetUuid)
except ApiException as e:
    print("Exception when calling StixApi->deleteAsset: %s\n" % e)

Parameters

Path parameters
Name Description
assetUuid*
String
The UUID of the asset object to delete.
Required

Responses

Status: 200 - The resource was deleted successfully or deprecated if asset used.

Status: 401 - Invalid authentication for this request.

Status: 403 - The request does not have authorisation.

Status: 404 - Requested asset not found or insufficient permissions to find.

Status: default - Internal Server Error


deleteContact

Deletes a contact.


/stix/contact/{contactUuid}

Usage and SDK Samples

curl -X DELETE\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/stix/contact/{contactUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StixApi;

import java.io.File;
import java.util.*;

public class StixApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        StixApi apiInstance = new StixApi();
        String contactUuid = contactUuid_example; // String | The UUID of the contact object to delete.
        try {
            apiInstance.deleteContact(contactUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling StixApi#deleteContact");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StixApi;

public class StixApiExample {

    public static void main(String[] args) {
        StixApi apiInstance = new StixApi();
        String contactUuid = contactUuid_example; // String | The UUID of the contact object to delete.
        try {
            apiInstance.deleteContact(contactUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling StixApi#deleteContact");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *contactUuid = contactUuid_example; // The UUID of the contact object to delete.

StixApi *apiInstance = [[StixApi alloc] init];

// Deletes a contact.
[apiInstance deleteContactWith:contactUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.StixApi()
var contactUuid = contactUuid_example; // {{String}} The UUID of the contact object to delete.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteContact(contactUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteContactExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new StixApi();
            var contactUuid = contactUuid_example;  // String | The UUID of the contact object to delete.

            try
            {
                // Deletes a contact.
                apiInstance.deleteContact(contactUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StixApi.deleteContact: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiStixApi();
$contactUuid = contactUuid_example; // String | The UUID of the contact object to delete.

try {
    $api_instance->deleteContact($contactUuid);
} catch (Exception $e) {
    echo 'Exception when calling StixApi->deleteContact: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StixApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::StixApi->new();
my $contactUuid = contactUuid_example; # String | The UUID of the contact object to delete.

eval { 
    $api_instance->deleteContact(contactUuid => $contactUuid);
};
if ($@) {
    warn "Exception when calling StixApi->deleteContact: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.StixApi()
contactUuid = contactUuid_example # String | The UUID of the contact object to delete.

try: 
    # Deletes a contact.
    api_instance.delete_contact(contactUuid)
except ApiException as e:
    print("Exception when calling StixApi->deleteContact: %s\n" % e)

Parameters

Path parameters
Name Description
contactUuid*
String
The UUID of the contact object to delete.
Required

Responses

Status: 200 - The resource was deleted successfully or deprecated if contact used.

Status: 401 - Invalid authentication for this request.

Status: 403 - The request does not have authorisation.

Status: 404 - Requested contact not found or insufficient permissions to find.

Status: default - Internal Server Error


getAllContacts

Get a list of Contacts.


/stix/contact

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/stix/contact"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StixApi;

import java.io.File;
import java.util.*;

public class StixApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        StixApi apiInstance = new StixApi();
        try {
            simpleObjectContainer result = apiInstance.getAllContacts();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StixApi#getAllContacts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StixApi;

public class StixApiExample {

    public static void main(String[] args) {
        StixApi apiInstance = new StixApi();
        try {
            simpleObjectContainer result = apiInstance.getAllContacts();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StixApi#getAllContacts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];

StixApi *apiInstance = [[StixApi alloc] init];

// Get a list of Contacts.
[apiInstance getAllContactsWithCompletionHandler: 
              ^(simpleObjectContainer output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.StixApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllContacts(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllContactsExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new StixApi();

            try
            {
                // Get a list of Contacts.
                simpleObjectContainer result = apiInstance.getAllContacts();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StixApi.getAllContacts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiStixApi();

try {
    $result = $api_instance->getAllContacts();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StixApi->getAllContacts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StixApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::StixApi->new();

eval { 
    my $result = $api_instance->getAllContacts();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StixApi->getAllContacts: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.StixApi()

try: 
    # Get a list of Contacts.
    api_response = api_instance.get_all_contacts()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StixApi->getAllContacts: %s\n" % e)

Parameters

Responses

Status: 200 - The resource was successfully returned.

Status: 401 - Invalid authentication for this request.

Status: 403 - The request does not have authorisation.

Status: default - Internal Server Error


getAssetsFromStix

Get a list of Assets.


/stix/asset

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/stix/asset"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StixApi;

import java.io.File;
import java.util.*;

public class StixApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        StixApi apiInstance = new StixApi();
        try {
            simpleObjectContainer result = apiInstance.getAssetsFromStix();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StixApi#getAssetsFromStix");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StixApi;

public class StixApiExample {

    public static void main(String[] args) {
        StixApi apiInstance = new StixApi();
        try {
            simpleObjectContainer result = apiInstance.getAssetsFromStix();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StixApi#getAssetsFromStix");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];

StixApi *apiInstance = [[StixApi alloc] init];

// Get a list of Assets.
[apiInstance getAssetsFromStixWithCompletionHandler: 
              ^(simpleObjectContainer output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.StixApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAssetsFromStix(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAssetsFromStixExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new StixApi();

            try
            {
                // Get a list of Assets.
                simpleObjectContainer result = apiInstance.getAssetsFromStix();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StixApi.getAssetsFromStix: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiStixApi();

try {
    $result = $api_instance->getAssetsFromStix();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StixApi->getAssetsFromStix: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StixApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::StixApi->new();

eval { 
    my $result = $api_instance->getAssetsFromStix();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StixApi->getAssetsFromStix: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.StixApi()

try: 
    # Get a list of Assets.
    api_response = api_instance.get_assets_from_stix()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StixApi->getAssetsFromStix: %s\n" % e)

Parameters

Responses

Status: 200 - The resource was successfully returned.

Status: 401 - Invalid authentication for this request.

Status: 403 - The request does not have authorisation.

Status: default - Internal Server Error


updateAssetStixObject

Update an asset.


/stix/asset/{uuid}

Usage and SDK Samples

curl -X PUT\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/stix/asset/{uuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StixApi;

import java.io.File;
import java.util.*;

public class StixApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        StixApi apiInstance = new StixApi();
        UpdateAssetRequest body = ; // UpdateAssetRequest | The asset request
        String uuid = uuid_example; // String | The UUID of the asset object to update.
        try {
            apiInstance.updateAssetStixObject(body, uuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling StixApi#updateAssetStixObject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StixApi;

public class StixApiExample {

    public static void main(String[] args) {
        StixApi apiInstance = new StixApi();
        UpdateAssetRequest body = ; // UpdateAssetRequest | The asset request
        String uuid = uuid_example; // String | The UUID of the asset object to update.
        try {
            apiInstance.updateAssetStixObject(body, uuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling StixApi#updateAssetStixObject");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
UpdateAssetRequest *body = ; // The asset request
String *uuid = uuid_example; // The UUID of the asset object to update.

StixApi *apiInstance = [[StixApi alloc] init];

// Update an asset.
[apiInstance updateAssetStixObjectWith:body
    uuid:uuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.StixApi()
var body = ; // {{UpdateAssetRequest}} The asset request
var uuid = uuid_example; // {{String}} The UUID of the asset object to update.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateAssetStixObject(bodyuuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateAssetStixObjectExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new StixApi();
            var body = new UpdateAssetRequest(); // UpdateAssetRequest | The asset request
            var uuid = uuid_example;  // String | The UUID of the asset object to update.

            try
            {
                // Update an asset.
                apiInstance.updateAssetStixObject(body, uuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StixApi.updateAssetStixObject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiStixApi();
$body = ; // UpdateAssetRequest | The asset request
$uuid = uuid_example; // String | The UUID of the asset object to update.

try {
    $api_instance->updateAssetStixObject($body, $uuid);
} catch (Exception $e) {
    echo 'Exception when calling StixApi->updateAssetStixObject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StixApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::StixApi->new();
my $body = WWW::SwaggerClient::Object::UpdateAssetRequest->new(); # UpdateAssetRequest | The asset request
my $uuid = uuid_example; # String | The UUID of the asset object to update.

eval { 
    $api_instance->updateAssetStixObject(body => $body, uuid => $uuid);
};
if ($@) {
    warn "Exception when calling StixApi->updateAssetStixObject: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.StixApi()
body =  # UpdateAssetRequest | The asset request
uuid = uuid_example # String | The UUID of the asset object to update.

try: 
    # Update an asset.
    api_instance.update_asset_stix_object(body, uuid)
except ApiException as e:
    print("Exception when calling StixApi->updateAssetStixObject: %s\n" % e)

Parameters

Path parameters
Name Description
uuid*
String
The UUID of the asset object to update.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - The asset was updated successfully.

Status: 403 - The request does not have authorisation.

Status: 404 - Requested asset not found or insufficient permissions to find.

Status: default - Internal Server Error


updateSContactStixObject

Update a contact.


/stix/contact/{contactUuid}

Usage and SDK Samples

curl -X PUT\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/stix/contact/{contactUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StixApi;

import java.io.File;
import java.util.*;

public class StixApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        StixApi apiInstance = new StixApi();
        UpdateContactRequest body = ; // UpdateContactRequest | The contact request
        String contactUuid = contactUuid_example; // String | The UUID of the contact object to update.
        try {
            apiInstance.updateSContactStixObject(body, contactUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling StixApi#updateSContactStixObject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StixApi;

public class StixApiExample {

    public static void main(String[] args) {
        StixApi apiInstance = new StixApi();
        UpdateContactRequest body = ; // UpdateContactRequest | The contact request
        String contactUuid = contactUuid_example; // String | The UUID of the contact object to update.
        try {
            apiInstance.updateSContactStixObject(body, contactUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling StixApi#updateSContactStixObject");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
UpdateContactRequest *body = ; // The contact request
String *contactUuid = contactUuid_example; // The UUID of the contact object to update.

StixApi *apiInstance = [[StixApi alloc] init];

// Update a contact.
[apiInstance updateSContactStixObjectWith:body
    contactUuid:contactUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.StixApi()
var body = ; // {{UpdateContactRequest}} The contact request
var contactUuid = contactUuid_example; // {{String}} The UUID of the contact object to update.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateSContactStixObject(bodycontactUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateSContactStixObjectExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new StixApi();
            var body = new UpdateContactRequest(); // UpdateContactRequest | The contact request
            var contactUuid = contactUuid_example;  // String | The UUID of the contact object to update.

            try
            {
                // Update a contact.
                apiInstance.updateSContactStixObject(body, contactUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StixApi.updateSContactStixObject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiStixApi();
$body = ; // UpdateContactRequest | The contact request
$contactUuid = contactUuid_example; // String | The UUID of the contact object to update.

try {
    $api_instance->updateSContactStixObject($body, $contactUuid);
} catch (Exception $e) {
    echo 'Exception when calling StixApi->updateSContactStixObject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StixApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::StixApi->new();
my $body = WWW::SwaggerClient::Object::UpdateContactRequest->new(); # UpdateContactRequest | The contact request
my $contactUuid = contactUuid_example; # String | The UUID of the contact object to update.

eval { 
    $api_instance->updateSContactStixObject(body => $body, contactUuid => $contactUuid);
};
if ($@) {
    warn "Exception when calling StixApi->updateSContactStixObject: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.StixApi()
body =  # UpdateContactRequest | The contact request
contactUuid = contactUuid_example # String | The UUID of the contact object to update.

try: 
    # Update a contact.
    api_instance.update_s_contact_stix_object(body, contactUuid)
except ApiException as e:
    print("Exception when calling StixApi->updateSContactStixObject: %s\n" % e)

Parameters

Path parameters
Name Description
contactUuid*
String
The UUID of the contact object to update.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - The contact was updated successfully.

Status: 403 - The request does not have authorisation.

Status: 404 - Requested contact not found or insufficient permissions to find.

Status: default - Internal Server Error


updateStix

Updates a STIX node.


/stix/{id}

Usage and SDK Samples

curl -X PUT\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/stix/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StixApi;

import java.io.File;
import java.util.*;

public class StixApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        StixApi apiInstance = new StixApi();
        StixUpdateRequest body = ; // StixUpdateRequest | The updated STIX object.
        String id = id_example; // String | The UUID of the STIX to be updated.
        try {
            apiInstance.updateStix(body, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling StixApi#updateStix");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StixApi;

public class StixApiExample {

    public static void main(String[] args) {
        StixApi apiInstance = new StixApi();
        StixUpdateRequest body = ; // StixUpdateRequest | The updated STIX object.
        String id = id_example; // String | The UUID of the STIX to be updated.
        try {
            apiInstance.updateStix(body, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling StixApi#updateStix");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
StixUpdateRequest *body = ; // The updated STIX object.
String *id = id_example; // The UUID of the STIX to be updated.

StixApi *apiInstance = [[StixApi alloc] init];

// Updates a STIX node.
[apiInstance updateStixWith:body
    id:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.StixApi()
var body = ; // {{StixUpdateRequest}} The updated STIX object.
var id = id_example; // {{String}} The UUID of the STIX to be updated.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateStix(bodyid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateStixExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new StixApi();
            var body = new StixUpdateRequest(); // StixUpdateRequest | The updated STIX object.
            var id = id_example;  // String | The UUID of the STIX to be updated.

            try
            {
                // Updates a STIX node.
                apiInstance.updateStix(body, id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StixApi.updateStix: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiStixApi();
$body = ; // StixUpdateRequest | The updated STIX object.
$id = id_example; // String | The UUID of the STIX to be updated.

try {
    $api_instance->updateStix($body, $id);
} catch (Exception $e) {
    echo 'Exception when calling StixApi->updateStix: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StixApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::StixApi->new();
my $body = WWW::SwaggerClient::Object::StixUpdateRequest->new(); # StixUpdateRequest | The updated STIX object.
my $id = id_example; # String | The UUID of the STIX to be updated.

eval { 
    $api_instance->updateStix(body => $body, id => $id);
};
if ($@) {
    warn "Exception when calling StixApi->updateStix: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.StixApi()
body =  # StixUpdateRequest | The updated STIX object.
id = id_example # String | The UUID of the STIX to be updated.

try: 
    # Updates a STIX node.
    api_instance.update_stix(body, id)
except ApiException as e:
    print("Exception when calling StixApi->updateStix: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
The UUID of the STIX to be updated.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - The resource was updated successfully.

Status: 401 - Invalid authentication for this request.

Status: 403 - The request does not have authorisation.

Status: 404 - Requested data item not found or insufficient permissions to find.

Status: default - Internal Server Error


SysProp

createSysProp

Creates a system property.


/sys-prop

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/sys-prop"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SysPropApi;

import java.io.File;
import java.util.*;

public class SysPropApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        SysPropApi apiInstance = new SysPropApi();
        PropRequest body = ; // PropRequest | The system property to create.
        try {
            createResponse result = apiInstance.createSysProp(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SysPropApi#createSysProp");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SysPropApi;

public class SysPropApiExample {

    public static void main(String[] args) {
        SysPropApi apiInstance = new SysPropApi();
        PropRequest body = ; // PropRequest | The system property to create.
        try {
            createResponse result = apiInstance.createSysProp(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SysPropApi#createSysProp");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
PropRequest *body = ; // The system property to create.

SysPropApi *apiInstance = [[SysPropApi alloc] init];

// Creates a system property.
[apiInstance createSysPropWith:body
              completionHandler: ^(createResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.SysPropApi()
var body = ; // {{PropRequest}} The system property to create.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createSysProp(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createSysPropExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new SysPropApi();
            var body = new PropRequest(); // PropRequest | The system property to create.

            try
            {
                // Creates a system property.
                createResponse result = apiInstance.createSysProp(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SysPropApi.createSysProp: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiSysPropApi();
$body = ; // PropRequest | The system property to create.

try {
    $result = $api_instance->createSysProp($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SysPropApi->createSysProp: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SysPropApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::SysPropApi->new();
my $body = WWW::SwaggerClient::Object::PropRequest->new(); # PropRequest | The system property to create.

eval { 
    my $result = $api_instance->createSysProp(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SysPropApi->createSysProp: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.SysPropApi()
body =  # PropRequest | The system property to create.

try: 
    # Creates a system property.
    api_response = api_instance.create_sys_prop(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SysPropApi->createSysProp: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - System property created successfully.

Status: default - Internal Server Error


deleteSysProp

Deletes a system property.


/sys-prop/{sysPropUuid}

Usage and SDK Samples

curl -X DELETE\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/sys-prop/{sysPropUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SysPropApi;

import java.io.File;
import java.util.*;

public class SysPropApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        SysPropApi apiInstance = new SysPropApi();
        String sysPropUuid = sysPropUuid_example; // String | The UUID of the system property to delete.
        try {
            apiInstance.deleteSysProp(sysPropUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling SysPropApi#deleteSysProp");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SysPropApi;

public class SysPropApiExample {

    public static void main(String[] args) {
        SysPropApi apiInstance = new SysPropApi();
        String sysPropUuid = sysPropUuid_example; // String | The UUID of the system property to delete.
        try {
            apiInstance.deleteSysProp(sysPropUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling SysPropApi#deleteSysProp");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *sysPropUuid = sysPropUuid_example; // The UUID of the system property to delete.

SysPropApi *apiInstance = [[SysPropApi alloc] init];

// Deletes a system property.
[apiInstance deleteSysPropWith:sysPropUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.SysPropApi()
var sysPropUuid = sysPropUuid_example; // {{String}} The UUID of the system property to delete.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteSysProp(sysPropUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteSysPropExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new SysPropApi();
            var sysPropUuid = sysPropUuid_example;  // String | The UUID of the system property to delete.

            try
            {
                // Deletes a system property.
                apiInstance.deleteSysProp(sysPropUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SysPropApi.deleteSysProp: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiSysPropApi();
$sysPropUuid = sysPropUuid_example; // String | The UUID of the system property to delete.

try {
    $api_instance->deleteSysProp($sysPropUuid);
} catch (Exception $e) {
    echo 'Exception when calling SysPropApi->deleteSysProp: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SysPropApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::SysPropApi->new();
my $sysPropUuid = sysPropUuid_example; # String | The UUID of the system property to delete.

eval { 
    $api_instance->deleteSysProp(sysPropUuid => $sysPropUuid);
};
if ($@) {
    warn "Exception when calling SysPropApi->deleteSysProp: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.SysPropApi()
sysPropUuid = sysPropUuid_example # String | The UUID of the system property to delete.

try: 
    # Deletes a system property.
    api_instance.delete_sys_prop(sysPropUuid)
except ApiException as e:
    print("Exception when calling SysPropApi->deleteSysProp: %s\n" % e)

Parameters

Path parameters
Name Description
sysPropUuid*
String
The UUID of the system property to delete.
Required

Responses

Status: 204 - The resource was deleted successfully.

Status: default - Internal Server Error


getSysProp

Gets a system property.


/sys-prop/{sysPropUuid}

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/sys-prop/{sysPropUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SysPropApi;

import java.io.File;
import java.util.*;

public class SysPropApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        SysPropApi apiInstance = new SysPropApi();
        String sysPropUuid = sysPropUuid_example; // String | The UUID of the system property to retrieve.
        try {
            sysProp result = apiInstance.getSysProp(sysPropUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SysPropApi#getSysProp");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SysPropApi;

public class SysPropApiExample {

    public static void main(String[] args) {
        SysPropApi apiInstance = new SysPropApi();
        String sysPropUuid = sysPropUuid_example; // String | The UUID of the system property to retrieve.
        try {
            sysProp result = apiInstance.getSysProp(sysPropUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SysPropApi#getSysProp");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *sysPropUuid = sysPropUuid_example; // The UUID of the system property to retrieve.

SysPropApi *apiInstance = [[SysPropApi alloc] init];

// Gets a system property.
[apiInstance getSysPropWith:sysPropUuid
              completionHandler: ^(sysProp output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.SysPropApi()
var sysPropUuid = sysPropUuid_example; // {{String}} The UUID of the system property to retrieve.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSysProp(sysPropUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSysPropExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new SysPropApi();
            var sysPropUuid = sysPropUuid_example;  // String | The UUID of the system property to retrieve.

            try
            {
                // Gets a system property.
                sysProp result = apiInstance.getSysProp(sysPropUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SysPropApi.getSysProp: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiSysPropApi();
$sysPropUuid = sysPropUuid_example; // String | The UUID of the system property to retrieve.

try {
    $result = $api_instance->getSysProp($sysPropUuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SysPropApi->getSysProp: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SysPropApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::SysPropApi->new();
my $sysPropUuid = sysPropUuid_example; # String | The UUID of the system property to retrieve.

eval { 
    my $result = $api_instance->getSysProp(sysPropUuid => $sysPropUuid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SysPropApi->getSysProp: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.SysPropApi()
sysPropUuid = sysPropUuid_example # String | The UUID of the system property to retrieve.

try: 
    # Gets a system property.
    api_response = api_instance.get_sys_prop(sysPropUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SysPropApi->getSysProp: %s\n" % e)

Parameters

Path parameters
Name Description
sysPropUuid*
String
The UUID of the system property to retrieve.
Required

Responses

Status: 200 - Fetched the system property and transmitted in the message body.

Status: default - Internal Server Error


getSysProps

Gets a list of system properties.


/sys-prop

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/sys-prop"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SysPropApi;

import java.io.File;
import java.util.*;

public class SysPropApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        SysPropApi apiInstance = new SysPropApi();
        try {
            array[sysProp] result = apiInstance.getSysProps();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SysPropApi#getSysProps");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SysPropApi;

public class SysPropApiExample {

    public static void main(String[] args) {
        SysPropApi apiInstance = new SysPropApi();
        try {
            array[sysProp] result = apiInstance.getSysProps();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SysPropApi#getSysProps");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];

SysPropApi *apiInstance = [[SysPropApi alloc] init];

// Gets a list of system properties.
[apiInstance getSysPropsWithCompletionHandler: 
              ^(array[sysProp] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.SysPropApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSysProps(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSysPropsExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new SysPropApi();

            try
            {
                // Gets a list of system properties.
                array[sysProp] result = apiInstance.getSysProps();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SysPropApi.getSysProps: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiSysPropApi();

try {
    $result = $api_instance->getSysProps();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SysPropApi->getSysProps: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SysPropApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::SysPropApi->new();

eval { 
    my $result = $api_instance->getSysProps();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SysPropApi->getSysProps: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.SysPropApi()

try: 
    # Gets a list of system properties.
    api_response = api_instance.get_sys_props()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SysPropApi->getSysProps: %s\n" % e)

Parameters

Responses

Status: 200 - Fetched the list of system properties and transmitted in the message body.

Status: default - Internal Server Error


updateSysProp

Updates a system property.


/sys-prop/{sysPropUuid}

Usage and SDK Samples

curl -X PUT\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/sys-prop/{sysPropUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SysPropApi;

import java.io.File;
import java.util.*;

public class SysPropApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        SysPropApi apiInstance = new SysPropApi();
        PropUpdateRequest body = ; // PropUpdateRequest | The system property to update.
        String sysPropUuid = sysPropUuid_example; // String | The UUID of the system property to update.
        try {
            apiInstance.updateSysProp(body, sysPropUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling SysPropApi#updateSysProp");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SysPropApi;

public class SysPropApiExample {

    public static void main(String[] args) {
        SysPropApi apiInstance = new SysPropApi();
        PropUpdateRequest body = ; // PropUpdateRequest | The system property to update.
        String sysPropUuid = sysPropUuid_example; // String | The UUID of the system property to update.
        try {
            apiInstance.updateSysProp(body, sysPropUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling SysPropApi#updateSysProp");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
PropUpdateRequest *body = ; // The system property to update.
String *sysPropUuid = sysPropUuid_example; // The UUID of the system property to update.

SysPropApi *apiInstance = [[SysPropApi alloc] init];

// Updates a system property.
[apiInstance updateSysPropWith:body
    sysPropUuid:sysPropUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.SysPropApi()
var body = ; // {{PropUpdateRequest}} The system property to update.
var sysPropUuid = sysPropUuid_example; // {{String}} The UUID of the system property to update.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateSysProp(bodysysPropUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateSysPropExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new SysPropApi();
            var body = new PropUpdateRequest(); // PropUpdateRequest | The system property to update.
            var sysPropUuid = sysPropUuid_example;  // String | The UUID of the system property to update.

            try
            {
                // Updates a system property.
                apiInstance.updateSysProp(body, sysPropUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SysPropApi.updateSysProp: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiSysPropApi();
$body = ; // PropUpdateRequest | The system property to update.
$sysPropUuid = sysPropUuid_example; // String | The UUID of the system property to update.

try {
    $api_instance->updateSysProp($body, $sysPropUuid);
} catch (Exception $e) {
    echo 'Exception when calling SysPropApi->updateSysProp: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SysPropApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::SysPropApi->new();
my $body = WWW::SwaggerClient::Object::PropUpdateRequest->new(); # PropUpdateRequest | The system property to update.
my $sysPropUuid = sysPropUuid_example; # String | The UUID of the system property to update.

eval { 
    $api_instance->updateSysProp(body => $body, sysPropUuid => $sysPropUuid);
};
if ($@) {
    warn "Exception when calling SysPropApi->updateSysProp: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.SysPropApi()
body =  # PropUpdateRequest | The system property to update.
sysPropUuid = sysPropUuid_example # String | The UUID of the system property to update.

try: 
    # Updates a system property.
    api_instance.update_sys_prop(body, sysPropUuid)
except ApiException as e:
    print("Exception when calling SysPropApi->updateSysProp: %s\n" % e)

Parameters

Path parameters
Name Description
sysPropUuid*
String
The UUID of the system property to update.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - The resource was updated successfully.

Status: default - Internal Server Error


Third

createThirdPartyCacheDetails

Fetches cache for third party integration cache.


/third-party/{service}

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/third-party/{service}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ThirdApi;

import java.io.File;
import java.util.*;

public class ThirdApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        ThirdApi apiInstance = new ThirdApi();
        String service = service_example; // String | The name of the service to create.
        try {
            createResponse result = apiInstance.createThirdPartyCacheDetails(service);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ThirdApi#createThirdPartyCacheDetails");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ThirdApi;

public class ThirdApiExample {

    public static void main(String[] args) {
        ThirdApi apiInstance = new ThirdApi();
        String service = service_example; // String | The name of the service to create.
        try {
            createResponse result = apiInstance.createThirdPartyCacheDetails(service);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ThirdApi#createThirdPartyCacheDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *service = service_example; // The name of the service to create.

ThirdApi *apiInstance = [[ThirdApi alloc] init];

// Fetches cache for third party integration cache.
[apiInstance createThirdPartyCacheDetailsWith:service
              completionHandler: ^(createResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.ThirdApi()
var service = service_example; // {{String}} The name of the service to create.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createThirdPartyCacheDetails(service, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createThirdPartyCacheDetailsExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new ThirdApi();
            var service = service_example;  // String | The name of the service to create.

            try
            {
                // Fetches cache for third party integration cache.
                createResponse result = apiInstance.createThirdPartyCacheDetails(service);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ThirdApi.createThirdPartyCacheDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiThirdApi();
$service = service_example; // String | The name of the service to create.

try {
    $result = $api_instance->createThirdPartyCacheDetails($service);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ThirdApi->createThirdPartyCacheDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ThirdApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ThirdApi->new();
my $service = service_example; # String | The name of the service to create.

eval { 
    my $result = $api_instance->createThirdPartyCacheDetails(service => $service);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ThirdApi->createThirdPartyCacheDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ThirdApi()
service = service_example # String | The name of the service to create.

try: 
    # Fetches cache for third party integration cache.
    api_response = api_instance.create_third_party_cache_details(service)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ThirdApi->createThirdPartyCacheDetails: %s\n" % e)

Parameters

Path parameters
Name Description
service*
String
The name of the service to create.
Required

Responses

Status: 200 - UUID of new service tracking record.

Status: default - Internal Server Error


createThirdPartyCacheItem

Creates a new cache item for third party integration.


/third-party/{service}/cache

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/third-party/{service}/cache"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ThirdApi;

import java.io.File;
import java.util.*;

public class ThirdApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        ThirdApi apiInstance = new ThirdApi();
        String service = service_example; // String | The name of the service to fetch cache for.
        ThirdpartyCacheItem body = ; // ThirdpartyCacheItem | The details of the cache to create.
        try {
            createResponse result = apiInstance.createThirdPartyCacheItem(service, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ThirdApi#createThirdPartyCacheItem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ThirdApi;

public class ThirdApiExample {

    public static void main(String[] args) {
        ThirdApi apiInstance = new ThirdApi();
        String service = service_example; // String | The name of the service to fetch cache for.
        ThirdpartyCacheItem body = ; // ThirdpartyCacheItem | The details of the cache to create.
        try {
            createResponse result = apiInstance.createThirdPartyCacheItem(service, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ThirdApi#createThirdPartyCacheItem");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *service = service_example; // The name of the service to fetch cache for.
ThirdpartyCacheItem *body = ; // The details of the cache to create. (optional)

ThirdApi *apiInstance = [[ThirdApi alloc] init];

// Creates a new cache item for third party integration.
[apiInstance createThirdPartyCacheItemWith:service
    body:body
              completionHandler: ^(createResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.ThirdApi()
var service = service_example; // {{String}} The name of the service to fetch cache for.
var opts = { 
  'body':  // {{ThirdpartyCacheItem}} The details of the cache to create.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createThirdPartyCacheItem(service, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createThirdPartyCacheItemExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new ThirdApi();
            var service = service_example;  // String | The name of the service to fetch cache for.
            var body = new ThirdpartyCacheItem(); // ThirdpartyCacheItem | The details of the cache to create. (optional) 

            try
            {
                // Creates a new cache item for third party integration.
                createResponse result = apiInstance.createThirdPartyCacheItem(service, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ThirdApi.createThirdPartyCacheItem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiThirdApi();
$service = service_example; // String | The name of the service to fetch cache for.
$body = ; // ThirdpartyCacheItem | The details of the cache to create.

try {
    $result = $api_instance->createThirdPartyCacheItem($service, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ThirdApi->createThirdPartyCacheItem: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ThirdApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ThirdApi->new();
my $service = service_example; # String | The name of the service to fetch cache for.
my $body = WWW::SwaggerClient::Object::ThirdpartyCacheItem->new(); # ThirdpartyCacheItem | The details of the cache to create.

eval { 
    my $result = $api_instance->createThirdPartyCacheItem(service => $service, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ThirdApi->createThirdPartyCacheItem: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ThirdApi()
service = service_example # String | The name of the service to fetch cache for.
body =  # ThirdpartyCacheItem | The details of the cache to create. (optional)

try: 
    # Creates a new cache item for third party integration.
    api_response = api_instance.create_third_party_cache_item(service, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ThirdApi->createThirdPartyCacheItem: %s\n" % e)

Parameters

Path parameters
Name Description
service*
String
The name of the service to fetch cache for.
Required
Body parameters
Name Description
body

Responses

Status: 200 - UUID of created cache item.

Status: default - Internal Server Error


deleteThirdPartyCacheItem

Deletes an item from the third party cache.


/third-party/{service}/cache/{itemUuid}

Usage and SDK Samples

curl -X DELETE\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/third-party/{service}/cache/{itemUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ThirdApi;

import java.io.File;
import java.util.*;

public class ThirdApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        ThirdApi apiInstance = new ThirdApi();
        String service = service_example; // String | The name of the service to update item on.
        String itemUuid = itemUuid_example; // String | The name of the service to fetch cache for.
        try {
            apiInstance.deleteThirdPartyCacheItem(service, itemUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling ThirdApi#deleteThirdPartyCacheItem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ThirdApi;

public class ThirdApiExample {

    public static void main(String[] args) {
        ThirdApi apiInstance = new ThirdApi();
        String service = service_example; // String | The name of the service to update item on.
        String itemUuid = itemUuid_example; // String | The name of the service to fetch cache for.
        try {
            apiInstance.deleteThirdPartyCacheItem(service, itemUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling ThirdApi#deleteThirdPartyCacheItem");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *service = service_example; // The name of the service to update item on.
String *itemUuid = itemUuid_example; // The name of the service to fetch cache for.

ThirdApi *apiInstance = [[ThirdApi alloc] init];

// Deletes an item from the third party cache.
[apiInstance deleteThirdPartyCacheItemWith:service
    itemUuid:itemUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.ThirdApi()
var service = service_example; // {{String}} The name of the service to update item on.
var itemUuid = itemUuid_example; // {{String}} The name of the service to fetch cache for.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteThirdPartyCacheItem(service, itemUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteThirdPartyCacheItemExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new ThirdApi();
            var service = service_example;  // String | The name of the service to update item on.
            var itemUuid = itemUuid_example;  // String | The name of the service to fetch cache for.

            try
            {
                // Deletes an item from the third party cache.
                apiInstance.deleteThirdPartyCacheItem(service, itemUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ThirdApi.deleteThirdPartyCacheItem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiThirdApi();
$service = service_example; // String | The name of the service to update item on.
$itemUuid = itemUuid_example; // String | The name of the service to fetch cache for.

try {
    $api_instance->deleteThirdPartyCacheItem($service, $itemUuid);
} catch (Exception $e) {
    echo 'Exception when calling ThirdApi->deleteThirdPartyCacheItem: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ThirdApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ThirdApi->new();
my $service = service_example; # String | The name of the service to update item on.
my $itemUuid = itemUuid_example; # String | The name of the service to fetch cache for.

eval { 
    $api_instance->deleteThirdPartyCacheItem(service => $service, itemUuid => $itemUuid);
};
if ($@) {
    warn "Exception when calling ThirdApi->deleteThirdPartyCacheItem: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ThirdApi()
service = service_example # String | The name of the service to update item on.
itemUuid = itemUuid_example # String | The name of the service to fetch cache for.

try: 
    # Deletes an item from the third party cache.
    api_instance.delete_third_party_cache_item(service, itemUuid)
except ApiException as e:
    print("Exception when calling ThirdApi->deleteThirdPartyCacheItem: %s\n" % e)

Parameters

Path parameters
Name Description
service*
String
The name of the service to update item on.
Required
itemUuid*
String
The name of the service to fetch cache for.
Required

Responses

Status: 204 - Successfully updated the item in the third party cache.

Status: default - Internal Server Error


getThirdPartyDetailsAndCache

Fetches cache for third party integration cache.


/third-party/{service}

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/third-party/{service}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ThirdApi;

import java.io.File;
import java.util.*;

public class ThirdApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        ThirdApi apiInstance = new ThirdApi();
        String service = service_example; // String | The name of the service to fetch cache for.
        try {
            thirdpartyFullCache result = apiInstance.getThirdPartyDetailsAndCache(service);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ThirdApi#getThirdPartyDetailsAndCache");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ThirdApi;

public class ThirdApiExample {

    public static void main(String[] args) {
        ThirdApi apiInstance = new ThirdApi();
        String service = service_example; // String | The name of the service to fetch cache for.
        try {
            thirdpartyFullCache result = apiInstance.getThirdPartyDetailsAndCache(service);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ThirdApi#getThirdPartyDetailsAndCache");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *service = service_example; // The name of the service to fetch cache for.

ThirdApi *apiInstance = [[ThirdApi alloc] init];

// Fetches cache for third party integration cache.
[apiInstance getThirdPartyDetailsAndCacheWith:service
              completionHandler: ^(thirdpartyFullCache output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.ThirdApi()
var service = service_example; // {{String}} The name of the service to fetch cache for.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getThirdPartyDetailsAndCache(service, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getThirdPartyDetailsAndCacheExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new ThirdApi();
            var service = service_example;  // String | The name of the service to fetch cache for.

            try
            {
                // Fetches cache for third party integration cache.
                thirdpartyFullCache result = apiInstance.getThirdPartyDetailsAndCache(service);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ThirdApi.getThirdPartyDetailsAndCache: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiThirdApi();
$service = service_example; // String | The name of the service to fetch cache for.

try {
    $result = $api_instance->getThirdPartyDetailsAndCache($service);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ThirdApi->getThirdPartyDetailsAndCache: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ThirdApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ThirdApi->new();
my $service = service_example; # String | The name of the service to fetch cache for.

eval { 
    my $result = $api_instance->getThirdPartyDetailsAndCache(service => $service);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ThirdApi->getThirdPartyDetailsAndCache: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ThirdApi()
service = service_example # String | The name of the service to fetch cache for.

try: 
    # Fetches cache for third party integration cache.
    api_response = api_instance.get_third_party_details_and_cache(service)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ThirdApi->getThirdPartyDetailsAndCache: %s\n" % e)

Parameters

Path parameters
Name Description
service*
String
The name of the service to fetch cache for.
Required

Responses

Status: 200 - Fetched service details and list of cached items and transmitted in message body.

Status: 404 - Requested cache not found or insufficient permissions to finds.

Status: default - Internal Server Error


updateThirdPartyCacheDetails

Updates details of integrated service.


/third-party/{service}

Usage and SDK Samples

curl -X PUT\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/third-party/{service}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ThirdApi;

import java.io.File;
import java.util.*;

public class ThirdApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        ThirdApi apiInstance = new ThirdApi();
        String service = service_example; // String | The name of the service to fetch cache for.
        ThirdpartyCache body = ; // ThirdpartyCache | The details to update (only last_sync can be updated).
        try {
            apiInstance.updateThirdPartyCacheDetails(service, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ThirdApi#updateThirdPartyCacheDetails");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ThirdApi;

public class ThirdApiExample {

    public static void main(String[] args) {
        ThirdApi apiInstance = new ThirdApi();
        String service = service_example; // String | The name of the service to fetch cache for.
        ThirdpartyCache body = ; // ThirdpartyCache | The details to update (only last_sync can be updated).
        try {
            apiInstance.updateThirdPartyCacheDetails(service, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ThirdApi#updateThirdPartyCacheDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *service = service_example; // The name of the service to fetch cache for.
ThirdpartyCache *body = ; // The details to update (only last_sync can be updated). (optional)

ThirdApi *apiInstance = [[ThirdApi alloc] init];

// Updates details of integrated service.
[apiInstance updateThirdPartyCacheDetailsWith:service
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.ThirdApi()
var service = service_example; // {{String}} The name of the service to fetch cache for.
var opts = { 
  'body':  // {{ThirdpartyCache}} The details to update (only last_sync can be updated).
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateThirdPartyCacheDetails(service, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateThirdPartyCacheDetailsExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new ThirdApi();
            var service = service_example;  // String | The name of the service to fetch cache for.
            var body = new ThirdpartyCache(); // ThirdpartyCache | The details to update (only last_sync can be updated). (optional) 

            try
            {
                // Updates details of integrated service.
                apiInstance.updateThirdPartyCacheDetails(service, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ThirdApi.updateThirdPartyCacheDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiThirdApi();
$service = service_example; // String | The name of the service to fetch cache for.
$body = ; // ThirdpartyCache | The details to update (only last_sync can be updated).

try {
    $api_instance->updateThirdPartyCacheDetails($service, $body);
} catch (Exception $e) {
    echo 'Exception when calling ThirdApi->updateThirdPartyCacheDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ThirdApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ThirdApi->new();
my $service = service_example; # String | The name of the service to fetch cache for.
my $body = WWW::SwaggerClient::Object::ThirdpartyCache->new(); # ThirdpartyCache | The details to update (only last_sync can be updated).

eval { 
    $api_instance->updateThirdPartyCacheDetails(service => $service, body => $body);
};
if ($@) {
    warn "Exception when calling ThirdApi->updateThirdPartyCacheDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ThirdApi()
service = service_example # String | The name of the service to fetch cache for.
body =  # ThirdpartyCache | The details to update (only last_sync can be updated). (optional)

try: 
    # Updates details of integrated service.
    api_instance.update_third_party_cache_details(service, body=body)
except ApiException as e:
    print("Exception when calling ThirdApi->updateThirdPartyCacheDetails: %s\n" % e)

Parameters

Path parameters
Name Description
service*
String
The name of the service to fetch cache for.
Required
Body parameters
Name Description
body

Responses

Status: 204 - Details successfully updated.

Status: default - Internal Server Error


updateThirdPartyCacheItem

Updates a cache item for a third party integration cache.


/third-party/{service}/cache/{itemUuid}

Usage and SDK Samples

curl -X PUT\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/third-party/{service}/cache/{itemUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ThirdApi;

import java.io.File;
import java.util.*;

public class ThirdApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        ThirdApi apiInstance = new ThirdApi();
        String service = service_example; // String | The name of the service to update item on.
        String itemUuid = itemUuid_example; // String | The UUID of the item to update.
        ThirdpartyCacheItem body = ; // ThirdpartyCacheItem | The details to update (only checksum can be updated).
        try {
            apiInstance.updateThirdPartyCacheItem(service, itemUuid, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ThirdApi#updateThirdPartyCacheItem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ThirdApi;

public class ThirdApiExample {

    public static void main(String[] args) {
        ThirdApi apiInstance = new ThirdApi();
        String service = service_example; // String | The name of the service to update item on.
        String itemUuid = itemUuid_example; // String | The UUID of the item to update.
        ThirdpartyCacheItem body = ; // ThirdpartyCacheItem | The details to update (only checksum can be updated).
        try {
            apiInstance.updateThirdPartyCacheItem(service, itemUuid, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ThirdApi#updateThirdPartyCacheItem");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *service = service_example; // The name of the service to update item on.
String *itemUuid = itemUuid_example; // The UUID of the item to update.
ThirdpartyCacheItem *body = ; // The details to update (only checksum can be updated). (optional)

ThirdApi *apiInstance = [[ThirdApi alloc] init];

// Updates a cache item for a third party integration cache.
[apiInstance updateThirdPartyCacheItemWith:service
    itemUuid:itemUuid
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.ThirdApi()
var service = service_example; // {{String}} The name of the service to update item on.
var itemUuid = itemUuid_example; // {{String}} The UUID of the item to update.
var opts = { 
  'body':  // {{ThirdpartyCacheItem}} The details to update (only checksum can be updated).
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateThirdPartyCacheItem(serviceitemUuid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateThirdPartyCacheItemExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new ThirdApi();
            var service = service_example;  // String | The name of the service to update item on.
            var itemUuid = itemUuid_example;  // String | The UUID of the item to update.
            var body = new ThirdpartyCacheItem(); // ThirdpartyCacheItem | The details to update (only checksum can be updated). (optional) 

            try
            {
                // Updates a cache item for a third party integration cache.
                apiInstance.updateThirdPartyCacheItem(service, itemUuid, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ThirdApi.updateThirdPartyCacheItem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiThirdApi();
$service = service_example; // String | The name of the service to update item on.
$itemUuid = itemUuid_example; // String | The UUID of the item to update.
$body = ; // ThirdpartyCacheItem | The details to update (only checksum can be updated).

try {
    $api_instance->updateThirdPartyCacheItem($service, $itemUuid, $body);
} catch (Exception $e) {
    echo 'Exception when calling ThirdApi->updateThirdPartyCacheItem: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ThirdApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ThirdApi->new();
my $service = service_example; # String | The name of the service to update item on.
my $itemUuid = itemUuid_example; # String | The UUID of the item to update.
my $body = WWW::SwaggerClient::Object::ThirdpartyCacheItem->new(); # ThirdpartyCacheItem | The details to update (only checksum can be updated).

eval { 
    $api_instance->updateThirdPartyCacheItem(service => $service, itemUuid => $itemUuid, body => $body);
};
if ($@) {
    warn "Exception when calling ThirdApi->updateThirdPartyCacheItem: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ThirdApi()
service = service_example # String | The name of the service to update item on.
itemUuid = itemUuid_example # String | The UUID of the item to update.
body =  # ThirdpartyCacheItem | The details to update (only checksum can be updated). (optional)

try: 
    # Updates a cache item for a third party integration cache.
    api_instance.update_third_party_cache_item(service, itemUuid, body=body)
except ApiException as e:
    print("Exception when calling ThirdApi->updateThirdPartyCacheItem: %s\n" % e)

Parameters

Path parameters
Name Description
service*
String
The name of the service to update item on.
Required
itemUuid*
String
The UUID of the item to update.
Required
Body parameters
Name Description
body

Responses

Status: 204 - Cache item successfully updated.

Status: default - Internal Server Error


User

createUser

Creates a system property.


/user

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/user"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        UserApi apiInstance = new UserApi();
        User body = ; // User | The user to create.
        try {
            createResponse result = apiInstance.createUser(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#createUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserApi;

public class UserApiExample {

    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        User body = ; // User | The user to create.
        try {
            createResponse result = apiInstance.createUser(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#createUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
User *body = ; // The user to create.

UserApi *apiInstance = [[UserApi alloc] init];

// Creates a system property.
[apiInstance createUserWith:body
              completionHandler: ^(createResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.UserApi()
var body = ; // {{User}} The user to create.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createUser(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createUserExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new UserApi();
            var body = new User(); // User | The user to create.

            try
            {
                // Creates a system property.
                createResponse result = apiInstance.createUser(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.createUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiUserApi();
$body = ; // User | The user to create.

try {
    $result = $api_instance->createUser($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->createUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UserApi->new();
my $body = WWW::SwaggerClient::Object::User->new(); # User | The user to create.

eval { 
    my $result = $api_instance->createUser(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->createUser: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UserApi()
body =  # User | The user to create.

try: 
    # Creates a system property.
    api_response = api_instance.create_user(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->createUser: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - User has been created successfully.

Status: 401 - Invalid authentication for this request.

Status: 403 - Unauthorised action

Status: default - Internal Server Error


deleteUser

Deletes a user.


/user/{userUuid}

Usage and SDK Samples

curl -X DELETE\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/user/{userUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        UserApi apiInstance = new UserApi();
        String userUuid = userUuid_example; // String | The UUID of the user to delete.
        try {
            apiInstance.deleteUser(userUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#deleteUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserApi;

public class UserApiExample {

    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        String userUuid = userUuid_example; // String | The UUID of the user to delete.
        try {
            apiInstance.deleteUser(userUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#deleteUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *userUuid = userUuid_example; // The UUID of the user to delete.

UserApi *apiInstance = [[UserApi alloc] init];

// Deletes a user.
[apiInstance deleteUserWith:userUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.UserApi()
var userUuid = userUuid_example; // {{String}} The UUID of the user to delete.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteUser(userUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteUserExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new UserApi();
            var userUuid = userUuid_example;  // String | The UUID of the user to delete.

            try
            {
                // Deletes a user.
                apiInstance.deleteUser(userUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.deleteUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiUserApi();
$userUuid = userUuid_example; // String | The UUID of the user to delete.

try {
    $api_instance->deleteUser($userUuid);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->deleteUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UserApi->new();
my $userUuid = userUuid_example; # String | The UUID of the user to delete.

eval { 
    $api_instance->deleteUser(userUuid => $userUuid);
};
if ($@) {
    warn "Exception when calling UserApi->deleteUser: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UserApi()
userUuid = userUuid_example # String | The UUID of the user to delete.

try: 
    # Deletes a user.
    api_instance.delete_user(userUuid)
except ApiException as e:
    print("Exception when calling UserApi->deleteUser: %s\n" % e)

Parameters

Path parameters
Name Description
userUuid*
String
The UUID of the user to delete.
Required

Responses

Status: 204 - The resource was deleted successfully.

Status: 401 - Invalid authentication for this request.

Status: 404 - Could not find the requested user or insufficient permissions to finds.

Status: default - Internal Server Error


getUser

Gets a user.


/user/{userUuid}

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/user/{userUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        UserApi apiInstance = new UserApi();
        String userUuid = userUuid_example; // String | The UUID of the user to retrieve.
        try {
            user result = apiInstance.getUser(userUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserApi;

public class UserApiExample {

    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        String userUuid = userUuid_example; // String | The UUID of the user to retrieve.
        try {
            user result = apiInstance.getUser(userUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *userUuid = userUuid_example; // The UUID of the user to retrieve.

UserApi *apiInstance = [[UserApi alloc] init];

// Gets a user.
[apiInstance getUserWith:userUuid
              completionHandler: ^(user output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.UserApi()
var userUuid = userUuid_example; // {{String}} The UUID of the user to retrieve.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUser(userUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getUserExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new UserApi();
            var userUuid = userUuid_example;  // String | The UUID of the user to retrieve.

            try
            {
                // Gets a user.
                user result = apiInstance.getUser(userUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.getUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiUserApi();
$userUuid = userUuid_example; // String | The UUID of the user to retrieve.

try {
    $result = $api_instance->getUser($userUuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->getUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UserApi->new();
my $userUuid = userUuid_example; # String | The UUID of the user to retrieve.

eval { 
    my $result = $api_instance->getUser(userUuid => $userUuid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->getUser: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UserApi()
userUuid = userUuid_example # String | The UUID of the user to retrieve.

try: 
    # Gets a user.
    api_response = api_instance.get_user(userUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->getUser: %s\n" % e)

Parameters

Path parameters
Name Description
userUuid*
String
The UUID of the user to retrieve.
Required

Responses

Status: 200 - Fetched the user and transmitted in the message body.

Status: 401 - Invalid authentication for this request.

Status: 404 - Could not find the requested user or insufficient permissions to finds.

Status: default - Internal Server Error.


getUserPlaybookActions

Gets a list of pending playbook actions assigned to the user.


/user/{userUuid}/action

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/user/{userUuid}/action"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        UserApi apiInstance = new UserApi();
        String userUuid = userUuid_example; // String | The UUID of the user to retrieve.
        try {
            array[playbookActionInstance] result = apiInstance.getUserPlaybookActions(userUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getUserPlaybookActions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserApi;

public class UserApiExample {

    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        String userUuid = userUuid_example; // String | The UUID of the user to retrieve.
        try {
            array[playbookActionInstance] result = apiInstance.getUserPlaybookActions(userUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getUserPlaybookActions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *userUuid = userUuid_example; // The UUID of the user to retrieve.

UserApi *apiInstance = [[UserApi alloc] init];

// Gets a list of pending playbook actions assigned to the user.
[apiInstance getUserPlaybookActionsWith:userUuid
              completionHandler: ^(array[playbookActionInstance] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.UserApi()
var userUuid = userUuid_example; // {{String}} The UUID of the user to retrieve.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserPlaybookActions(userUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getUserPlaybookActionsExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new UserApi();
            var userUuid = userUuid_example;  // String | The UUID of the user to retrieve.

            try
            {
                // Gets a list of pending playbook actions assigned to the user.
                array[playbookActionInstance] result = apiInstance.getUserPlaybookActions(userUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.getUserPlaybookActions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiUserApi();
$userUuid = userUuid_example; // String | The UUID of the user to retrieve.

try {
    $result = $api_instance->getUserPlaybookActions($userUuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->getUserPlaybookActions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UserApi->new();
my $userUuid = userUuid_example; # String | The UUID of the user to retrieve.

eval { 
    my $result = $api_instance->getUserPlaybookActions(userUuid => $userUuid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->getUserPlaybookActions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UserApi()
userUuid = userUuid_example # String | The UUID of the user to retrieve.

try: 
    # Gets a list of pending playbook actions assigned to the user.
    api_response = api_instance.get_user_playbook_actions(userUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->getUserPlaybookActions: %s\n" % e)

Parameters

Path parameters
Name Description
userUuid*
String
The UUID of the user to retrieve.
Required

Responses

Status: 200 - The list of playbook actions has been fetched and is transmitted in the message body.

Status: 401 - Invalid authentication for this request.

Status: 404 - Could not find the requested list of pending playbook actions or insufficient permissions to finds.

Status: default - Internal Server Error


getUserWatching

Gets a list of cases the user watches.


/user/{userUuid}/watch

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/user/{userUuid}/watch"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        UserApi apiInstance = new UserApi();
        String userUuid = userUuid_example; // String | The UUID of the user to retrieve.
        try {
            array[case] result = apiInstance.getUserWatching(userUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getUserWatching");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserApi;

public class UserApiExample {

    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        String userUuid = userUuid_example; // String | The UUID of the user to retrieve.
        try {
            array[case] result = apiInstance.getUserWatching(userUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getUserWatching");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *userUuid = userUuid_example; // The UUID of the user to retrieve.

UserApi *apiInstance = [[UserApi alloc] init];

// Gets a list of cases the user watches.
[apiInstance getUserWatchingWith:userUuid
              completionHandler: ^(array[case] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.UserApi()
var userUuid = userUuid_example; // {{String}} The UUID of the user to retrieve.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserWatching(userUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getUserWatchingExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new UserApi();
            var userUuid = userUuid_example;  // String | The UUID of the user to retrieve.

            try
            {
                // Gets a list of cases the user watches.
                array[case] result = apiInstance.getUserWatching(userUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.getUserWatching: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiUserApi();
$userUuid = userUuid_example; // String | The UUID of the user to retrieve.

try {
    $result = $api_instance->getUserWatching($userUuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->getUserWatching: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UserApi->new();
my $userUuid = userUuid_example; # String | The UUID of the user to retrieve.

eval { 
    my $result = $api_instance->getUserWatching(userUuid => $userUuid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->getUserWatching: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UserApi()
userUuid = userUuid_example # String | The UUID of the user to retrieve.

try: 
    # Gets a list of cases the user watches.
    api_response = api_instance.get_user_watching(userUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->getUserWatching: %s\n" % e)

Parameters

Path parameters
Name Description
userUuid*
String
The UUID of the user to retrieve.
Required

Responses

Status: 200 - Fetched list of cases and transmitted in the message body.

Status: 401 - Invalid authentication for this request.

Status: 404 - Could not find the requested list of cases or insufficient permissions to finds.

Status: default - Internal Server Error


getUsers

Gets a list of users.


/user

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/user?include_deleted="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        UserApi apiInstance = new UserApi();
        Integer includeDeleted = 56; // Integer | If set, deleted user records are included in the list.
        try {
            array[user] result = apiInstance.getUsers(includeDeleted);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getUsers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserApi;

public class UserApiExample {

    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        Integer includeDeleted = 56; // Integer | If set, deleted user records are included in the list.
        try {
            array[user] result = apiInstance.getUsers(includeDeleted);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getUsers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
Integer *includeDeleted = 56; // If set, deleted user records are included in the list. (optional)

UserApi *apiInstance = [[UserApi alloc] init];

// Gets a list of users.
[apiInstance getUsersWith:includeDeleted
              completionHandler: ^(array[user] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.UserApi()
var opts = { 
  'includeDeleted': 56 // {{Integer}} If set, deleted user records are included in the list.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUsers(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getUsersExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new UserApi();
            var includeDeleted = 56;  // Integer | If set, deleted user records are included in the list. (optional) 

            try
            {
                // Gets a list of users.
                array[user] result = apiInstance.getUsers(includeDeleted);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.getUsers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiUserApi();
$includeDeleted = 56; // Integer | If set, deleted user records are included in the list.

try {
    $result = $api_instance->getUsers($includeDeleted);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->getUsers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UserApi->new();
my $includeDeleted = 56; # Integer | If set, deleted user records are included in the list.

eval { 
    my $result = $api_instance->getUsers(includeDeleted => $includeDeleted);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->getUsers: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UserApi()
includeDeleted = 56 # Integer | If set, deleted user records are included in the list. (optional)

try: 
    # Gets a list of users.
    api_response = api_instance.get_users(includeDeleted=includeDeleted)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->getUsers: %s\n" % e)

Parameters

Query parameters
Name Description
include_deleted
Integer
If set, deleted user records are included in the list.

Responses

Status: 200 - Fetched the list of users and transmitted in the message body.

Status: 401 - Invalid authentication for this request.

Status: default - Internal Server Error


reactivateUserAccount

Reactivate a user account.


/user/{userUuid}/reactivate

Usage and SDK Samples

curl -X PUT\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/user/{userUuid}/reactivate"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        UserApi apiInstance = new UserApi();
        String userUuid = userUuid_example; // String | The UUID of the user to reactivate.
        try {
            apiInstance.reactivateUserAccount(userUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#reactivateUserAccount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserApi;

public class UserApiExample {

    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        String userUuid = userUuid_example; // String | The UUID of the user to reactivate.
        try {
            apiInstance.reactivateUserAccount(userUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#reactivateUserAccount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *userUuid = userUuid_example; // The UUID of the user to reactivate.

UserApi *apiInstance = [[UserApi alloc] init];

// Reactivate a user account.
[apiInstance reactivateUserAccountWith:userUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.UserApi()
var userUuid = userUuid_example; // {{String}} The UUID of the user to reactivate.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.reactivateUserAccount(userUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class reactivateUserAccountExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new UserApi();
            var userUuid = userUuid_example;  // String | The UUID of the user to reactivate.

            try
            {
                // Reactivate a user account.
                apiInstance.reactivateUserAccount(userUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.reactivateUserAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiUserApi();
$userUuid = userUuid_example; // String | The UUID of the user to reactivate.

try {
    $api_instance->reactivateUserAccount($userUuid);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->reactivateUserAccount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UserApi->new();
my $userUuid = userUuid_example; # String | The UUID of the user to reactivate.

eval { 
    $api_instance->reactivateUserAccount(userUuid => $userUuid);
};
if ($@) {
    warn "Exception when calling UserApi->reactivateUserAccount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UserApi()
userUuid = userUuid_example # String | The UUID of the user to reactivate.

try: 
    # Reactivate a user account.
    api_instance.reactivate_user_account(userUuid)
except ApiException as e:
    print("Exception when calling UserApi->reactivateUserAccount: %s\n" % e)

Parameters

Path parameters
Name Description
userUuid*
String
The UUID of the user to reactivate.
Required

Responses

Status: 204 - The user was reactivate successfully.

Status: 403 - Invalid authentication for user reactivate request.

Status: 404 - Could not find the requested user or insufficient permissions to finds.

Status: default - Internal Server Error


updateUser

Updates a user.


/user/{userUuid}

Usage and SDK Samples

curl -X PUT\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/user/{userUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        UserApi apiInstance = new UserApi();
        User body = ; // User | The user to update.
        String userUuid = userUuid_example; // String | The UUID of the user to update.
        try {
            apiInstance.updateUser(body, userUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#updateUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserApi;

public class UserApiExample {

    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        User body = ; // User | The user to update.
        String userUuid = userUuid_example; // String | The UUID of the user to update.
        try {
            apiInstance.updateUser(body, userUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#updateUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
User *body = ; // The user to update.
String *userUuid = userUuid_example; // The UUID of the user to update.

UserApi *apiInstance = [[UserApi alloc] init];

// Updates a user.
[apiInstance updateUserWith:body
    userUuid:userUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.UserApi()
var body = ; // {{User}} The user to update.
var userUuid = userUuid_example; // {{String}} The UUID of the user to update.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateUser(bodyuserUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateUserExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new UserApi();
            var body = new User(); // User | The user to update.
            var userUuid = userUuid_example;  // String | The UUID of the user to update.

            try
            {
                // Updates a user.
                apiInstance.updateUser(body, userUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.updateUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiUserApi();
$body = ; // User | The user to update.
$userUuid = userUuid_example; // String | The UUID of the user to update.

try {
    $api_instance->updateUser($body, $userUuid);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->updateUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UserApi->new();
my $body = WWW::SwaggerClient::Object::User->new(); # User | The user to update.
my $userUuid = userUuid_example; # String | The UUID of the user to update.

eval { 
    $api_instance->updateUser(body => $body, userUuid => $userUuid);
};
if ($@) {
    warn "Exception when calling UserApi->updateUser: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UserApi()
body =  # User | The user to update.
userUuid = userUuid_example # String | The UUID of the user to update.

try: 
    # Updates a user.
    api_instance.update_user(body, userUuid)
except ApiException as e:
    print("Exception when calling UserApi->updateUser: %s\n" % e)

Parameters

Path parameters
Name Description
userUuid*
String
The UUID of the user to update.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - The resource was updated successfully.

Status: 401 - Invalid authentication for this request.

Status: 403 - Invalid authentication for user update request.

Status: 404 - Could not find the requested user or insufficient permissions to finds.

Status: default - Internal Server Error


updateUserPassword

Updates a user.


/user/{userUuid}/password

Usage and SDK Samples

curl -X PUT\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/user/{userUuid}/password"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        UserApi apiInstance = new UserApi();
        User body = ; // User | The user to update.
        String userUuid = userUuid_example; // String | The UUID of the user to update.
        try {
            apiInstance.updateUserPassword(body, userUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#updateUserPassword");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserApi;

public class UserApiExample {

    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        User body = ; // User | The user to update.
        String userUuid = userUuid_example; // String | The UUID of the user to update.
        try {
            apiInstance.updateUserPassword(body, userUuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#updateUserPassword");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
User *body = ; // The user to update.
String *userUuid = userUuid_example; // The UUID of the user to update.

UserApi *apiInstance = [[UserApi alloc] init];

// Updates a user.
[apiInstance updateUserPasswordWith:body
    userUuid:userUuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.UserApi()
var body = ; // {{User}} The user to update.
var userUuid = userUuid_example; // {{String}} The UUID of the user to update.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateUserPassword(bodyuserUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateUserPasswordExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new UserApi();
            var body = new User(); // User | The user to update.
            var userUuid = userUuid_example;  // String | The UUID of the user to update.

            try
            {
                // Updates a user.
                apiInstance.updateUserPassword(body, userUuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.updateUserPassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiUserApi();
$body = ; // User | The user to update.
$userUuid = userUuid_example; // String | The UUID of the user to update.

try {
    $api_instance->updateUserPassword($body, $userUuid);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->updateUserPassword: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UserApi->new();
my $body = WWW::SwaggerClient::Object::User->new(); # User | The user to update.
my $userUuid = userUuid_example; # String | The UUID of the user to update.

eval { 
    $api_instance->updateUserPassword(body => $body, userUuid => $userUuid);
};
if ($@) {
    warn "Exception when calling UserApi->updateUserPassword: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UserApi()
body =  # User | The user to update.
userUuid = userUuid_example # String | The UUID of the user to update.

try: 
    # Updates a user.
    api_instance.update_user_password(body, userUuid)
except ApiException as e:
    print("Exception when calling UserApi->updateUserPassword: %s\n" % e)

Parameters

Path parameters
Name Description
userUuid*
String
The UUID of the user to update.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - The user was updated successfully.

Status: 401 - Invalid authentication for this request.

Status: 403 - Invalid authentication for user update request.

Status: 404 - Could not find the requested user or insufficient permissions to finds.

Status: default - Internal Server Error


UserProp

createUserProp

Creates a user property,


/user-prop/{userUuid}/{propName}

Usage and SDK Samples

curl -X POST\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/user-prop/{userUuid}/{propName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserPropApi;

import java.io.File;
import java.util.*;

public class UserPropApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        UserPropApi apiInstance = new UserPropApi();
        PropUpdateRequest body = ; // PropUpdateRequest | The user property.
        String userUuid = userUuid_example; // String | The UUID of the user whose property is being created.
        String propName = propName_example; // String | The name of the property to create.
        try {
            createResponse result = apiInstance.createUserProp(body, userUuid, propName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserPropApi#createUserProp");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserPropApi;

public class UserPropApiExample {

    public static void main(String[] args) {
        UserPropApi apiInstance = new UserPropApi();
        PropUpdateRequest body = ; // PropUpdateRequest | The user property.
        String userUuid = userUuid_example; // String | The UUID of the user whose property is being created.
        String propName = propName_example; // String | The name of the property to create.
        try {
            createResponse result = apiInstance.createUserProp(body, userUuid, propName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserPropApi#createUserProp");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
PropUpdateRequest *body = ; // The user property.
String *userUuid = userUuid_example; // The UUID of the user whose property is being created.
String *propName = propName_example; // The name of the property to create.

UserPropApi *apiInstance = [[UserPropApi alloc] init];

// Creates a user property,
[apiInstance createUserPropWith:body
    userUuid:userUuid
    propName:propName
              completionHandler: ^(createResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.UserPropApi()
var body = ; // {{PropUpdateRequest}} The user property.
var userUuid = userUuid_example; // {{String}} The UUID of the user whose property is being created.
var propName = propName_example; // {{String}} The name of the property to create.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createUserProp(bodyuserUuidpropName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createUserPropExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new UserPropApi();
            var body = new PropUpdateRequest(); // PropUpdateRequest | The user property.
            var userUuid = userUuid_example;  // String | The UUID of the user whose property is being created.
            var propName = propName_example;  // String | The name of the property to create.

            try
            {
                // Creates a user property,
                createResponse result = apiInstance.createUserProp(body, userUuid, propName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserPropApi.createUserProp: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiUserPropApi();
$body = ; // PropUpdateRequest | The user property.
$userUuid = userUuid_example; // String | The UUID of the user whose property is being created.
$propName = propName_example; // String | The name of the property to create.

try {
    $result = $api_instance->createUserProp($body, $userUuid, $propName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserPropApi->createUserProp: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserPropApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UserPropApi->new();
my $body = WWW::SwaggerClient::Object::PropUpdateRequest->new(); # PropUpdateRequest | The user property.
my $userUuid = userUuid_example; # String | The UUID of the user whose property is being created.
my $propName = propName_example; # String | The name of the property to create.

eval { 
    my $result = $api_instance->createUserProp(body => $body, userUuid => $userUuid, propName => $propName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserPropApi->createUserProp: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UserPropApi()
body =  # PropUpdateRequest | The user property.
userUuid = userUuid_example # String | The UUID of the user whose property is being created.
propName = propName_example # String | The name of the property to create.

try: 
    # Creates a user property,
    api_response = api_instance.create_user_prop(body, userUuid, propName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserPropApi->createUserProp: %s\n" % e)

Parameters

Path parameters
Name Description
userUuid*
String
The UUID of the user whose property is being created.
Required
propName*
String
The name of the property to create.
Required
Body parameters
Name Description
body *

Responses

Status: 201 - User property has been successfully created.

Status: 401 - Invalid authentication for this request.

Status: 403 - The request is forbidden.

Status: 404 - Could not find the user or insufficient permissions to finds.

Status: default - Internal Server Error


deleteUserProp

Deletes a user property.


/user-prop/{userUuid}/{propName}

Usage and SDK Samples

curl -X DELETE\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/user-prop/{userUuid}/{propName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserPropApi;

import java.io.File;
import java.util.*;

public class UserPropApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        UserPropApi apiInstance = new UserPropApi();
        String userUuid = userUuid_example; // String | The UUID of the user whose property is being deleted.
        String propName = propName_example; // String | The name of the property to delete.
        try {
            apiInstance.deleteUserProp(userUuid, propName);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserPropApi#deleteUserProp");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserPropApi;

public class UserPropApiExample {

    public static void main(String[] args) {
        UserPropApi apiInstance = new UserPropApi();
        String userUuid = userUuid_example; // String | The UUID of the user whose property is being deleted.
        String propName = propName_example; // String | The name of the property to delete.
        try {
            apiInstance.deleteUserProp(userUuid, propName);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserPropApi#deleteUserProp");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *userUuid = userUuid_example; // The UUID of the user whose property is being deleted.
String *propName = propName_example; // The name of the property to delete.

UserPropApi *apiInstance = [[UserPropApi alloc] init];

// Deletes a user property.
[apiInstance deleteUserPropWith:userUuid
    propName:propName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.UserPropApi()
var userUuid = userUuid_example; // {{String}} The UUID of the user whose property is being deleted.
var propName = propName_example; // {{String}} The name of the property to delete.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteUserProp(userUuid, propName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteUserPropExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new UserPropApi();
            var userUuid = userUuid_example;  // String | The UUID of the user whose property is being deleted.
            var propName = propName_example;  // String | The name of the property to delete.

            try
            {
                // Deletes a user property.
                apiInstance.deleteUserProp(userUuid, propName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserPropApi.deleteUserProp: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiUserPropApi();
$userUuid = userUuid_example; // String | The UUID of the user whose property is being deleted.
$propName = propName_example; // String | The name of the property to delete.

try {
    $api_instance->deleteUserProp($userUuid, $propName);
} catch (Exception $e) {
    echo 'Exception when calling UserPropApi->deleteUserProp: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserPropApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UserPropApi->new();
my $userUuid = userUuid_example; # String | The UUID of the user whose property is being deleted.
my $propName = propName_example; # String | The name of the property to delete.

eval { 
    $api_instance->deleteUserProp(userUuid => $userUuid, propName => $propName);
};
if ($@) {
    warn "Exception when calling UserPropApi->deleteUserProp: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UserPropApi()
userUuid = userUuid_example # String | The UUID of the user whose property is being deleted.
propName = propName_example # String | The name of the property to delete.

try: 
    # Deletes a user property.
    api_instance.delete_user_prop(userUuid, propName)
except ApiException as e:
    print("Exception when calling UserPropApi->deleteUserProp: %s\n" % e)

Parameters

Path parameters
Name Description
userUuid*
String
The UUID of the user whose property is being deleted.
Required
propName*
String
The name of the property to delete.
Required

Responses

Status: 204 - The resource was deleted successfully.

Status: 401 - Invalid authentication for this request.

Status: 404 - Could not find the user property or insufficient permissions to finds.

Status: default - Internal Server Error


getUserProp

Gets a user property.


/user-prop/{userUuid}/{propName}

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/user-prop/{userUuid}/{propName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserPropApi;

import java.io.File;
import java.util.*;

public class UserPropApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        UserPropApi apiInstance = new UserPropApi();
        String userUuid = userUuid_example; // String | The UUID of the user whose property is being retrieved.
        String propName = propName_example; // String | The name of the property to retrieve.
        try {
            userProp result = apiInstance.getUserProp(userUuid, propName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserPropApi#getUserProp");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserPropApi;

public class UserPropApiExample {

    public static void main(String[] args) {
        UserPropApi apiInstance = new UserPropApi();
        String userUuid = userUuid_example; // String | The UUID of the user whose property is being retrieved.
        String propName = propName_example; // String | The name of the property to retrieve.
        try {
            userProp result = apiInstance.getUserProp(userUuid, propName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserPropApi#getUserProp");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *userUuid = userUuid_example; // The UUID of the user whose property is being retrieved.
String *propName = propName_example; // The name of the property to retrieve.

UserPropApi *apiInstance = [[UserPropApi alloc] init];

// Gets a user property.
[apiInstance getUserPropWith:userUuid
    propName:propName
              completionHandler: ^(userProp output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.UserPropApi()
var userUuid = userUuid_example; // {{String}} The UUID of the user whose property is being retrieved.
var propName = propName_example; // {{String}} The name of the property to retrieve.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserProp(userUuid, propName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getUserPropExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new UserPropApi();
            var userUuid = userUuid_example;  // String | The UUID of the user whose property is being retrieved.
            var propName = propName_example;  // String | The name of the property to retrieve.

            try
            {
                // Gets a user property.
                userProp result = apiInstance.getUserProp(userUuid, propName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserPropApi.getUserProp: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiUserPropApi();
$userUuid = userUuid_example; // String | The UUID of the user whose property is being retrieved.
$propName = propName_example; // String | The name of the property to retrieve.

try {
    $result = $api_instance->getUserProp($userUuid, $propName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserPropApi->getUserProp: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserPropApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UserPropApi->new();
my $userUuid = userUuid_example; # String | The UUID of the user whose property is being retrieved.
my $propName = propName_example; # String | The name of the property to retrieve.

eval { 
    my $result = $api_instance->getUserProp(userUuid => $userUuid, propName => $propName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserPropApi->getUserProp: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UserPropApi()
userUuid = userUuid_example # String | The UUID of the user whose property is being retrieved.
propName = propName_example # String | The name of the property to retrieve.

try: 
    # Gets a user property.
    api_response = api_instance.get_user_prop(userUuid, propName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserPropApi->getUserProp: %s\n" % e)

Parameters

Path parameters
Name Description
userUuid*
String
The UUID of the user whose property is being retrieved.
Required
propName*
String
The name of the property to retrieve.
Required

Responses

Status: 200 - Fetched the user property and transmitted in the message body.

Status: 401 - Invalid authentication for this request.

Status: 404 - Could not find the user property or insufficient permissions to finds.

Status: default - Internal Server Error


getUserProps

Gets a list of user properties.


/user-prop/{userUuid}

Usage and SDK Samples

curl -X GET\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/cydarm-api/user-prop/{userUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserPropApi;

import java.io.File;
import java.util.*;

public class UserPropApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        UserPropApi apiInstance = new UserPropApi();
        String userUuid = userUuid_example; // String | The UUID of the user whose properties are being retrieved.
        try {
            array[userProp] result = apiInstance.getUserProps(userUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserPropApi#getUserProps");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserPropApi;

public class UserPropApiExample {

    public static void main(String[] args) {
        UserPropApi apiInstance = new UserPropApi();
        String userUuid = userUuid_example; // String | The UUID of the user whose properties are being retrieved.
        try {
            array[userProp] result = apiInstance.getUserProps(userUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserPropApi#getUserProps");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
String *userUuid = userUuid_example; // The UUID of the user whose properties are being retrieved.

UserPropApi *apiInstance = [[UserPropApi alloc] init];

// Gets a list of user properties.
[apiInstance getUserPropsWith:userUuid
              completionHandler: ^(array[userProp] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.UserPropApi()
var userUuid = userUuid_example; // {{String}} The UUID of the user whose properties are being retrieved.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserProps(userUuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getUserPropsExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new UserPropApi();
            var userUuid = userUuid_example;  // String | The UUID of the user whose properties are being retrieved.

            try
            {
                // Gets a list of user properties.
                array[userProp] result = apiInstance.getUserProps(userUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserPropApi.getUserProps: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiUserPropApi();
$userUuid = userUuid_example; // String | The UUID of the user whose properties are being retrieved.

try {
    $result = $api_instance->getUserProps($userUuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserPropApi->getUserProps: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserPropApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UserPropApi->new();
my $userUuid = userUuid_example; # String | The UUID of the user whose properties are being retrieved.

eval { 
    my $result = $api_instance->getUserProps(userUuid => $userUuid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserPropApi->getUserProps: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UserPropApi()
userUuid = userUuid_example # String | The UUID of the user whose properties are being retrieved.

try: 
    # Gets a list of user properties.
    api_response = api_instance.get_user_props(userUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserPropApi->getUserProps: %s\n" % e)

Parameters

Path parameters
Name Description
userUuid*
String
The UUID of the user whose properties are being retrieved.
Required

Responses

Status: 200 - Fetched the list of user properties and transmitted in the message body.

Status: 401 - Invalid authentication for this request.

Status: 404 - Could not find the list of user properties or insufficient permissions to finds.

Status: default - Internal Server Error


updateUserProp

Updates a user property.


/user-prop/{userUuid}/{propName}

Usage and SDK Samples

curl -X PUT\
-H "X-Cydarm-Authz: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost/cydarm-api/user-prop/{userUuid}/{propName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserPropApi;

import java.io.File;
import java.util.*;

public class UserPropApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        UserPropApi apiInstance = new UserPropApi();
        PropUpdateRequest body = ; // PropUpdateRequest | The updated user property.
        String userUuid = userUuid_example; // String | The UUID of the user whose property is being updated.
        String propName = propName_example; // String | The name of the property to update.
        try {
            apiInstance.updateUserProp(body, userUuid, propName);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserPropApi#updateUserProp");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserPropApi;

public class UserPropApiExample {

    public static void main(String[] args) {
        UserPropApi apiInstance = new UserPropApi();
        PropUpdateRequest body = ; // PropUpdateRequest | The updated user property.
        String userUuid = userUuid_example; // String | The UUID of the user whose property is being updated.
        String propName = propName_example; // String | The name of the property to update.
        try {
            apiInstance.updateUserProp(body, userUuid, propName);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserPropApi#updateUserProp");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Cydarm-Authz"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Cydarm-Authz"];
PropUpdateRequest *body = ; // The updated user property.
String *userUuid = userUuid_example; // The UUID of the user whose property is being updated.
String *propName = propName_example; // The name of the property to update.

UserPropApi *apiInstance = [[UserPropApi alloc] init];

// Updates a user property.
[apiInstance updateUserPropWith:body
    userUuid:userUuid
    propName:propName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CydarmApi = require('cydarm_api');
var defaultClient = CydarmApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-Cydarm-Authz'] = "Token"

var api = new CydarmApi.UserPropApi()
var body = ; // {{PropUpdateRequest}} The updated user property.
var userUuid = userUuid_example; // {{String}} The UUID of the user whose property is being updated.
var propName = propName_example; // {{String}} The name of the property to update.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateUserProp(bodyuserUuidpropName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateUserPropExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("X-Cydarm-Authz", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Cydarm-Authz", "Bearer");

            var apiInstance = new UserPropApi();
            var body = new PropUpdateRequest(); // PropUpdateRequest | The updated user property.
            var userUuid = userUuid_example;  // String | The UUID of the user whose property is being updated.
            var propName = propName_example;  // String | The name of the property to update.

            try
            {
                // Updates a user property.
                apiInstance.updateUserProp(body, userUuid, propName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserPropApi.updateUserProp: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Cydarm-Authz', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Cydarm-Authz', 'Bearer');

$api_instance = new Swagger\Client\ApiUserPropApi();
$body = ; // PropUpdateRequest | The updated user property.
$userUuid = userUuid_example; // String | The UUID of the user whose property is being updated.
$propName = propName_example; // String | The name of the property to update.

try {
    $api_instance->updateUserProp($body, $userUuid, $propName);
} catch (Exception $e) {
    echo 'Exception when calling UserPropApi->updateUserProp: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserPropApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'X-Cydarm-Authz'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Cydarm-Authz'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UserPropApi->new();
my $body = WWW::SwaggerClient::Object::PropUpdateRequest->new(); # PropUpdateRequest | The updated user property.
my $userUuid = userUuid_example; # String | The UUID of the user whose property is being updated.
my $propName = propName_example; # String | The name of the property to update.

eval { 
    $api_instance->updateUserProp(body => $body, userUuid => $userUuid, propName => $propName);
};
if ($@) {
    warn "Exception when calling UserPropApi->updateUserProp: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['X-Cydarm-Authz'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Cydarm-Authz'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UserPropApi()
body =  # PropUpdateRequest | The updated user property.
userUuid = userUuid_example # String | The UUID of the user whose property is being updated.
propName = propName_example # String | The name of the property to update.

try: 
    # Updates a user property.
    api_instance.update_user_prop(body, userUuid, propName)
except ApiException as e:
    print("Exception when calling UserPropApi->updateUserProp: %s\n" % e)

Parameters

Path parameters
Name Description
userUuid*
String
The UUID of the user whose property is being updated.
Required
propName*
String
The name of the property to update.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - The user property was updated successfully.

Status: 401 - Invalid authentication for this request.

Status: 403 - Session not authorised.

Status: default - Internal Server Error