Aerospike REST Client

AdminOperations

changePassword

Change the password of the specified user.


/v1/admin/user/{user}

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json,application/msgpack"\
-H "Content-Type: application/json,application/msgpack"\
"http://localhost:8080/v1/admin/user/{user}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminOperationsApi;

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

public class AdminOperationsApiExample {

    public static void main(String[] args) {
        
        AdminOperationsApi apiInstance = new AdminOperationsApi();
        String body = ; // String | 
        String user = user_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.changePassword(body, user, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#changePassword");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminOperationsApi;

public class AdminOperationsApiExample {

    public static void main(String[] args) {
        AdminOperationsApi apiInstance = new AdminOperationsApi();
        String body = ; // String | 
        String user = user_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.changePassword(body, user, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#changePassword");
            e.printStackTrace();
        }
    }
}
String *body = ; // 
String *user = user_example; // 
String *authorization = authorization_example; //  (optional)

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

// Change the password of the specified user.
[apiInstance changePasswordWith:body
    user:user
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AerospikeRestClient = require('aerospike_rest_client');

var api = new AerospikeRestClient.AdminOperationsApi()
var body = ; // {{String}} 
var user = user_example; // {{String}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.changePassword(bodyuser, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new AdminOperationsApi();
            var body = new String(); // String | 
            var user = user_example;  // String | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // Change the password of the specified user.
                apiInstance.changePassword(body, user, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminOperationsApi.changePassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAdminOperationsApi();
$body = ; // String | 
$user = user_example; // String | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::AdminOperationsApi->new();
my $body = WWW::SwaggerClient::Object::String->new(); # String | 
my $user = user_example; # String | 
my $authorization = authorization_example; # String | 

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

# create an instance of the API class
api_instance = swagger_client.AdminOperationsApi()
body =  # String | 
user = user_example # String | 
authorization = authorization_example # String |  (optional)

try: 
    # Change the password of the specified user.
    api_instance.change_password(body, user, authorization=authorization)
except ApiException as e:
    print("Exception when calling AdminOperationsApi->changePassword: %s\n" % e)

Parameters

Path parameters
Name Description
user*
String
Required
Header parameters
Name Description
Authorization
String
Body parameters
Name Description
body *

Responses

Status: 403 - Not authorized to modify users.

{"inDoubt":false,"message":"A message"}

Status: 404 - Specified user not found.

{"inDoubt":false,"message":"A message"}

createRole

Create a role on the Aerospike cluster.


/v1/admin/role

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json,application/msgpack"\
-H "Content-Type: application/json,application/msgpack"\
"http://localhost:8080/v1/admin/role"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminOperationsApi;

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

public class AdminOperationsApiExample {

    public static void main(String[] args) {
        
        AdminOperationsApi apiInstance = new AdminOperationsApi();
        RestClientRole body = ; // RestClientRole | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.createRole(body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#createRole");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminOperationsApi;

public class AdminOperationsApiExample {

    public static void main(String[] args) {
        AdminOperationsApi apiInstance = new AdminOperationsApi();
        RestClientRole body = ; // RestClientRole | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.createRole(body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#createRole");
            e.printStackTrace();
        }
    }
}
RestClientRole *body = ; // 
String *authorization = authorization_example; //  (optional)

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

// Create a role on the Aerospike cluster.
[apiInstance createRoleWith:body
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AerospikeRestClient = require('aerospike_rest_client');

var api = new AerospikeRestClient.AdminOperationsApi()
var body = ; // {{RestClientRole}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createRole(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new AdminOperationsApi();
            var body = new RestClientRole(); // RestClientRole | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // Create a role on the Aerospike cluster.
                apiInstance.createRole(body, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminOperationsApi.createRole: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAdminOperationsApi();
$body = ; // RestClientRole | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::AdminOperationsApi->new();
my $body = WWW::SwaggerClient::Object::RestClientRole->new(); # RestClientRole | 
my $authorization = authorization_example; # String | 

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

# create an instance of the API class
api_instance = swagger_client.AdminOperationsApi()
body =  # RestClientRole | 
authorization = authorization_example # String |  (optional)

try: 
    # Create a role on the Aerospike cluster.
    api_instance.create_role(body, authorization=authorization)
except ApiException as e:
    print("Exception when calling AdminOperationsApi->createRole: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String
Body parameters
Name Description
body *

Responses

Status: 400 - Invalid role creation parameters.

{"inDoubt":false,"message":"A message"}

Status: 403 - Not authorized to create roles.

{"inDoubt":false,"message":"A message"}

Status: 409 - Role already exists.

{"inDoubt":false,"message":"A message"}

createUser

Create a new user.


/v1/admin/user

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json,application/msgpack"\
-H "Content-Type: application/json,application/msgpack"\
"http://localhost:8080/v1/admin/user"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminOperationsApi;

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

public class AdminOperationsApiExample {

    public static void main(String[] args) {
        
        AdminOperationsApi apiInstance = new AdminOperationsApi();
        RestClientUserModel body = ; // RestClientUserModel | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.createUser(body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#createUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminOperationsApi;

public class AdminOperationsApiExample {

    public static void main(String[] args) {
        AdminOperationsApi apiInstance = new AdminOperationsApi();
        RestClientUserModel body = ; // RestClientUserModel | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.createUser(body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#createUser");
            e.printStackTrace();
        }
    }
}
RestClientUserModel *body = ; // 
String *authorization = authorization_example; //  (optional)

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

// Create a new user.
[apiInstance createUserWith:body
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AerospikeRestClient = require('aerospike_rest_client');

var api = new AerospikeRestClient.AdminOperationsApi()
var body = ; // {{RestClientUserModel}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createUser(body, opts, 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()
        {

            var apiInstance = new AdminOperationsApi();
            var body = new RestClientUserModel(); // RestClientUserModel | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // Create a new user.
                apiInstance.createUser(body, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminOperationsApi.createUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAdminOperationsApi();
$body = ; // RestClientUserModel | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::AdminOperationsApi->new();
my $body = WWW::SwaggerClient::Object::RestClientUserModel->new(); # RestClientUserModel | 
my $authorization = authorization_example; # String | 

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

# create an instance of the API class
api_instance = swagger_client.AdminOperationsApi()
body =  # RestClientUserModel | 
authorization = authorization_example # String |  (optional)

try: 
    # Create a new user.
    api_instance.create_user(body, authorization=authorization)
except ApiException as e:
    print("Exception when calling AdminOperationsApi->createUser: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String
Body parameters
Name Description
body *

Responses

Status: 400 - Invalid user creation parameters.

{"inDoubt":false,"message":"A message"}

Status: 403 - Not authorized to create users.

{"inDoubt":false,"message":"A message"}

Status: 409 - User already exists.

{"inDoubt":false,"message":"A message"}

dropRole

Remove a specific role from the Aerospike cluster.


/v1/admin/role/{name}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json,application/msgpack"\
"http://localhost:8080/v1/admin/role/{name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminOperationsApi;

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

public class AdminOperationsApiExample {

    public static void main(String[] args) {
        
        AdminOperationsApi apiInstance = new AdminOperationsApi();
        String name = name_example; // String | The name of the role to remove.
        String authorization = authorization_example; // String | 
        try {
            apiInstance.dropRole(name, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#dropRole");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminOperationsApi;

public class AdminOperationsApiExample {

    public static void main(String[] args) {
        AdminOperationsApi apiInstance = new AdminOperationsApi();
        String name = name_example; // String | The name of the role to remove.
        String authorization = authorization_example; // String | 
        try {
            apiInstance.dropRole(name, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#dropRole");
            e.printStackTrace();
        }
    }
}
String *name = name_example; // The name of the role to remove.
String *authorization = authorization_example; //  (optional)

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

// Remove a specific role from the Aerospike cluster.
[apiInstance dropRoleWith:name
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AerospikeRestClient = require('aerospike_rest_client');

var api = new AerospikeRestClient.AdminOperationsApi()
var name = name_example; // {{String}} The name of the role to remove.
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.dropRole(name, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new AdminOperationsApi();
            var name = name_example;  // String | The name of the role to remove.
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // Remove a specific role from the Aerospike cluster.
                apiInstance.dropRole(name, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminOperationsApi.dropRole: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAdminOperationsApi();
$name = name_example; // String | The name of the role to remove.
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::AdminOperationsApi->new();
my $name = name_example; # String | The name of the role to remove.
my $authorization = authorization_example; # String | 

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

# create an instance of the API class
api_instance = swagger_client.AdminOperationsApi()
name = name_example # String | The name of the role to remove.
authorization = authorization_example # String |  (optional)

try: 
    # Remove a specific role from the Aerospike cluster.
    api_instance.drop_role(name, authorization=authorization)
except ApiException as e:
    print("Exception when calling AdminOperationsApi->dropRole: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
The name of the role to remove.
Required
Header parameters
Name Description
Authorization
String

Responses

Status: 403 - Not authorized to remove roles.

{"inDoubt":false,"message":"A message"}

Status: 404 - Specified role not found.

{"inDoubt":false,"message":"A message"}

dropUser

Remove a user.


/v1/admin/user/{user}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json,application/msgpack"\
"http://localhost:8080/v1/admin/user/{user}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminOperationsApi;

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

public class AdminOperationsApiExample {

    public static void main(String[] args) {
        
        AdminOperationsApi apiInstance = new AdminOperationsApi();
        String user = user_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.dropUser(user, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#dropUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminOperationsApi;

public class AdminOperationsApiExample {

    public static void main(String[] args) {
        AdminOperationsApi apiInstance = new AdminOperationsApi();
        String user = user_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.dropUser(user, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#dropUser");
            e.printStackTrace();
        }
    }
}
String *user = user_example; // 
String *authorization = authorization_example; //  (optional)

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

// Remove a user.
[apiInstance dropUserWith:user
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AerospikeRestClient = require('aerospike_rest_client');

var api = new AerospikeRestClient.AdminOperationsApi()
var user = user_example; // {{String}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.dropUser(user, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new AdminOperationsApi();
            var user = user_example;  // String | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // Remove a user.
                apiInstance.dropUser(user, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminOperationsApi.dropUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAdminOperationsApi();
$user = user_example; // String | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::AdminOperationsApi->new();
my $user = user_example; # String | 
my $authorization = authorization_example; # String | 

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

# create an instance of the API class
api_instance = swagger_client.AdminOperationsApi()
user = user_example # String | 
authorization = authorization_example # String |  (optional)

try: 
    # Remove a user.
    api_instance.drop_user(user, authorization=authorization)
except ApiException as e:
    print("Exception when calling AdminOperationsApi->dropUser: %s\n" % e)

Parameters

Path parameters
Name Description
user*
String
Required
Header parameters
Name Description
Authorization
String

Responses

Status: 403 - Not authorized to delete users.

{"inDoubt":false,"message":"A message"}

Status: 404 - Specified user not found.

{"inDoubt":false,"message":"A message"}

getRole

Get information about a specific role.


/v1/admin/role/{name}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json,application/msgpack"\
"http://localhost:8080/v1/admin/role/{name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminOperationsApi;

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

public class AdminOperationsApiExample {

    public static void main(String[] args) {
        
        AdminOperationsApi apiInstance = new AdminOperationsApi();
        String name = name_example; // String | The name of the role whose information should be retrieved.
        String authorization = authorization_example; // String | 
        try {
            apiInstance.getRole(name, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#getRole");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminOperationsApi;

public class AdminOperationsApiExample {

    public static void main(String[] args) {
        AdminOperationsApi apiInstance = new AdminOperationsApi();
        String name = name_example; // String | The name of the role whose information should be retrieved.
        String authorization = authorization_example; // String | 
        try {
            apiInstance.getRole(name, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#getRole");
            e.printStackTrace();
        }
    }
}
String *name = name_example; // The name of the role whose information should be retrieved.
String *authorization = authorization_example; //  (optional)

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

// Get information about a specific role.
[apiInstance getRoleWith:name
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AerospikeRestClient = require('aerospike_rest_client');

var api = new AerospikeRestClient.AdminOperationsApi()
var name = name_example; // {{String}} The name of the role whose information should be retrieved.
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getRole(name, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new AdminOperationsApi();
            var name = name_example;  // String | The name of the role whose information should be retrieved.
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // Get information about a specific role.
                apiInstance.getRole(name, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminOperationsApi.getRole: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAdminOperationsApi();
$name = name_example; // String | The name of the role whose information should be retrieved.
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::AdminOperationsApi->new();
my $name = name_example; # String | The name of the role whose information should be retrieved.
my $authorization = authorization_example; # String | 

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

# create an instance of the API class
api_instance = swagger_client.AdminOperationsApi()
name = name_example # String | The name of the role whose information should be retrieved.
authorization = authorization_example # String |  (optional)

try: 
    # Get information about a specific role.
    api_instance.get_role(name, authorization=authorization)
except ApiException as e:
    print("Exception when calling AdminOperationsApi->getRole: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
The name of the role whose information should be retrieved.
Required
Header parameters
Name Description
Authorization
String

Responses

Status: 403 - Not authorized to read role information.

{"inDoubt":false,"message":"A message"}

Status: 404 - Specified role not found.

{"inDoubt":false,"message":"A message"}

getRoles

Return a list of all roles registered with the Aerospike cluster.


/v1/admin/role

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json,application/msgpack"\
"http://localhost:8080/v1/admin/role"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminOperationsApi;

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

public class AdminOperationsApiExample {

    public static void main(String[] args) {
        
        AdminOperationsApi apiInstance = new AdminOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            apiInstance.getRoles(authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#getRoles");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminOperationsApi;

public class AdminOperationsApiExample {

    public static void main(String[] args) {
        AdminOperationsApi apiInstance = new AdminOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            apiInstance.getRoles(authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#getRoles");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; //  (optional)

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

// Return a list of all roles registered with the Aerospike cluster.
[apiInstance getRolesWith:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AerospikeRestClient = require('aerospike_rest_client');

var api = new AerospikeRestClient.AdminOperationsApi()
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getRoles(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new AdminOperationsApi();
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // Return a list of all roles registered with the Aerospike cluster.
                apiInstance.getRoles(authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminOperationsApi.getRoles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAdminOperationsApi();
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::AdminOperationsApi->new();
my $authorization = authorization_example; # String | 

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

# create an instance of the API class
api_instance = swagger_client.AdminOperationsApi()
authorization = authorization_example # String |  (optional)

try: 
    # Return a list of all roles registered with the Aerospike cluster.
    api_instance.get_roles(authorization=authorization)
except ApiException as e:
    print("Exception when calling AdminOperationsApi->getRoles: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String

Responses

Status: 403 - Not authorized to read role information.

{"inDoubt":false,"message":"A message"}

getUser

Return information about a specific user.


/v1/admin/user/{user}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json,application/msgpack"\
"http://localhost:8080/v1/admin/user/{user}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminOperationsApi;

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

public class AdminOperationsApiExample {

    public static void main(String[] args) {
        
        AdminOperationsApi apiInstance = new AdminOperationsApi();
        String user = user_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.getUser(user, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#getUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminOperationsApi;

public class AdminOperationsApiExample {

    public static void main(String[] args) {
        AdminOperationsApi apiInstance = new AdminOperationsApi();
        String user = user_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.getUser(user, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#getUser");
            e.printStackTrace();
        }
    }
}
String *user = user_example; // 
String *authorization = authorization_example; //  (optional)

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

// Return information about a specific user.
[apiInstance getUserWith:user
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AerospikeRestClient = require('aerospike_rest_client');

var api = new AerospikeRestClient.AdminOperationsApi()
var user = user_example; // {{String}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getUser(user, opts, 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()
        {

            var apiInstance = new AdminOperationsApi();
            var user = user_example;  // String | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // Return information about a specific user.
                apiInstance.getUser(user, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminOperationsApi.getUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAdminOperationsApi();
$user = user_example; // String | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::AdminOperationsApi->new();
my $user = user_example; # String | 
my $authorization = authorization_example; # String | 

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

# create an instance of the API class
api_instance = swagger_client.AdminOperationsApi()
user = user_example # String | 
authorization = authorization_example # String |  (optional)

try: 
    # Return information about a specific user.
    api_instance.get_user(user, authorization=authorization)
except ApiException as e:
    print("Exception when calling AdminOperationsApi->getUser: %s\n" % e)

Parameters

Path parameters
Name Description
user*
String
Required
Header parameters
Name Description
Authorization
String

Responses

Status: 403 - Not authorized to read user information.

{"inDoubt":false,"message":"A message"}

Status: 404 - Specified user not found.

{"inDoubt":false,"message":"A message"}

getUsers

Return a list of information about users.


/v1/admin/user

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json,application/msgpack"\
"http://localhost:8080/v1/admin/user"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminOperationsApi;

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

public class AdminOperationsApiExample {

    public static void main(String[] args) {
        
        AdminOperationsApi apiInstance = new AdminOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            apiInstance.getUsers(authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#getUsers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminOperationsApi;

public class AdminOperationsApiExample {

    public static void main(String[] args) {
        AdminOperationsApi apiInstance = new AdminOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            apiInstance.getUsers(authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#getUsers");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; //  (optional)

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

// Return a list of information about users.
[apiInstance getUsersWith:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AerospikeRestClient = require('aerospike_rest_client');

var api = new AerospikeRestClient.AdminOperationsApi()
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
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()
        {

            var apiInstance = new AdminOperationsApi();
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // Return a list of information about users.
                apiInstance.getUsers(authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminOperationsApi.getUsers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAdminOperationsApi();
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::AdminOperationsApi->new();
my $authorization = authorization_example; # String | 

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

# create an instance of the API class
api_instance = swagger_client.AdminOperationsApi()
authorization = authorization_example # String |  (optional)

try: 
    # Return a list of information about users.
    api_instance.get_users(authorization=authorization)
except ApiException as e:
    print("Exception when calling AdminOperationsApi->getUsers: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String

Responses

Status: 403 - Not authorized to read user information.

{"inDoubt":false,"message":"A message"}

grantPrivileges

Grant a list of privileges to a specific role.


/v1/admin/role/{name}/privilege

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json,application/msgpack"\
-H "Content-Type: application/json,application/msgpack"\
"http://localhost:8080/v1/admin/role/{name}/privilege"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminOperationsApi;

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

public class AdminOperationsApiExample {

    public static void main(String[] args) {
        
        AdminOperationsApi apiInstance = new AdminOperationsApi();
        array[RestClientPrivilege] body = ; // array[RestClientPrivilege] | 
        String name = name_example; // String | The name of the role to which privileges will be granted.
        String authorization = authorization_example; // String | 
        try {
            apiInstance.grantPrivileges(body, name, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#grantPrivileges");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminOperationsApi;

public class AdminOperationsApiExample {

    public static void main(String[] args) {
        AdminOperationsApi apiInstance = new AdminOperationsApi();
        array[RestClientPrivilege] body = ; // array[RestClientPrivilege] | 
        String name = name_example; // String | The name of the role to which privileges will be granted.
        String authorization = authorization_example; // String | 
        try {
            apiInstance.grantPrivileges(body, name, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#grantPrivileges");
            e.printStackTrace();
        }
    }
}
array[RestClientPrivilege] *body = ; // 
String *name = name_example; // The name of the role to which privileges will be granted.
String *authorization = authorization_example; //  (optional)

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

// Grant a list of privileges to a specific role.
[apiInstance grantPrivilegesWith:body
    name:name
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AerospikeRestClient = require('aerospike_rest_client');

var api = new AerospikeRestClient.AdminOperationsApi()
var body = ; // {{array[RestClientPrivilege]}} 
var name = name_example; // {{String}} The name of the role to which privileges will be granted.
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.grantPrivileges(bodyname, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new AdminOperationsApi();
            var body = new array[RestClientPrivilege](); // array[RestClientPrivilege] | 
            var name = name_example;  // String | The name of the role to which privileges will be granted.
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // Grant a list of privileges to a specific role.
                apiInstance.grantPrivileges(body, name, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminOperationsApi.grantPrivileges: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAdminOperationsApi();
$body = ; // array[RestClientPrivilege] | 
$name = name_example; // String | The name of the role to which privileges will be granted.
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::AdminOperationsApi->new();
my $body = [WWW::SwaggerClient::Object::array[RestClientPrivilege]->new()]; # array[RestClientPrivilege] | 
my $name = name_example; # String | The name of the role to which privileges will be granted.
my $authorization = authorization_example; # String | 

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

# create an instance of the API class
api_instance = swagger_client.AdminOperationsApi()
body =  # array[RestClientPrivilege] | 
name = name_example # String | The name of the role to which privileges will be granted.
authorization = authorization_example # String |  (optional)

try: 
    # Grant a list of privileges to a specific role.
    api_instance.grant_privileges(body, name, authorization=authorization)
except ApiException as e:
    print("Exception when calling AdminOperationsApi->grantPrivileges: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
The name of the role to which privileges will be granted.
Required
Header parameters
Name Description
Authorization
String
Body parameters
Name Description
body *

Responses

Status: 400 - Invalid privilege parameters.

{"inDoubt":false,"message":"A message"}

Status: 403 - Not authorized to modify roles.

{"inDoubt":false,"message":"A message"}

Status: 404 - Specified role not found.

{"inDoubt":false,"message":"A message"}

grantRoles

Grant a set of roles to the specified user.


/v1/admin/user/{user}/role

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json,application/msgpack"\
-H "Content-Type: application/json,application/msgpack"\
"http://localhost:8080/v1/admin/user/{user}/role"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminOperationsApi;

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

public class AdminOperationsApiExample {

    public static void main(String[] args) {
        
        AdminOperationsApi apiInstance = new AdminOperationsApi();
        array[String] body = ; // array[String] | 
        String user = user_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.grantRoles(body, user, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#grantRoles");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminOperationsApi;

public class AdminOperationsApiExample {

    public static void main(String[] args) {
        AdminOperationsApi apiInstance = new AdminOperationsApi();
        array[String] body = ; // array[String] | 
        String user = user_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.grantRoles(body, user, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#grantRoles");
            e.printStackTrace();
        }
    }
}
array[String] *body = ; // 
String *user = user_example; // 
String *authorization = authorization_example; //  (optional)

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

// Grant a set of roles to the specified user.
[apiInstance grantRolesWith:body
    user:user
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AerospikeRestClient = require('aerospike_rest_client');

var api = new AerospikeRestClient.AdminOperationsApi()
var body = ; // {{array[String]}} 
var user = user_example; // {{String}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.grantRoles(bodyuser, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new AdminOperationsApi();
            var body = new array[String](); // array[String] | 
            var user = user_example;  // String | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // Grant a set of roles to the specified user.
                apiInstance.grantRoles(body, user, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminOperationsApi.grantRoles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAdminOperationsApi();
$body = ; // array[String] | 
$user = user_example; // String | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::AdminOperationsApi->new();
my $body = [WWW::SwaggerClient::Object::array[String]->new()]; # array[String] | 
my $user = user_example; # String | 
my $authorization = authorization_example; # String | 

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

# create an instance of the API class
api_instance = swagger_client.AdminOperationsApi()
body =  # array[String] | 
user = user_example # String | 
authorization = authorization_example # String |  (optional)

try: 
    # Grant a set of roles to the specified user.
    api_instance.grant_roles(body, user, authorization=authorization)
except ApiException as e:
    print("Exception when calling AdminOperationsApi->grantRoles: %s\n" % e)

Parameters

Path parameters
Name Description
user*
String
Required
Header parameters
Name Description
Authorization
String
Body parameters
Name Description
body *

Responses

Status: 400 - Invalid role parameters.

{"inDoubt":false,"message":"A message"}

Status: 403 - Not authorized to modify users.

{"inDoubt":false,"message":"A message"}

Status: 404 - Specified user not found.

{"inDoubt":false,"message":"A message"}

revokePrivileges

Remove a list of privileges from a specific role.


/v1/admin/role/{name}/privilege/delete

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json,application/msgpack"\
-H "Content-Type: application/json,application/msgpack"\
"http://localhost:8080/v1/admin/role/{name}/privilege/delete"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminOperationsApi;

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

public class AdminOperationsApiExample {

    public static void main(String[] args) {
        
        AdminOperationsApi apiInstance = new AdminOperationsApi();
        array[RestClientPrivilege] body = ; // array[RestClientPrivilege] | 
        String name = name_example; // String | The name of the role from which privileges will be removed.
        String authorization = authorization_example; // String | 
        try {
            apiInstance.revokePrivileges(body, name, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#revokePrivileges");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminOperationsApi;

public class AdminOperationsApiExample {

    public static void main(String[] args) {
        AdminOperationsApi apiInstance = new AdminOperationsApi();
        array[RestClientPrivilege] body = ; // array[RestClientPrivilege] | 
        String name = name_example; // String | The name of the role from which privileges will be removed.
        String authorization = authorization_example; // String | 
        try {
            apiInstance.revokePrivileges(body, name, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#revokePrivileges");
            e.printStackTrace();
        }
    }
}
array[RestClientPrivilege] *body = ; // 
String *name = name_example; // The name of the role from which privileges will be removed.
String *authorization = authorization_example; //  (optional)

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

// Remove a list of privileges from a specific role.
[apiInstance revokePrivilegesWith:body
    name:name
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AerospikeRestClient = require('aerospike_rest_client');

var api = new AerospikeRestClient.AdminOperationsApi()
var body = ; // {{array[RestClientPrivilege]}} 
var name = name_example; // {{String}} The name of the role from which privileges will be removed.
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.revokePrivileges(bodyname, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new AdminOperationsApi();
            var body = new array[RestClientPrivilege](); // array[RestClientPrivilege] | 
            var name = name_example;  // String | The name of the role from which privileges will be removed.
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // Remove a list of privileges from a specific role.
                apiInstance.revokePrivileges(body, name, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminOperationsApi.revokePrivileges: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAdminOperationsApi();
$body = ; // array[RestClientPrivilege] | 
$name = name_example; // String | The name of the role from which privileges will be removed.
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::AdminOperationsApi->new();
my $body = [WWW::SwaggerClient::Object::array[RestClientPrivilege]->new()]; # array[RestClientPrivilege] | 
my $name = name_example; # String | The name of the role from which privileges will be removed.
my $authorization = authorization_example; # String | 

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

# create an instance of the API class
api_instance = swagger_client.AdminOperationsApi()
body =  # array[RestClientPrivilege] | 
name = name_example # String | The name of the role from which privileges will be removed.
authorization = authorization_example # String |  (optional)

try: 
    # Remove a list of privileges from a specific role.
    api_instance.revoke_privileges(body, name, authorization=authorization)
except ApiException as e:
    print("Exception when calling AdminOperationsApi->revokePrivileges: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
The name of the role from which privileges will be removed.
Required
Header parameters
Name Description
Authorization
String
Body parameters
Name Description
body *

Responses

Status: 400 - Invalid privilege parameters.

{"inDoubt":false,"message":"A message"}

Status: 403 - Not authorized to modify roles.

{"inDoubt":false,"message":"A message"}

Status: 404 - Specified role not found.

{"inDoubt":false,"message":"A message"}

revokeRoles

Revoke a set of roles from the specified user.


/v1/admin/user/{user}/role/delete

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json,application/msgpack"\
-H "Content-Type: application/json,application/msgpack"\
"http://localhost:8080/v1/admin/user/{user}/role/delete"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminOperationsApi;

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

public class AdminOperationsApiExample {

    public static void main(String[] args) {
        
        AdminOperationsApi apiInstance = new AdminOperationsApi();
        array[String] body = ; // array[String] | 
        String user = user_example; // String | The user from which to revoke roles
        String authorization = authorization_example; // String | 
        try {
            apiInstance.revokeRoles(body, user, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#revokeRoles");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminOperationsApi;

public class AdminOperationsApiExample {

    public static void main(String[] args) {
        AdminOperationsApi apiInstance = new AdminOperationsApi();
        array[String] body = ; // array[String] | 
        String user = user_example; // String | The user from which to revoke roles
        String authorization = authorization_example; // String | 
        try {
            apiInstance.revokeRoles(body, user, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#revokeRoles");
            e.printStackTrace();
        }
    }
}
array[String] *body = ; // 
String *user = user_example; // The user from which to revoke roles
String *authorization = authorization_example; //  (optional)

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

// Revoke a set of roles from the specified user.
[apiInstance revokeRolesWith:body
    user:user
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AerospikeRestClient = require('aerospike_rest_client');

var api = new AerospikeRestClient.AdminOperationsApi()
var body = ; // {{array[String]}} 
var user = user_example; // {{String}} The user from which to revoke roles
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.revokeRoles(bodyuser, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new AdminOperationsApi();
            var body = new array[String](); // array[String] | 
            var user = user_example;  // String | The user from which to revoke roles
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // Revoke a set of roles from the specified user.
                apiInstance.revokeRoles(body, user, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminOperationsApi.revokeRoles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAdminOperationsApi();
$body = ; // array[String] | 
$user = user_example; // String | The user from which to revoke roles
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::AdminOperationsApi->new();
my $body = [WWW::SwaggerClient::Object::array[String]->new()]; # array[String] | 
my $user = user_example; # String | The user from which to revoke roles
my $authorization = authorization_example; # String | 

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

# create an instance of the API class
api_instance = swagger_client.AdminOperationsApi()
body =  # array[String] | 
user = user_example # String | The user from which to revoke roles
authorization = authorization_example # String |  (optional)

try: 
    # Revoke a set of roles from the specified user.
    api_instance.revoke_roles(body, user, authorization=authorization)
except ApiException as e:
    print("Exception when calling AdminOperationsApi->revokeRoles: %s\n" % e)

Parameters

Path parameters
Name Description
user*
String
The user from which to revoke roles
Required
Header parameters
Name Description
Authorization
String
Body parameters
Name Description
body *

Responses

Status: 400 - Invalid role parameters.

{"inDoubt":false,"message":"A message"}

Status: 403 - Not authorized to modify users.

{"inDoubt":false,"message":"A message"}

Status: 404 - Specified user not found.

{"inDoubt":false,"message":"A message"}

setRoleQuotas

Set maximum reads/writes per second limits for a role.


/v1/admin/role/{name}/quota

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json,application/msgpack"\
-H "Content-Type: application/json,application/msgpack"\
"http://localhost:8080/v1/admin/role/{name}/quota"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminOperationsApi;

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

public class AdminOperationsApiExample {

    public static void main(String[] args) {
        
        AdminOperationsApi apiInstance = new AdminOperationsApi();
        RestClientRoleQuota body = ; // RestClientRoleQuota | 
        String name = name_example; // String | The name of the role to which quotas will be set.
        String authorization = authorization_example; // String | 
        try {
            apiInstance.setRoleQuotas(body, name, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#setRoleQuotas");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminOperationsApi;

public class AdminOperationsApiExample {

    public static void main(String[] args) {
        AdminOperationsApi apiInstance = new AdminOperationsApi();
        RestClientRoleQuota body = ; // RestClientRoleQuota | 
        String name = name_example; // String | The name of the role to which quotas will be set.
        String authorization = authorization_example; // String | 
        try {
            apiInstance.setRoleQuotas(body, name, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#setRoleQuotas");
            e.printStackTrace();
        }
    }
}
RestClientRoleQuota *body = ; // 
String *name = name_example; // The name of the role to which quotas will be set.
String *authorization = authorization_example; //  (optional)

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

// Set maximum reads/writes per second limits for a role.
[apiInstance setRoleQuotasWith:body
    name:name
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AerospikeRestClient = require('aerospike_rest_client');

var api = new AerospikeRestClient.AdminOperationsApi()
var body = ; // {{RestClientRoleQuota}} 
var name = name_example; // {{String}} The name of the role to which quotas will be set.
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setRoleQuotas(bodyname, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new AdminOperationsApi();
            var body = new RestClientRoleQuota(); // RestClientRoleQuota | 
            var name = name_example;  // String | The name of the role to which quotas will be set.
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // Set maximum reads/writes per second limits for a role.
                apiInstance.setRoleQuotas(body, name, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminOperationsApi.setRoleQuotas: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAdminOperationsApi();
$body = ; // RestClientRoleQuota | 
$name = name_example; // String | The name of the role to which quotas will be set.
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::AdminOperationsApi->new();
my $body = WWW::SwaggerClient::Object::RestClientRoleQuota->new(); # RestClientRoleQuota | 
my $name = name_example; # String | The name of the role to which quotas will be set.
my $authorization = authorization_example; # String | 

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

# create an instance of the API class
api_instance = swagger_client.AdminOperationsApi()
body =  # RestClientRoleQuota | 
name = name_example # String | The name of the role to which quotas will be set.
authorization = authorization_example # String |  (optional)

try: 
    # Set maximum reads/writes per second limits for a role.
    api_instance.set_role_quotas(body, name, authorization=authorization)
except ApiException as e:
    print("Exception when calling AdminOperationsApi->setRoleQuotas: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
The name of the role to which quotas will be set.
Required
Header parameters
Name Description
Authorization
String
Body parameters
Name Description
body *

Responses

Status: 400 - Invalid role creation parameters.

{"inDoubt":false,"message":"A message"}

Status: 403 - Not authorized to create roles.

{"inDoubt":false,"message":"A message"}

Status: 409 - Role already exists.

{"inDoubt":false,"message":"A message"}

BatchReadOperations

performBatchGet

Return multiple records from the server in a single request.


/v1/batch

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json,application/msgpack"\
-H "Content-Type: application/json,application/msgpack"\
"http://localhost:8080/v1/batch?sendKey=&replica=&keytype=&recordBins=&readModeSC=&readModeAP=&totalTimeout=&socketTimeout=&sleepBetweenRetries=&maxRetries=&predexp=&filterexp=&compress=&allowInline=&maxConcurrentThreads=&sendSetName="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BatchReadOperationsApi;

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

public class BatchReadOperationsApiExample {

    public static void main(String[] args) {
        
        BatchReadOperationsApi apiInstance = new BatchReadOperationsApi();
        array[RestClientBatchReadBody] body = ; // array[RestClientBatchReadBody] | 
        String authorization = authorization_example; // String | 
        Boolean sendKey = true; // Boolean | Send user defined key in addition to hash digest on both reads and writes.
        String replica = replica_example; // String | Replica algorithm used to determine the target node for a single record command.
        String keytype = keytype_example; // String | The Type of the userKey.
        array[String] recordBins = ; // array[String] | Optionally specify a set of bins to return when fetching a record. If omitted, all bins will be returned.
        String readModeSC = readModeSC_example; // String | Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
        String readModeAP = readModeAP_example; // String | Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
        Integer totalTimeout = 56; // Integer | Total transaction timeout in milliseconds.
        Integer socketTimeout = 56; // Integer | Socket idle timeout in milliseconds when processing a database command.
        Integer sleepBetweenRetries = 56; // Integer | Milliseconds to sleep between retries.
        Integer maxRetries = 56; // Integer | Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry.
        String predexp = predexp_example; // String | Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
        String filterexp = filterexp_example; // String | Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
        Boolean compress = true; // Boolean | Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
        Boolean allowInline = true; // Boolean | Allow batch to be processed immediately in the server's receiving thread when the server deems it to be appropriate.  If false, the batch will always be processed in separate transaction threads.  This field is only relevant for the new batch index protocol.
        Integer maxConcurrentThreads = 56; // Integer | Maximum number of concurrent synchronous batch request threads to server nodes at any point in time. If there are 16 node/namespace combinations requested and maxConcurrentThreads is 8, then batch requests will be made for 8 node/namespace combinations in parallel threads. When a request completes, a new request will be issued until all 16 requests are complete.
        Boolean sendSetName = true; // Boolean | Send set name field to server for every key in the batch for batch index protocol.
This is only necessary when authentication is enabled and security roles are defined on a per set basis.
        try {
            apiInstance.performBatchGet(body, authorization, sendKey, replica, keytype, recordBins, readModeSC, readModeAP, totalTimeout, socketTimeout, sleepBetweenRetries, maxRetries, predexp, filterexp, compress, allowInline, maxConcurrentThreads, sendSetName);
        } catch (ApiException e) {
            System.err.println("Exception when calling BatchReadOperationsApi#performBatchGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BatchReadOperationsApi;

public class BatchReadOperationsApiExample {

    public static void main(String[] args) {
        BatchReadOperationsApi apiInstance = new BatchReadOperationsApi();
        array[RestClientBatchReadBody] body = ; // array[RestClientBatchReadBody] | 
        String authorization = authorization_example; // String | 
        Boolean sendKey = true; // Boolean | Send user defined key in addition to hash digest on both reads and writes.
        String replica = replica_example; // String | Replica algorithm used to determine the target node for a single record command.
        String keytype = keytype_example; // String | The Type of the userKey.
        array[String] recordBins = ; // array[String] | Optionally specify a set of bins to return when fetching a record. If omitted, all bins will be returned.
        String readModeSC = readModeSC_example; // String | Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
        String readModeAP = readModeAP_example; // String | Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
        Integer totalTimeout = 56; // Integer | Total transaction timeout in milliseconds.
        Integer socketTimeout = 56; // Integer | Socket idle timeout in milliseconds when processing a database command.
        Integer sleepBetweenRetries = 56; // Integer | Milliseconds to sleep between retries.
        Integer maxRetries = 56; // Integer | Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry.
        String predexp = predexp_example; // String | Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
        String filterexp = filterexp_example; // String | Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
        Boolean compress = true; // Boolean | Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
        Boolean allowInline = true; // Boolean | Allow batch to be processed immediately in the server's receiving thread when the server deems it to be appropriate.  If false, the batch will always be processed in separate transaction threads.  This field is only relevant for the new batch index protocol.
        Integer maxConcurrentThreads = 56; // Integer | Maximum number of concurrent synchronous batch request threads to server nodes at any point in time. If there are 16 node/namespace combinations requested and maxConcurrentThreads is 8, then batch requests will be made for 8 node/namespace combinations in parallel threads. When a request completes, a new request will be issued until all 16 requests are complete.
        Boolean sendSetName = true; // Boolean | Send set name field to server for every key in the batch for batch index protocol.
This is only necessary when authentication is enabled and security roles are defined on a per set basis.
        try {
            apiInstance.performBatchGet(body, authorization, sendKey, replica, keytype, recordBins, readModeSC, readModeAP, totalTimeout, socketTimeout, sleepBetweenRetries, maxRetries, predexp, filterexp, compress, allowInline, maxConcurrentThreads, sendSetName);
        } catch (ApiException e) {
            System.err.println("Exception when calling BatchReadOperationsApi#performBatchGet");
            e.printStackTrace();
        }
    }
}
array[RestClientBatchReadBody] *body = ; // 
String *authorization = authorization_example; //  (optional)
Boolean *sendKey = true; // Send user defined key in addition to hash digest on both reads and writes. (optional)
String *replica = replica_example; // Replica algorithm used to determine the target node for a single record command. (optional)
String *keytype = keytype_example; // The Type of the userKey. (optional)
array[String] *recordBins = ; // Optionally specify a set of bins to return when fetching a record. If omitted, all bins will be returned. (optional)
String *readModeSC = readModeSC_example; // Read policy for SC (strong consistency) namespaces. Determines SC read consistency options. (optional)
String *readModeAP = readModeAP_example; // Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode. (optional)
Integer *totalTimeout = 56; // Total transaction timeout in milliseconds. (optional)
Integer *socketTimeout = 56; // Socket idle timeout in milliseconds when processing a database command. (optional)
Integer *sleepBetweenRetries = 56; // Milliseconds to sleep between retries. (optional)
Integer *maxRetries = 56; // Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry. (optional)
String *predexp = predexp_example; // Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored. (optional)
String *filterexp = filterexp_example; // Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL. (optional)
Boolean *compress = true; // Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes. (optional)
Boolean *allowInline = true; // Allow batch to be processed immediately in the server's receiving thread when the server deems it to be appropriate.  If false, the batch will always be processed in separate transaction threads.  This field is only relevant for the new batch index protocol. (optional)
Integer *maxConcurrentThreads = 56; // Maximum number of concurrent synchronous batch request threads to server nodes at any point in time. If there are 16 node/namespace combinations requested and maxConcurrentThreads is 8, then batch requests will be made for 8 node/namespace combinations in parallel threads. When a request completes, a new request will be issued until all 16 requests are complete. (optional)
Boolean *sendSetName = true; // Send set name field to server for every key in the batch for batch index protocol.
This is only necessary when authentication is enabled and security roles are defined on a per set basis. (optional)

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

// Return multiple records from the server in a single request.
[apiInstance performBatchGetWith:body
    authorization:authorization
    sendKey:sendKey
    replica:replica
    keytype:keytype
    recordBins:recordBins
    readModeSC:readModeSC
    readModeAP:readModeAP
    totalTimeout:totalTimeout
    socketTimeout:socketTimeout
    sleepBetweenRetries:sleepBetweenRetries
    maxRetries:maxRetries
    predexp:predexp
    filterexp:filterexp
    compress:compress
    allowInline:allowInline
    maxConcurrentThreads:maxConcurrentThreads
    sendSetName:sendSetName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AerospikeRestClient = require('aerospike_rest_client');

var api = new AerospikeRestClient.BatchReadOperationsApi()
var body = ; // {{array[RestClientBatchReadBody]}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
  'sendKey': true // {{Boolean}} Send user defined key in addition to hash digest on both reads and writes.
  'replica': replica_example // {{String}} Replica algorithm used to determine the target node for a single record command.
  'keytype': keytype_example // {{String}} The Type of the userKey.
  'recordBins':  // {{array[String]}} Optionally specify a set of bins to return when fetching a record. If omitted, all bins will be returned.
  'readModeSC': readModeSC_example // {{String}} Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
  'readModeAP': readModeAP_example // {{String}} Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
  'totalTimeout': 56 // {{Integer}} Total transaction timeout in milliseconds.
  'socketTimeout': 56 // {{Integer}} Socket idle timeout in milliseconds when processing a database command.
  'sleepBetweenRetries': 56 // {{Integer}} Milliseconds to sleep between retries.
  'maxRetries': 56 // {{Integer}} Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry.
  'predexp': predexp_example // {{String}} Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
  'filterexp': filterexp_example // {{String}} Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
  'compress': true // {{Boolean}} Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
  'allowInline': true // {{Boolean}} Allow batch to be processed immediately in the server's receiving thread when the server deems it to be appropriate.  If false, the batch will always be processed in separate transaction threads.  This field is only relevant for the new batch index protocol.
  'maxConcurrentThreads': 56 // {{Integer}} Maximum number of concurrent synchronous batch request threads to server nodes at any point in time. If there are 16 node/namespace combinations requested and maxConcurrentThreads is 8, then batch requests will be made for 8 node/namespace combinations in parallel threads. When a request completes, a new request will be issued until all 16 requests are complete.
  'sendSetName': true // {{Boolean}} Send set name field to server for every key in the batch for batch index protocol.
This is only necessary when authentication is enabled and security roles are defined on a per set basis.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.performBatchGet(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BatchReadOperationsApi();
            var body = new array[RestClientBatchReadBody](); // array[RestClientBatchReadBody] | 
            var authorization = authorization_example;  // String |  (optional) 
            var sendKey = true;  // Boolean | Send user defined key in addition to hash digest on both reads and writes. (optional) 
            var replica = replica_example;  // String | Replica algorithm used to determine the target node for a single record command. (optional) 
            var keytype = keytype_example;  // String | The Type of the userKey. (optional) 
            var recordBins = new array[String](); // array[String] | Optionally specify a set of bins to return when fetching a record. If omitted, all bins will be returned. (optional) 
            var readModeSC = readModeSC_example;  // String | Read policy for SC (strong consistency) namespaces. Determines SC read consistency options. (optional) 
            var readModeAP = readModeAP_example;  // String | Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode. (optional) 
            var totalTimeout = 56;  // Integer | Total transaction timeout in milliseconds. (optional) 
            var socketTimeout = 56;  // Integer | Socket idle timeout in milliseconds when processing a database command. (optional) 
            var sleepBetweenRetries = 56;  // Integer | Milliseconds to sleep between retries. (optional) 
            var maxRetries = 56;  // Integer | Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry. (optional) 
            var predexp = predexp_example;  // String | Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored. (optional) 
            var filterexp = filterexp_example;  // String | Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL. (optional) 
            var compress = true;  // Boolean | Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes. (optional) 
            var allowInline = true;  // Boolean | Allow batch to be processed immediately in the server's receiving thread when the server deems it to be appropriate.  If false, the batch will always be processed in separate transaction threads.  This field is only relevant for the new batch index protocol. (optional) 
            var maxConcurrentThreads = 56;  // Integer | Maximum number of concurrent synchronous batch request threads to server nodes at any point in time. If there are 16 node/namespace combinations requested and maxConcurrentThreads is 8, then batch requests will be made for 8 node/namespace combinations in parallel threads. When a request completes, a new request will be issued until all 16 requests are complete. (optional) 
            var sendSetName = true;  // Boolean | Send set name field to server for every key in the batch for batch index protocol.
This is only necessary when authentication is enabled and security roles are defined on a per set basis. (optional) 

            try
            {
                // Return multiple records from the server in a single request.
                apiInstance.performBatchGet(body, authorization, sendKey, replica, keytype, recordBins, readModeSC, readModeAP, totalTimeout, socketTimeout, sleepBetweenRetries, maxRetries, predexp, filterexp, compress, allowInline, maxConcurrentThreads, sendSetName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BatchReadOperationsApi.performBatchGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBatchReadOperationsApi();
$body = ; // array[RestClientBatchReadBody] | 
$authorization = authorization_example; // String | 
$sendKey = true; // Boolean | Send user defined key in addition to hash digest on both reads and writes.
$replica = replica_example; // String | Replica algorithm used to determine the target node for a single record command.
$keytype = keytype_example; // String | The Type of the userKey.
$recordBins = ; // array[String] | Optionally specify a set of bins to return when fetching a record. If omitted, all bins will be returned.
$readModeSC = readModeSC_example; // String | Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
$readModeAP = readModeAP_example; // String | Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
$totalTimeout = 56; // Integer | Total transaction timeout in milliseconds.
$socketTimeout = 56; // Integer | Socket idle timeout in milliseconds when processing a database command.
$sleepBetweenRetries = 56; // Integer | Milliseconds to sleep between retries.
$maxRetries = 56; // Integer | Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry.
$predexp = predexp_example; // String | Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
$filterexp = filterexp_example; // String | Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
$compress = true; // Boolean | Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
$allowInline = true; // Boolean | Allow batch to be processed immediately in the server's receiving thread when the server deems it to be appropriate.  If false, the batch will always be processed in separate transaction threads.  This field is only relevant for the new batch index protocol.
$maxConcurrentThreads = 56; // Integer | Maximum number of concurrent synchronous batch request threads to server nodes at any point in time. If there are 16 node/namespace combinations requested and maxConcurrentThreads is 8, then batch requests will be made for 8 node/namespace combinations in parallel threads. When a request completes, a new request will be issued until all 16 requests are complete.
$sendSetName = true; // Boolean | Send set name field to server for every key in the batch for batch index protocol.
This is only necessary when authentication is enabled and security roles are defined on a per set basis.

try {
    $api_instance->performBatchGet($body, $authorization, $sendKey, $replica, $keytype, $recordBins, $readModeSC, $readModeAP, $totalTimeout, $socketTimeout, $sleepBetweenRetries, $maxRetries, $predexp, $filterexp, $compress, $allowInline, $maxConcurrentThreads, $sendSetName);
} catch (Exception $e) {
    echo 'Exception when calling BatchReadOperationsApi->performBatchGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BatchReadOperationsApi;

my $api_instance = WWW::SwaggerClient::BatchReadOperationsApi->new();
my $body = [WWW::SwaggerClient::Object::array[RestClientBatchReadBody]->new()]; # array[RestClientBatchReadBody] | 
my $authorization = authorization_example; # String | 
my $sendKey = true; # Boolean | Send user defined key in addition to hash digest on both reads and writes.
my $replica = replica_example; # String | Replica algorithm used to determine the target node for a single record command.
my $keytype = keytype_example; # String | The Type of the userKey.
my $recordBins = []; # array[String] | Optionally specify a set of bins to return when fetching a record. If omitted, all bins will be returned.
my $readModeSC = readModeSC_example; # String | Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
my $readModeAP = readModeAP_example; # String | Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
my $totalTimeout = 56; # Integer | Total transaction timeout in milliseconds.
my $socketTimeout = 56; # Integer | Socket idle timeout in milliseconds when processing a database command.
my $sleepBetweenRetries = 56; # Integer | Milliseconds to sleep between retries.
my $maxRetries = 56; # Integer | Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry.
my $predexp = predexp_example; # String | Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
my $filterexp = filterexp_example; # String | Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
my $compress = true; # Boolean | Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
my $allowInline = true; # Boolean | Allow batch to be processed immediately in the server's receiving thread when the server deems it to be appropriate.  If false, the batch will always be processed in separate transaction threads.  This field is only relevant for the new batch index protocol.
my $maxConcurrentThreads = 56; # Integer | Maximum number of concurrent synchronous batch request threads to server nodes at any point in time. If there are 16 node/namespace combinations requested and maxConcurrentThreads is 8, then batch requests will be made for 8 node/namespace combinations in parallel threads. When a request completes, a new request will be issued until all 16 requests are complete.
my $sendSetName = true; # Boolean | Send set name field to server for every key in the batch for batch index protocol.
This is only necessary when authentication is enabled and security roles are defined on a per set basis.

eval { 
    $api_instance->performBatchGet(body => $body, authorization => $authorization, sendKey => $sendKey, replica => $replica, keytype => $keytype, recordBins => $recordBins, readModeSC => $readModeSC, readModeAP => $readModeAP, totalTimeout => $totalTimeout, socketTimeout => $socketTimeout, sleepBetweenRetries => $sleepBetweenRetries, maxRetries => $maxRetries, predexp => $predexp, filterexp => $filterexp, compress => $compress, allowInline => $allowInline, maxConcurrentThreads => $maxConcurrentThreads, sendSetName => $sendSetName);
};
if ($@) {
    warn "Exception when calling BatchReadOperationsApi->performBatchGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.BatchReadOperationsApi()
body =  # array[RestClientBatchReadBody] | 
authorization = authorization_example # String |  (optional)
sendKey = true # Boolean | Send user defined key in addition to hash digest on both reads and writes. (optional)
replica = replica_example # String | Replica algorithm used to determine the target node for a single record command. (optional)
keytype = keytype_example # String | The Type of the userKey. (optional)
recordBins =  # array[String] | Optionally specify a set of bins to return when fetching a record. If omitted, all bins will be returned. (optional)
readModeSC = readModeSC_example # String | Read policy for SC (strong consistency) namespaces. Determines SC read consistency options. (optional)
readModeAP = readModeAP_example # String | Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode. (optional)
totalTimeout = 56 # Integer | Total transaction timeout in milliseconds. (optional)
socketTimeout = 56 # Integer | Socket idle timeout in milliseconds when processing a database command. (optional)
sleepBetweenRetries = 56 # Integer | Milliseconds to sleep between retries. (optional)
maxRetries = 56 # Integer | Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry. (optional)
predexp = predexp_example # String | Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored. (optional)
filterexp = filterexp_example # String | Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL. (optional)
compress = true # Boolean | Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes. (optional)
allowInline = true # Boolean | Allow batch to be processed immediately in the server's receiving thread when the server deems it to be appropriate.  If false, the batch will always be processed in separate transaction threads.  This field is only relevant for the new batch index protocol. (optional)
maxConcurrentThreads = 56 # Integer | Maximum number of concurrent synchronous batch request threads to server nodes at any point in time. If there are 16 node/namespace combinations requested and maxConcurrentThreads is 8, then batch requests will be made for 8 node/namespace combinations in parallel threads. When a request completes, a new request will be issued until all 16 requests are complete. (optional)
sendSetName = true # Boolean | Send set name field to server for every key in the batch for batch index protocol.
This is only necessary when authentication is enabled and security roles are defined on a per set basis. (optional)

try: 
    # Return multiple records from the server in a single request.
    api_instance.perform_batch_get(body, authorization=authorization, sendKey=sendKey, replica=replica, keytype=keytype, recordBins=recordBins, readModeSC=readModeSC, readModeAP=readModeAP, totalTimeout=totalTimeout, socketTimeout=socketTimeout, sleepBetweenRetries=sleepBetweenRetries, maxRetries=maxRetries, predexp=predexp, filterexp=filterexp, compress=compress, allowInline=allowInline, maxConcurrentThreads=maxConcurrentThreads, sendSetName=sendSetName)
except ApiException as e:
    print("Exception when calling BatchReadOperationsApi->performBatchGet: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String
Body parameters
Name Description
body *
Query parameters
Name Description
sendKey
Boolean
Send user defined key in addition to hash digest on both reads and writes.
replica
String
Replica algorithm used to determine the target node for a single record command.
keytype
String
The Type of the userKey.
recordBins
array[String]
Optionally specify a set of bins to return when fetching a record. If omitted, all bins will be returned.
readModeSC
String
Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
readModeAP
String
Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
totalTimeout
Integer
Total transaction timeout in milliseconds.
socketTimeout
Integer
Socket idle timeout in milliseconds when processing a database command.
sleepBetweenRetries
Integer
Milliseconds to sleep between retries.
maxRetries
Integer
Maximum number of retries before aborting the current transaction. The initial attempt is not counted as a retry.
predexp
String
Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
filterexp
String
Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
compress
Boolean
Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
allowInline
Boolean
Allow batch to be processed immediately in the server's receiving thread when the server deems it to be appropriate. If false, the batch will always be processed in separate transaction threads. This field is only relevant for the new batch index protocol.
maxConcurrentThreads
Integer
Maximum number of concurrent synchronous batch request threads to server nodes at any point in time. If there are 16 node/namespace combinations requested and maxConcurrentThreads is 8, then batch requests will be made for 8 node/namespace combinations in parallel threads. When a request completes, a new request will be issued until all 16 requests are complete.
sendSetName
Boolean
Send set name field to server for every key in the batch for batch index protocol. This is only necessary when authentication is enabled and security roles are defined on a per set basis.

Responses

Status: 400 - Invalid parameters or request.

{"inDoubt":false,"message":"A message"}

Status: 403 - Not authorized to access the resource.

{"inDoubt":false,"message":"A message"}

Status: 404 - Non existent namespace used in one or more key.

{"inDoubt":false,"message":"A message"}

ClusterInformationOperations

getClusterInfo

Return an object containing information about the Aerospike cluster.


/v1/cluster

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json,application/msgpack"\
"http://localhost:8080/v1/cluster"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ClusterInformationOperationsApi;

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

public class ClusterInformationOperationsApiExample {

    public static void main(String[] args) {
        
        ClusterInformationOperationsApi apiInstance = new ClusterInformationOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            RestClientClusterInfoResponse result = apiInstance.getClusterInfo(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClusterInformationOperationsApi#getClusterInfo");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ClusterInformationOperationsApi;

public class ClusterInformationOperationsApiExample {

    public static void main(String[] args) {
        ClusterInformationOperationsApi apiInstance = new ClusterInformationOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            RestClientClusterInfoResponse result = apiInstance.getClusterInfo(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClusterInformationOperationsApi#getClusterInfo");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; //  (optional)

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

// Return an object containing information about the Aerospike cluster.
[apiInstance getClusterInfoWith:authorization
              completionHandler: ^(RestClientClusterInfoResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AerospikeRestClient = require('aerospike_rest_client');

var api = new AerospikeRestClient.ClusterInformationOperationsApi()
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getClusterInfo(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ClusterInformationOperationsApi();
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // Return an object containing information about the Aerospike cluster.
                RestClientClusterInfoResponse result = apiInstance.getClusterInfo(authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ClusterInformationOperationsApi.getClusterInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiClusterInformationOperationsApi();
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ClusterInformationOperationsApi->new();
my $authorization = authorization_example; # String | 

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

# create an instance of the API class
api_instance = swagger_client.ClusterInformationOperationsApi()
authorization = authorization_example # String |  (optional)

try: 
    # Return an object containing information about the Aerospike cluster.
    api_response = api_instance.get_cluster_info(authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClusterInformationOperationsApi->getClusterInfo: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String

Responses

Status: default - default response


DocumentAPIOperations

appendDocumentObject

Append an object to a list in a document specified by a JSON path.


/v1/document/{namespace}/{key}

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json,application/msgpack"\
-H "Content-Type: application/json"\
"http://localhost:8080/v1/document/{namespace}/{key}?sendKey=&replica=&keytype=&recordBins=&readModeSC=&readModeAP=&totalTimeout=&socketTimeout=&sleepBetweenRetries=&maxRetries=&predexp=&filterexp=&compress=&jsonPath=&expiration=&generation=&durableDelete=&respondAllOps=&commitLevel=&generationPolicy=&recordExistsAction="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DocumentAPIOperationsApi;

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

public class DocumentAPIOperationsApiExample {

    public static void main(String[] args) {
        
        DocumentAPIOperationsApi apiInstance = new DocumentAPIOperationsApi();
        Object body = ; // Object | 
        array[String] recordBins = ; // array[String] | Specify a set of bins to handle the JSONPath query.
        String jsonPath = jsonPath_example; // String | JSONPath query parameter.
        String namespace = namespace_example; // String | Namespace for the record; equivalent to database name.
        String key = key_example; // String | User key for the record.
        String authorization = authorization_example; // String | 
        Boolean sendKey = true; // Boolean | Send user defined key in addition to hash digest on both reads and writes.
        String replica = replica_example; // String | Replica algorithm used to determine the target node for a single record command.
        String keytype = keytype_example; // String | The Type of the userKey.
        String readModeSC = readModeSC_example; // String | Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
        String readModeAP = readModeAP_example; // String | Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
        Integer totalTimeout = 56; // Integer | Total transaction timeout in milliseconds.
        Integer socketTimeout = 56; // Integer | Socket idle timeout in milliseconds when processing a database command.
        Integer sleepBetweenRetries = 56; // Integer | Milliseconds to sleep between retries.
        Integer maxRetries = 56; // Integer | Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry.
        String predexp = predexp_example; // String | Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
        String filterexp = filterexp_example; // String | Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
        Boolean compress = true; // Boolean | Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
        Integer expiration = 56; // Integer | Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server.
        Integer generation = 56; // Integer | Expected generation. Generation is the number of times a record has been modified (including creation) on the server.
        Boolean durableDelete = true; // Boolean | If the transaction results in a record deletion, leave a tombstone for the record.
        Boolean respondAllOps = true; // Boolean | For client operate(), return a result for every operation.
        String commitLevel = commitLevel_example; // String | Desired consistency guarantee when committing a transaction on the server.
        String generationPolicy = generationPolicy_example; // String | Qualify how to handle record writes based on record generation.
        String recordExistsAction = recordExistsAction_example; // String | How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods.
        try {
            apiInstance.appendDocumentObject(body, recordBins, jsonPath, namespace, key, authorization, sendKey, replica, keytype, readModeSC, readModeAP, totalTimeout, socketTimeout, sleepBetweenRetries, maxRetries, predexp, filterexp, compress, expiration, generation, durableDelete, respondAllOps, commitLevel, generationPolicy, recordExistsAction);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentAPIOperationsApi#appendDocumentObject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DocumentAPIOperationsApi;

public class DocumentAPIOperationsApiExample {

    public static void main(String[] args) {
        DocumentAPIOperationsApi apiInstance = new DocumentAPIOperationsApi();
        Object body = ; // Object | 
        array[String] recordBins = ; // array[String] | Specify a set of bins to handle the JSONPath query.
        String jsonPath = jsonPath_example; // String | JSONPath query parameter.
        String namespace = namespace_example; // String | Namespace for the record; equivalent to database name.
        String key = key_example; // String | User key for the record.
        String authorization = authorization_example; // String | 
        Boolean sendKey = true; // Boolean | Send user defined key in addition to hash digest on both reads and writes.
        String replica = replica_example; // String | Replica algorithm used to determine the target node for a single record command.
        String keytype = keytype_example; // String | The Type of the userKey.
        String readModeSC = readModeSC_example; // String | Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
        String readModeAP = readModeAP_example; // String | Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
        Integer totalTimeout = 56; // Integer | Total transaction timeout in milliseconds.
        Integer socketTimeout = 56; // Integer | Socket idle timeout in milliseconds when processing a database command.
        Integer sleepBetweenRetries = 56; // Integer | Milliseconds to sleep between retries.
        Integer maxRetries = 56; // Integer | Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry.
        String predexp = predexp_example; // String | Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
        String filterexp = filterexp_example; // String | Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
        Boolean compress = true; // Boolean | Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
        Integer expiration = 56; // Integer | Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server.
        Integer generation = 56; // Integer | Expected generation. Generation is the number of times a record has been modified (including creation) on the server.
        Boolean durableDelete = true; // Boolean | If the transaction results in a record deletion, leave a tombstone for the record.
        Boolean respondAllOps = true; // Boolean | For client operate(), return a result for every operation.
        String commitLevel = commitLevel_example; // String | Desired consistency guarantee when committing a transaction on the server.
        String generationPolicy = generationPolicy_example; // String | Qualify how to handle record writes based on record generation.
        String recordExistsAction = recordExistsAction_example; // String | How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods.
        try {
            apiInstance.appendDocumentObject(body, recordBins, jsonPath, namespace, key, authorization, sendKey, replica, keytype, readModeSC, readModeAP, totalTimeout, socketTimeout, sleepBetweenRetries, maxRetries, predexp, filterexp, compress, expiration, generation, durableDelete, respondAllOps, commitLevel, generationPolicy, recordExistsAction);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentAPIOperationsApi#appendDocumentObject");
            e.printStackTrace();
        }
    }
}
Object *body = ; // 
array[String] *recordBins = ; // Specify a set of bins to handle the JSONPath query.
String *jsonPath = jsonPath_example; // JSONPath query parameter.
String *namespace = namespace_example; // Namespace for the record; equivalent to database name.
String *key = key_example; // User key for the record.
String *authorization = authorization_example; //  (optional)
Boolean *sendKey = true; // Send user defined key in addition to hash digest on both reads and writes. (optional)
String *replica = replica_example; // Replica algorithm used to determine the target node for a single record command. (optional)
String *keytype = keytype_example; // The Type of the userKey. (optional)
String *readModeSC = readModeSC_example; // Read policy for SC (strong consistency) namespaces. Determines SC read consistency options. (optional)
String *readModeAP = readModeAP_example; // Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode. (optional)
Integer *totalTimeout = 56; // Total transaction timeout in milliseconds. (optional)
Integer *socketTimeout = 56; // Socket idle timeout in milliseconds when processing a database command. (optional)
Integer *sleepBetweenRetries = 56; // Milliseconds to sleep between retries. (optional)
Integer *maxRetries = 56; // Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry. (optional)
String *predexp = predexp_example; // Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored. (optional)
String *filterexp = filterexp_example; // Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL. (optional)
Boolean *compress = true; // Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes. (optional)
Integer *expiration = 56; // Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server. (optional)
Integer *generation = 56; // Expected generation. Generation is the number of times a record has been modified (including creation) on the server. (optional)
Boolean *durableDelete = true; // If the transaction results in a record deletion, leave a tombstone for the record. (optional)
Boolean *respondAllOps = true; // For client operate(), return a result for every operation. (optional)
String *commitLevel = commitLevel_example; // Desired consistency guarantee when committing a transaction on the server. (optional)
String *generationPolicy = generationPolicy_example; // Qualify how to handle record writes based on record generation. (optional)
String *recordExistsAction = recordExistsAction_example; // How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods. (optional)

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

// Append an object to a list in a document specified by a JSON path.
[apiInstance appendDocumentObjectWith:body
    recordBins:recordBins
    jsonPath:jsonPath
    namespace:namespace
    key:key
    authorization:authorization
    sendKey:sendKey
    replica:replica
    keytype:keytype
    readModeSC:readModeSC
    readModeAP:readModeAP
    totalTimeout:totalTimeout
    socketTimeout:socketTimeout
    sleepBetweenRetries:sleepBetweenRetries
    maxRetries:maxRetries
    predexp:predexp
    filterexp:filterexp
    compress:compress
    expiration:expiration
    generation:generation
    durableDelete:durableDelete
    respondAllOps:respondAllOps
    commitLevel:commitLevel
    generationPolicy:generationPolicy
    recordExistsAction:recordExistsAction
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AerospikeRestClient = require('aerospike_rest_client');

var api = new AerospikeRestClient.DocumentAPIOperationsApi()
var body = ; // {{Object}} 
var recordBins = ; // {{array[String]}} Specify a set of bins to handle the JSONPath query.
var jsonPath = jsonPath_example; // {{String}} JSONPath query parameter.
var namespace = namespace_example; // {{String}} Namespace for the record; equivalent to database name.
var key = key_example; // {{String}} User key for the record.
var opts = { 
  'authorization': authorization_example // {{String}} 
  'sendKey': true // {{Boolean}} Send user defined key in addition to hash digest on both reads and writes.
  'replica': replica_example // {{String}} Replica algorithm used to determine the target node for a single record command.
  'keytype': keytype_example // {{String}} The Type of the userKey.
  'readModeSC': readModeSC_example // {{String}} Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
  'readModeAP': readModeAP_example // {{String}} Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
  'totalTimeout': 56 // {{Integer}} Total transaction timeout in milliseconds.
  'socketTimeout': 56 // {{Integer}} Socket idle timeout in milliseconds when processing a database command.
  'sleepBetweenRetries': 56 // {{Integer}} Milliseconds to sleep between retries.
  'maxRetries': 56 // {{Integer}} Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry.
  'predexp': predexp_example // {{String}} Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
  'filterexp': filterexp_example // {{String}} Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
  'compress': true // {{Boolean}} Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
  'expiration': 56 // {{Integer}} Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server.
  'generation': 56 // {{Integer}} Expected generation. Generation is the number of times a record has been modified (including creation) on the server.
  'durableDelete': true // {{Boolean}} If the transaction results in a record deletion, leave a tombstone for the record.
  'respondAllOps': true // {{Boolean}} For client operate(), return a result for every operation.
  'commitLevel': commitLevel_example // {{String}} Desired consistency guarantee when committing a transaction on the server.
  'generationPolicy': generationPolicy_example // {{String}} Qualify how to handle record writes based on record generation.
  'recordExistsAction': recordExistsAction_example // {{String}} How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.appendDocumentObject(bodyrecordBinsjsonPathnamespacekey, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DocumentAPIOperationsApi();
            var body = new Object(); // Object | 
            var recordBins = new array[String](); // array[String] | Specify a set of bins to handle the JSONPath query.
            var jsonPath = jsonPath_example;  // String | JSONPath query parameter.
            var namespace = namespace_example;  // String | Namespace for the record; equivalent to database name.
            var key = key_example;  // String | User key for the record.
            var authorization = authorization_example;  // String |  (optional) 
            var sendKey = true;  // Boolean | Send user defined key in addition to hash digest on both reads and writes. (optional) 
            var replica = replica_example;  // String | Replica algorithm used to determine the target node for a single record command. (optional) 
            var keytype = keytype_example;  // String | The Type of the userKey. (optional) 
            var readModeSC = readModeSC_example;  // String | Read policy for SC (strong consistency) namespaces. Determines SC read consistency options. (optional) 
            var readModeAP = readModeAP_example;  // String | Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode. (optional) 
            var totalTimeout = 56;  // Integer | Total transaction timeout in milliseconds. (optional) 
            var socketTimeout = 56;  // Integer | Socket idle timeout in milliseconds when processing a database command. (optional) 
            var sleepBetweenRetries = 56;  // Integer | Milliseconds to sleep between retries. (optional) 
            var maxRetries = 56;  // Integer | Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry. (optional) 
            var predexp = predexp_example;  // String | Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored. (optional) 
            var filterexp = filterexp_example;  // String | Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL. (optional) 
            var compress = true;  // Boolean | Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes. (optional) 
            var expiration = 56;  // Integer | Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server. (optional) 
            var generation = 56;  // Integer | Expected generation. Generation is the number of times a record has been modified (including creation) on the server. (optional) 
            var durableDelete = true;  // Boolean | If the transaction results in a record deletion, leave a tombstone for the record. (optional) 
            var respondAllOps = true;  // Boolean | For client operate(), return a result for every operation. (optional) 
            var commitLevel = commitLevel_example;  // String | Desired consistency guarantee when committing a transaction on the server. (optional) 
            var generationPolicy = generationPolicy_example;  // String | Qualify how to handle record writes based on record generation. (optional) 
            var recordExistsAction = recordExistsAction_example;  // String | How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods. (optional) 

            try
            {
                // Append an object to a list in a document specified by a JSON path.
                apiInstance.appendDocumentObject(body, recordBins, jsonPath, namespace, key, authorization, sendKey, replica, keytype, readModeSC, readModeAP, totalTimeout, socketTimeout, sleepBetweenRetries, maxRetries, predexp, filterexp, compress, expiration, generation, durableDelete, respondAllOps, commitLevel, generationPolicy, recordExistsAction);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DocumentAPIOperationsApi.appendDocumentObject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDocumentAPIOperationsApi();
$body = ; // Object | 
$recordBins = ; // array[String] | Specify a set of bins to handle the JSONPath query.
$jsonPath = jsonPath_example; // String | JSONPath query parameter.
$namespace = namespace_example; // String | Namespace for the record; equivalent to database name.
$key = key_example; // String | User key for the record.
$authorization = authorization_example; // String | 
$sendKey = true; // Boolean | Send user defined key in addition to hash digest on both reads and writes.
$replica = replica_example; // String | Replica algorithm used to determine the target node for a single record command.
$keytype = keytype_example; // String | The Type of the userKey.
$readModeSC = readModeSC_example; // String | Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
$readModeAP = readModeAP_example; // String | Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
$totalTimeout = 56; // Integer | Total transaction timeout in milliseconds.
$socketTimeout = 56; // Integer | Socket idle timeout in milliseconds when processing a database command.
$sleepBetweenRetries = 56; // Integer | Milliseconds to sleep between retries.
$maxRetries = 56; // Integer | Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry.
$predexp = predexp_example; // String | Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
$filterexp = filterexp_example; // String | Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
$compress = true; // Boolean | Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
$expiration = 56; // Integer | Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server.
$generation = 56; // Integer | Expected generation. Generation is the number of times a record has been modified (including creation) on the server.
$durableDelete = true; // Boolean | If the transaction results in a record deletion, leave a tombstone for the record.
$respondAllOps = true; // Boolean | For client operate(), return a result for every operation.
$commitLevel = commitLevel_example; // String | Desired consistency guarantee when committing a transaction on the server.
$generationPolicy = generationPolicy_example; // String | Qualify how to handle record writes based on record generation.
$recordExistsAction = recordExistsAction_example; // String | How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods.

try {
    $api_instance->appendDocumentObject($body, $recordBins, $jsonPath, $namespace, $key, $authorization, $sendKey, $replica, $keytype, $readModeSC, $readModeAP, $totalTimeout, $socketTimeout, $sleepBetweenRetries, $maxRetries, $predexp, $filterexp, $compress, $expiration, $generation, $durableDelete, $respondAllOps, $commitLevel, $generationPolicy, $recordExistsAction);
} catch (Exception $e) {
    echo 'Exception when calling DocumentAPIOperationsApi->appendDocumentObject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DocumentAPIOperationsApi;

my $api_instance = WWW::SwaggerClient::DocumentAPIOperationsApi->new();
my $body = WWW::SwaggerClient::Object::Object->new(); # Object | 
my $recordBins = []; # array[String] | Specify a set of bins to handle the JSONPath query.
my $jsonPath = jsonPath_example; # String | JSONPath query parameter.
my $namespace = namespace_example; # String | Namespace for the record; equivalent to database name.
my $key = key_example; # String | User key for the record.
my $authorization = authorization_example; # String | 
my $sendKey = true; # Boolean | Send user defined key in addition to hash digest on both reads and writes.
my $replica = replica_example; # String | Replica algorithm used to determine the target node for a single record command.
my $keytype = keytype_example; # String | The Type of the userKey.
my $readModeSC = readModeSC_example; # String | Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
my $readModeAP = readModeAP_example; # String | Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
my $totalTimeout = 56; # Integer | Total transaction timeout in milliseconds.
my $socketTimeout = 56; # Integer | Socket idle timeout in milliseconds when processing a database command.
my $sleepBetweenRetries = 56; # Integer | Milliseconds to sleep between retries.
my $maxRetries = 56; # Integer | Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry.
my $predexp = predexp_example; # String | Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
my $filterexp = filterexp_example; # String | Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
my $compress = true; # Boolean | Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
my $expiration = 56; # Integer | Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server.
my $generation = 56; # Integer | Expected generation. Generation is the number of times a record has been modified (including creation) on the server.
my $durableDelete = true; # Boolean | If the transaction results in a record deletion, leave a tombstone for the record.
my $respondAllOps = true; # Boolean | For client operate(), return a result for every operation.
my $commitLevel = commitLevel_example; # String | Desired consistency guarantee when committing a transaction on the server.
my $generationPolicy = generationPolicy_example; # String | Qualify how to handle record writes based on record generation.
my $recordExistsAction = recordExistsAction_example; # String | How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods.

eval { 
    $api_instance->appendDocumentObject(body => $body, recordBins => $recordBins, jsonPath => $jsonPath, namespace => $namespace, key => $key, authorization => $authorization, sendKey => $sendKey, replica => $replica, keytype => $keytype, readModeSC => $readModeSC, readModeAP => $readModeAP, totalTimeout => $totalTimeout, socketTimeout => $socketTimeout, sleepBetweenRetries => $sleepBetweenRetries, maxRetries => $maxRetries, predexp => $predexp, filterexp => $filterexp, compress => $compress, expiration => $expiration, generation => $generation, durableDelete => $durableDelete, respondAllOps => $respondAllOps, commitLevel => $commitLevel, generationPolicy => $generationPolicy, recordExistsAction => $recordExistsAction);
};
if ($@) {
    warn "Exception when calling DocumentAPIOperationsApi->appendDocumentObject: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DocumentAPIOperationsApi()
body =  # Object | 
recordBins =  # array[String] | Specify a set of bins to handle the JSONPath query.
jsonPath = jsonPath_example # String | JSONPath query parameter.
namespace = namespace_example # String | Namespace for the record; equivalent to database name.
key = key_example # String | User key for the record.
authorization = authorization_example # String |  (optional)
sendKey = true # Boolean | Send user defined key in addition to hash digest on both reads and writes. (optional)
replica = replica_example # String | Replica algorithm used to determine the target node for a single record command. (optional)
keytype = keytype_example # String | The Type of the userKey. (optional)
readModeSC = readModeSC_example # String | Read policy for SC (strong consistency) namespaces. Determines SC read consistency options. (optional)
readModeAP = readModeAP_example # String | Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode. (optional)
totalTimeout = 56 # Integer | Total transaction timeout in milliseconds. (optional)
socketTimeout = 56 # Integer | Socket idle timeout in milliseconds when processing a database command. (optional)
sleepBetweenRetries = 56 # Integer | Milliseconds to sleep between retries. (optional)
maxRetries = 56 # Integer | Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry. (optional)
predexp = predexp_example # String | Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored. (optional)
filterexp = filterexp_example # String | Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL. (optional)
compress = true # Boolean | Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes. (optional)
expiration = 56 # Integer | Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server. (optional)
generation = 56 # Integer | Expected generation. Generation is the number of times a record has been modified (including creation) on the server. (optional)
durableDelete = true # Boolean | If the transaction results in a record deletion, leave a tombstone for the record. (optional)
respondAllOps = true # Boolean | For client operate(), return a result for every operation. (optional)
commitLevel = commitLevel_example # String | Desired consistency guarantee when committing a transaction on the server. (optional)
generationPolicy = generationPolicy_example # String | Qualify how to handle record writes based on record generation. (optional)
recordExistsAction = recordExistsAction_example # String | How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods. (optional)

try: 
    # Append an object to a list in a document specified by a JSON path.
    api_instance.append_document_object(body, recordBins, jsonPath, namespace, key, authorization=authorization, sendKey=sendKey, replica=replica, keytype=keytype, readModeSC=readModeSC, readModeAP=readModeAP, totalTimeout=totalTimeout, socketTimeout=socketTimeout, sleepBetweenRetries=sleepBetweenRetries, maxRetries=maxRetries, predexp=predexp, filterexp=filterexp, compress=compress, expiration=expiration, generation=generation, durableDelete=durableDelete, respondAllOps=respondAllOps, commitLevel=commitLevel, generationPolicy=generationPolicy, recordExistsAction=recordExistsAction)
except ApiException as e:
    print("Exception when calling DocumentAPIOperationsApi->appendDocumentObject: %s\n" % e)

Parameters

Path parameters
Name Description
namespace*
String
Namespace for the record; equivalent to database name.
Required
key*
String
User key for the record.
Required
Header parameters
Name Description
Authorization
String
Body parameters
Name Description
body *
Query parameters
Name Description
sendKey
Boolean
Send user defined key in addition to hash digest on both reads and writes.
replica
String
Replica algorithm used to determine the target node for a single record command.
keytype
String
The Type of the userKey.
recordBins*
array[String]
Specify a set of bins to handle the JSONPath query.
Required
readModeSC
String
Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
readModeAP
String
Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
totalTimeout
Integer
Total transaction timeout in milliseconds.
socketTimeout
Integer
Socket idle timeout in milliseconds when processing a database command.
sleepBetweenRetries
Integer
Milliseconds to sleep between retries.
maxRetries
Integer
Maximum number of retries before aborting the current transaction. The initial attempt is not counted as a retry.
predexp
String
Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
filterexp
String
Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
compress
Boolean
Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
jsonPath*
String
JSONPath query parameter.
Required
expiration
Integer
Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server.
generation
Integer
Expected generation. Generation is the number of times a record has been modified (including creation) on the server.
durableDelete
Boolean
If the transaction results in a record deletion, leave a tombstone for the record.
respondAllOps
Boolean
For client operate(), return a result for every operation.
commitLevel
String
Desired consistency guarantee when committing a transaction on the server.
generationPolicy
String
Qualify how to handle record writes based on record generation.
recordExistsAction
String
How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods.

Responses

Status: 400 - Invalid parameters or request.

{"inDoubt":false,"message":"A message"}

Status: 403 - Not authorized to access the resource.

{"inDoubt":false,"message":"A message"}

Status: 404 - Record not found.

{"inDoubt":false,"message":"A message"}

appendDocumentObjectSet

Append an object to a list in a document specified by a JSON path.


/v1/document/{namespace}/{set}/{key}

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json,application/msgpack"\
-H "Content-Type: application/json"\
"http://localhost:8080/v1/document/{namespace}/{set}/{key}?sendKey=&replica=&keytype=&recordBins=&readModeSC=&readModeAP=&totalTimeout=&socketTimeout=&sleepBetweenRetries=&maxRetries=&predexp=&filterexp=&compress=&jsonPath=&expiration=&generation=&durableDelete=&respondAllOps=&commitLevel=&generationPolicy=&recordExistsAction="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DocumentAPIOperationsApi;

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

public class DocumentAPIOperationsApiExample {

    public static void main(String[] args) {
        
        DocumentAPIOperationsApi apiInstance = new DocumentAPIOperationsApi();
        Object body = ; // Object | 
        array[String] recordBins = ; // array[String] | Specify a set of bins to handle the JSONPath query.
        String jsonPath = jsonPath_example; // String | JSONPath query parameter.
        String namespace = namespace_example; // String | Namespace for the record; equivalent to database name.
        String set = set_example; // String | Set for the record; equivalent to database table.
        String key = key_example; // String | User key for the record.
        String authorization = authorization_example; // String | 
        Boolean sendKey = true; // Boolean | Send user defined key in addition to hash digest on both reads and writes.
        String replica = replica_example; // String | Replica algorithm used to determine the target node for a single record command.
        String keytype = keytype_example; // String | The Type of the userKey.
        String readModeSC = readModeSC_example; // String | Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
        String readModeAP = readModeAP_example; // String | Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
        Integer totalTimeout = 56; // Integer | Total transaction timeout in milliseconds.
        Integer socketTimeout = 56; // Integer | Socket idle timeout in milliseconds when processing a database command.
        Integer sleepBetweenRetries = 56; // Integer | Milliseconds to sleep between retries.
        Integer maxRetries = 56; // Integer | Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry.
        String predexp = predexp_example; // String | Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
        String filterexp = filterexp_example; // String | Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
        Boolean compress = true; // Boolean | Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
        Integer expiration = 56; // Integer | Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server.
        Integer generation = 56; // Integer | Expected generation. Generation is the number of times a record has been modified (including creation) on the server.
        Boolean durableDelete = true; // Boolean | If the transaction results in a record deletion, leave a tombstone for the record.
        Boolean respondAllOps = true; // Boolean | For client operate(), return a result for every operation.
        String commitLevel = commitLevel_example; // String | Desired consistency guarantee when committing a transaction on the server.
        String generationPolicy = generationPolicy_example; // String | Qualify how to handle record writes based on record generation.
        String recordExistsAction = recordExistsAction_example; // String | How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods.
        try {
            apiInstance.appendDocumentObjectSet(body, recordBins, jsonPath, namespace, set, key, authorization, sendKey, replica, keytype, readModeSC, readModeAP, totalTimeout, socketTimeout, sleepBetweenRetries, maxRetries, predexp, filterexp, compress, expiration, generation, durableDelete, respondAllOps, commitLevel, generationPolicy, recordExistsAction);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentAPIOperationsApi#appendDocumentObjectSet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DocumentAPIOperationsApi;

public class DocumentAPIOperationsApiExample {

    public static void main(String[] args) {
        DocumentAPIOperationsApi apiInstance = new DocumentAPIOperationsApi();
        Object body = ; // Object | 
        array[String] recordBins = ; // array[String] | Specify a set of bins to handle the JSONPath query.
        String jsonPath = jsonPath_example; // String | JSONPath query parameter.
        String namespace = namespace_example; // String | Namespace for the record; equivalent to database name.
        String set = set_example; // String | Set for the record; equivalent to database table.
        String key = key_example; // String | User key for the record.
        String authorization = authorization_example; // String | 
        Boolean sendKey = true; // Boolean | Send user defined key in addition to hash digest on both reads and writes.
        String replica = replica_example; // String | Replica algorithm used to determine the target node for a single record command.
        String keytype = keytype_example; // String | The Type of the userKey.
        String readModeSC = readModeSC_example; // String | Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
        String readModeAP = readModeAP_example; // String | Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
        Integer totalTimeout = 56; // Integer | Total transaction timeout in milliseconds.
        Integer socketTimeout = 56; // Integer | Socket idle timeout in milliseconds when processing a database command.
        Integer sleepBetweenRetries = 56; // Integer | Milliseconds to sleep between retries.
        Integer maxRetries = 56; // Integer | Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry.
        String predexp = predexp_example; // String | Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
        String filterexp = filterexp_example; // String | Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
        Boolean compress = true; // Boolean | Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
        Integer expiration = 56; // Integer | Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server.
        Integer generation = 56; // Integer | Expected generation. Generation is the number of times a record has been modified (including creation) on the server.
        Boolean durableDelete = true; // Boolean | If the transaction results in a record deletion, leave a tombstone for the record.
        Boolean respondAllOps = true; // Boolean | For client operate(), return a result for every operation.
        String commitLevel = commitLevel_example; // String | Desired consistency guarantee when committing a transaction on the server.
        String generationPolicy = generationPolicy_example; // String | Qualify how to handle record writes based on record generation.
        String recordExistsAction = recordExistsAction_example; // String | How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods.
        try {
            apiInstance.appendDocumentObjectSet(body, recordBins, jsonPath, namespace, set, key, authorization, sendKey, replica, keytype, readModeSC, readModeAP, totalTimeout, socketTimeout, sleepBetweenRetries, maxRetries, predexp, filterexp, compress, expiration, generation, durableDelete, respondAllOps, commitLevel, generationPolicy, recordExistsAction);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentAPIOperationsApi#appendDocumentObjectSet");
            e.printStackTrace();
        }
    }
}
Object *body = ; // 
array[String] *recordBins = ; // Specify a set of bins to handle the JSONPath query.
String *jsonPath = jsonPath_example; // JSONPath query parameter.
String *namespace = namespace_example; // Namespace for the record; equivalent to database name.
String *set = set_example; // Set for the record; equivalent to database table.
String *key = key_example; // User key for the record.
String *authorization = authorization_example; //  (optional)
Boolean *sendKey = true; // Send user defined key in addition to hash digest on both reads and writes. (optional)
String *replica = replica_example; // Replica algorithm used to determine the target node for a single record command. (optional)
String *keytype = keytype_example; // The Type of the userKey. (optional)
String *readModeSC = readModeSC_example; // Read policy for SC (strong consistency) namespaces. Determines SC read consistency options. (optional)
String *readModeAP = readModeAP_example; // Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode. (optional)
Integer *totalTimeout = 56; // Total transaction timeout in milliseconds. (optional)
Integer *socketTimeout = 56; // Socket idle timeout in milliseconds when processing a database command. (optional)
Integer *sleepBetweenRetries = 56; // Milliseconds to sleep between retries. (optional)
Integer *maxRetries = 56; // Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry. (optional)
String *predexp = predexp_example; // Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored. (optional)
String *filterexp = filterexp_example; // Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL. (optional)
Boolean *compress = true; // Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes. (optional)
Integer *expiration = 56; // Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server. (optional)
Integer *generation = 56; // Expected generation. Generation is the number of times a record has been modified (including creation) on the server. (optional)
Boolean *durableDelete = true; // If the transaction results in a record deletion, leave a tombstone for the record. (optional)
Boolean *respondAllOps = true; // For client operate(), return a result for every operation. (optional)
String *commitLevel = commitLevel_example; // Desired consistency guarantee when committing a transaction on the server. (optional)
String *generationPolicy = generationPolicy_example; // Qualify how to handle record writes based on record generation. (optional)
String *recordExistsAction = recordExistsAction_example; // How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods. (optional)

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

// Append an object to a list in a document specified by a JSON path.
[apiInstance appendDocumentObjectSetWith:body
    recordBins:recordBins
    jsonPath:jsonPath
    namespace:namespace
    set:set
    key:key
    authorization:authorization
    sendKey:sendKey
    replica:replica
    keytype:keytype
    readModeSC:readModeSC
    readModeAP:readModeAP
    totalTimeout:totalTimeout
    socketTimeout:socketTimeout
    sleepBetweenRetries:sleepBetweenRetries
    maxRetries:maxRetries
    predexp:predexp
    filterexp:filterexp
    compress:compress
    expiration:expiration
    generation:generation
    durableDelete:durableDelete
    respondAllOps:respondAllOps
    commitLevel:commitLevel
    generationPolicy:generationPolicy
    recordExistsAction:recordExistsAction
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AerospikeRestClient = require('aerospike_rest_client');

var api = new AerospikeRestClient.DocumentAPIOperationsApi()
var body = ; // {{Object}} 
var recordBins = ; // {{array[String]}} Specify a set of bins to handle the JSONPath query.
var jsonPath = jsonPath_example; // {{String}} JSONPath query parameter.
var namespace = namespace_example; // {{String}} Namespace for the record; equivalent to database name.
var set = set_example; // {{String}} Set for the record; equivalent to database table.
var key = key_example; // {{String}} User key for the record.
var opts = { 
  'authorization': authorization_example // {{String}} 
  'sendKey': true // {{Boolean}} Send user defined key in addition to hash digest on both reads and writes.
  'replica': replica_example // {{String}} Replica algorithm used to determine the target node for a single record command.
  'keytype': keytype_example // {{String}} The Type of the userKey.
  'readModeSC': readModeSC_example // {{String}} Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
  'readModeAP': readModeAP_example // {{String}} Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
  'totalTimeout': 56 // {{Integer}} Total transaction timeout in milliseconds.
  'socketTimeout': 56 // {{Integer}} Socket idle timeout in milliseconds when processing a database command.
  'sleepBetweenRetries': 56 // {{Integer}} Milliseconds to sleep between retries.
  'maxRetries': 56 // {{Integer}} Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry.
  'predexp': predexp_example // {{String}} Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
  'filterexp': filterexp_example // {{String}} Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
  'compress': true // {{Boolean}} Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
  'expiration': 56 // {{Integer}} Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server.
  'generation': 56 // {{Integer}} Expected generation. Generation is the number of times a record has been modified (including creation) on the server.
  'durableDelete': true // {{Boolean}} If the transaction results in a record deletion, leave a tombstone for the record.
  'respondAllOps': true // {{Boolean}} For client operate(), return a result for every operation.
  'commitLevel': commitLevel_example // {{String}} Desired consistency guarantee when committing a transaction on the server.
  'generationPolicy': generationPolicy_example // {{String}} Qualify how to handle record writes based on record generation.
  'recordExistsAction': recordExistsAction_example // {{String}} How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.appendDocumentObjectSet(bodyrecordBinsjsonPathnamespacesetkey, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DocumentAPIOperationsApi();
            var body = new Object(); // Object | 
            var recordBins = new array[String](); // array[String] | Specify a set of bins to handle the JSONPath query.
            var jsonPath = jsonPath_example;  // String | JSONPath query parameter.
            var namespace = namespace_example;  // String | Namespace for the record; equivalent to database name.
            var set = set_example;  // String | Set for the record; equivalent to database table.
            var key = key_example;  // String | User key for the record.
            var authorization = authorization_example;  // String |  (optional) 
            var sendKey = true;  // Boolean | Send user defined key in addition to hash digest on both reads and writes. (optional) 
            var replica = replica_example;  // String | Replica algorithm used to determine the target node for a single record command. (optional) 
            var keytype = keytype_example;  // String | The Type of the userKey. (optional) 
            var readModeSC = readModeSC_example;  // String | Read policy for SC (strong consistency) namespaces. Determines SC read consistency options. (optional) 
            var readModeAP = readModeAP_example;  // String | Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode. (optional) 
            var totalTimeout = 56;  // Integer | Total transaction timeout in milliseconds. (optional) 
            var socketTimeout = 56;  // Integer | Socket idle timeout in milliseconds when processing a database command. (optional) 
            var sleepBetweenRetries = 56;  // Integer | Milliseconds to sleep between retries. (optional) 
            var maxRetries = 56;  // Integer | Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry. (optional) 
            var predexp = predexp_example;  // String | Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored. (optional) 
            var filterexp = filterexp_example;  // String | Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL. (optional) 
            var compress = true;  // Boolean | Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes. (optional) 
            var expiration = 56;  // Integer | Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server. (optional) 
            var generation = 56;  // Integer | Expected generation. Generation is the number of times a record has been modified (including creation) on the server. (optional) 
            var durableDelete = true;  // Boolean | If the transaction results in a record deletion, leave a tombstone for the record. (optional) 
            var respondAllOps = true;  // Boolean | For client operate(), return a result for every operation. (optional) 
            var commitLevel = commitLevel_example;  // String | Desired consistency guarantee when committing a transaction on the server. (optional) 
            var generationPolicy = generationPolicy_example;  // String | Qualify how to handle record writes based on record generation. (optional) 
            var recordExistsAction = recordExistsAction_example;  // String | How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods. (optional) 

            try
            {
                // Append an object to a list in a document specified by a JSON path.
                apiInstance.appendDocumentObjectSet(body, recordBins, jsonPath, namespace, set, key, authorization, sendKey, replica, keytype, readModeSC, readModeAP, totalTimeout, socketTimeout, sleepBetweenRetries, maxRetries, predexp, filterexp, compress, expiration, generation, durableDelete, respondAllOps, commitLevel, generationPolicy, recordExistsAction);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DocumentAPIOperationsApi.appendDocumentObjectSet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDocumentAPIOperationsApi();
$body = ; // Object | 
$recordBins = ; // array[String] | Specify a set of bins to handle the JSONPath query.
$jsonPath = jsonPath_example; // String | JSONPath query parameter.
$namespace = namespace_example; // String | Namespace for the record; equivalent to database name.
$set = set_example; // String | Set for the record; equivalent to database table.
$key = key_example; // String | User key for the record.
$authorization = authorization_example; // String | 
$sendKey = true; // Boolean | Send user defined key in addition to hash digest on both reads and writes.
$replica = replica_example; // String | Replica algorithm used to determine the target node for a single record command.
$keytype = keytype_example; // String | The Type of the userKey.
$readModeSC = readModeSC_example; // String | Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
$readModeAP = readModeAP_example; // String | Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
$totalTimeout = 56; // Integer | Total transaction timeout in milliseconds.
$socketTimeout = 56; // Integer | Socket idle timeout in milliseconds when processing a database command.
$sleepBetweenRetries = 56; // Integer | Milliseconds to sleep between retries.
$maxRetries = 56; // Integer | Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry.
$predexp = predexp_example; // String | Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
$filterexp = filterexp_example; // String | Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
$compress = true; // Boolean | Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
$expiration = 56; // Integer | Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server.
$generation = 56; // Integer | Expected generation. Generation is the number of times a record has been modified (including creation) on the server.
$durableDelete = true; // Boolean | If the transaction results in a record deletion, leave a tombstone for the record.
$respondAllOps = true; // Boolean | For client operate(), return a result for every operation.
$commitLevel = commitLevel_example; // String | Desired consistency guarantee when committing a transaction on the server.
$generationPolicy = generationPolicy_example; // String | Qualify how to handle record writes based on record generation.
$recordExistsAction = recordExistsAction_example; // String | How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods.

try {
    $api_instance->appendDocumentObjectSet($body, $recordBins, $jsonPath, $namespace, $set, $key, $authorization, $sendKey, $replica, $keytype, $readModeSC, $readModeAP, $totalTimeout, $socketTimeout, $sleepBetweenRetries, $maxRetries, $predexp, $filterexp, $compress, $expiration, $generation, $durableDelete, $respondAllOps, $commitLevel, $generationPolicy, $recordExistsAction);
} catch (Exception $e) {
    echo 'Exception when calling DocumentAPIOperationsApi->appendDocumentObjectSet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DocumentAPIOperationsApi;

my $api_instance = WWW::SwaggerClient::DocumentAPIOperationsApi->new();
my $body = WWW::SwaggerClient::Object::Object->new(); # Object | 
my $recordBins = []; # array[String] | Specify a set of bins to handle the JSONPath query.
my $jsonPath = jsonPath_example; # String | JSONPath query parameter.
my $namespace = namespace_example; # String | Namespace for the record; equivalent to database name.
my $set = set_example; # String | Set for the record; equivalent to database table.
my $key = key_example; # String | User key for the record.
my $authorization = authorization_example; # String | 
my $sendKey = true; # Boolean | Send user defined key in addition to hash digest on both reads and writes.
my $replica = replica_example; # String | Replica algorithm used to determine the target node for a single record command.
my $keytype = keytype_example; # String | The Type of the userKey.
my $readModeSC = readModeSC_example; # String | Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
my $readModeAP = readModeAP_example; # String | Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
my $totalTimeout = 56; # Integer | Total transaction timeout in milliseconds.
my $socketTimeout = 56; # Integer | Socket idle timeout in milliseconds when processing a database command.
my $sleepBetweenRetries = 56; # Integer | Milliseconds to sleep between retries.
my $maxRetries = 56; # Integer | Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry.
my $predexp = predexp_example; # String | Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
my $filterexp = filterexp_example; # String | Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
my $compress = true; # Boolean | Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
my $expiration = 56; # Integer | Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server.
my $generation = 56; # Integer | Expected generation. Generation is the number of times a record has been modified (including creation) on the server.
my $durableDelete = true; # Boolean | If the transaction results in a record deletion, leave a tombstone for the record.
my $respondAllOps = true; # Boolean | For client operate(), return a result for every operation.
my $commitLevel = commitLevel_example; # String | Desired consistency guarantee when committing a transaction on the server.
my $generationPolicy = generationPolicy_example; # String | Qualify how to handle record writes based on record generation.
my $recordExistsAction = recordExistsAction_example; # String | How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods.

eval { 
    $api_instance->appendDocumentObjectSet(body => $body, recordBins => $recordBins, jsonPath => $jsonPath, namespace => $namespace, set => $set, key => $key, authorization => $authorization, sendKey => $sendKey, replica => $replica, keytype => $keytype, readModeSC => $readModeSC, readModeAP => $readModeAP, totalTimeout => $totalTimeout, socketTimeout => $socketTimeout, sleepBetweenRetries => $sleepBetweenRetries, maxRetries => $maxRetries, predexp => $predexp, filterexp => $filterexp, compress => $compress, expiration => $expiration, generation => $generation, durableDelete => $durableDelete, respondAllOps => $respondAllOps, commitLevel => $commitLevel, generationPolicy => $generationPolicy, recordExistsAction => $recordExistsAction);
};
if ($@) {
    warn "Exception when calling DocumentAPIOperationsApi->appendDocumentObjectSet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DocumentAPIOperationsApi()
body =  # Object | 
recordBins =  # array[String] | Specify a set of bins to handle the JSONPath query.
jsonPath = jsonPath_example # String | JSONPath query parameter.
namespace = namespace_example # String | Namespace for the record; equivalent to database name.
set = set_example # String | Set for the record; equivalent to database table.
key = key_example # String | User key for the record.
authorization = authorization_example # String |  (optional)
sendKey = true # Boolean | Send user defined key in addition to hash digest on both reads and writes. (optional)
replica = replica_example # String | Replica algorithm used to determine the target node for a single record command. (optional)
keytype = keytype_example # String | The Type of the userKey. (optional)
readModeSC = readModeSC_example # String | Read policy for SC (strong consistency) namespaces. Determines SC read consistency options. (optional)
readModeAP = readModeAP_example # String | Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode. (optional)
totalTimeout = 56 # Integer | Total transaction timeout in milliseconds. (optional)
socketTimeout = 56 # Integer | Socket idle timeout in milliseconds when processing a database command. (optional)
sleepBetweenRetries = 56 # Integer | Milliseconds to sleep between retries. (optional)
maxRetries = 56 # Integer | Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry. (optional)
predexp = predexp_example # String | Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored. (optional)
filterexp = filterexp_example # String | Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL. (optional)
compress = true # Boolean | Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes. (optional)
expiration = 56 # Integer | Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server. (optional)
generation = 56 # Integer | Expected generation. Generation is the number of times a record has been modified (including creation) on the server. (optional)
durableDelete = true # Boolean | If the transaction results in a record deletion, leave a tombstone for the record. (optional)
respondAllOps = true # Boolean | For client operate(), return a result for every operation. (optional)
commitLevel = commitLevel_example # String | Desired consistency guarantee when committing a transaction on the server. (optional)
generationPolicy = generationPolicy_example # String | Qualify how to handle record writes based on record generation. (optional)
recordExistsAction = recordExistsAction_example # String | How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods. (optional)

try: 
    # Append an object to a list in a document specified by a JSON path.
    api_instance.append_document_object_set(body, recordBins, jsonPath, namespace, set, key, authorization=authorization, sendKey=sendKey, replica=replica, keytype=keytype, readModeSC=readModeSC, readModeAP=readModeAP, totalTimeout=totalTimeout, socketTimeout=socketTimeout, sleepBetweenRetries=sleepBetweenRetries, maxRetries=maxRetries, predexp=predexp, filterexp=filterexp, compress=compress, expiration=expiration, generation=generation, durableDelete=durableDelete, respondAllOps=respondAllOps, commitLevel=commitLevel, generationPolicy=generationPolicy, recordExistsAction=recordExistsAction)
except ApiException as e:
    print("Exception when calling DocumentAPIOperationsApi->appendDocumentObjectSet: %s\n" % e)

Parameters

Path parameters
Name Description
namespace*
String
Namespace for the record; equivalent to database name.
Required
set*
String
Set for the record; equivalent to database table.
Required
key*
String
User key for the record.
Required
Header parameters
Name Description
Authorization
String
Body parameters
Name Description
body *
Query parameters
Name Description
sendKey
Boolean
Send user defined key in addition to hash digest on both reads and writes.
replica
String
Replica algorithm used to determine the target node for a single record command.
keytype
String
The Type of the userKey.
recordBins*
array[String]
Specify a set of bins to handle the JSONPath query.
Required
readModeSC
String
Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
readModeAP
String
Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
totalTimeout
Integer
Total transaction timeout in milliseconds.
socketTimeout
Integer
Socket idle timeout in milliseconds when processing a database command.
sleepBetweenRetries
Integer
Milliseconds to sleep between retries.
maxRetries
Integer
Maximum number of retries before aborting the current transaction. The initial attempt is not counted as a retry.
predexp
String
Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
filterexp
String
Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
compress
Boolean
Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
jsonPath*
String
JSONPath query parameter.
Required
expiration
Integer
Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server.
generation
Integer
Expected generation. Generation is the number of times a record has been modified (including creation) on the server.
durableDelete
Boolean
If the transaction results in a record deletion, leave a tombstone for the record.
respondAllOps
Boolean
For client operate(), return a result for every operation.
commitLevel
String
Desired consistency guarantee when committing a transaction on the server.
generationPolicy
String
Qualify how to handle record writes based on record generation.
recordExistsAction
String
How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods.

Responses

Status: 400 - Invalid parameters or request.

{"inDoubt":false,"message":"A message"}

Status: 403 - Not authorized to access the resource.

{"inDoubt":false,"message":"A message"}

Status: 404 - Record not found.

{"inDoubt":false,"message":"A message"}

deleteDocumentObject

Delete an object in a document specified by a JSON path.


/v1/document/{namespace}/{key}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json,application/msgpack"\
"http://localhost:8080/v1/document/{namespace}/{key}?sendKey=&replica=&keytype=&recordBins=&readModeSC=&readModeAP=&totalTimeout=&socketTimeout=&sleepBetweenRetries=&maxRetries=&predexp=&filterexp=&compress=&jsonPath=&expiration=&generation=&durableDelete=&respondAllOps=&commitLevel=&generationPolicy=&recordExistsAction="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DocumentAPIOperationsApi;

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

public class DocumentAPIOperationsApiExample {

    public static void main(String[] args) {
        
        DocumentAPIOperationsApi apiInstance = new DocumentAPIOperationsApi();
        String namespace = namespace_example; // String | Namespace for the record; equivalent to database name.
        String key = key_example; // String | User key for the record.
        array[String] recordBins = ; // array[String] | Specify a set of bins to handle the JSONPath query.
        String jsonPath = jsonPath_example; // String | JSONPath query parameter.
        String authorization = authorization_example; // String | 
        Boolean sendKey = true; // Boolean | Send user defined key in addition to hash digest on both reads and writes.
        String replica = replica_example; // String | Replica algorithm used to determine the target node for a single record command.
        String keytype = keytype_example; // String | The Type of the userKey.
        String readModeSC = readModeSC_example; // String | Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
        String readModeAP = readModeAP_example; // String | Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
        Integer totalTimeout = 56; // Integer | Total transaction timeout in milliseconds.
        Integer socketTimeout = 56; // Integer | Socket idle timeout in milliseconds when processing a database command.
        Integer sleepBetweenRetries = 56; // Integer | Milliseconds to sleep between retries.
        Integer maxRetries = 56; // Integer | Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry.
        String predexp = predexp_example; // String | Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
        String filterexp = filterexp_example; // String | Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
        Boolean compress = true; // Boolean | Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
        Integer expiration = 56; // Integer | Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server.
        Integer generation = 56; // Integer | Expected generation. Generation is the number of times a record has been modified (including creation) on the server.
        Boolean durableDelete = true; // Boolean | If the transaction results in a record deletion, leave a tombstone for the record.
        Boolean respondAllOps = true; // Boolean | For client operate(), return a result for every operation.
        String commitLevel = commitLevel_example; // String | Desired consistency guarantee when committing a transaction on the server.
        String generationPolicy = generationPolicy_example; // String | Qualify how to handle record writes based on record generation.
        String recordExistsAction = recordExistsAction_example; // String | How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods.
        try {
            apiInstance.deleteDocumentObject(namespace, key, recordBins, jsonPath, authorization, sendKey, replica, keytype, readModeSC, readModeAP, totalTimeout, socketTimeout, sleepBetweenRetries, maxRetries, predexp, filterexp, compress, expiration, generation, durableDelete, respondAllOps, commitLevel, generationPolicy, recordExistsAction);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentAPIOperationsApi#deleteDocumentObject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DocumentAPIOperationsApi;

public class DocumentAPIOperationsApiExample {

    public static void main(String[] args) {
        DocumentAPIOperationsApi apiInstance = new DocumentAPIOperationsApi();
        String namespace = namespace_example; // String | Namespace for the record; equivalent to database name.
        String key = key_example; // String | User key for the record.
        array[String] recordBins = ; // array[String] | Specify a set of bins to handle the JSONPath query.
        String jsonPath = jsonPath_example; // String | JSONPath query parameter.
        String authorization = authorization_example; // String | 
        Boolean sendKey = true; // Boolean | Send user defined key in addition to hash digest on both reads and writes.
        String replica = replica_example; // String | Replica algorithm used to determine the target node for a single record command.
        String keytype = keytype_example; // String | The Type of the userKey.
        String readModeSC = readModeSC_example; // String | Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
        String readModeAP = readModeAP_example; // String | Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
        Integer totalTimeout = 56; // Integer | Total transaction timeout in milliseconds.
        Integer socketTimeout = 56; // Integer | Socket idle timeout in milliseconds when processing a database command.
        Integer sleepBetweenRetries = 56; // Integer | Milliseconds to sleep between retries.
        Integer maxRetries = 56; // Integer | Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry.
        String predexp = predexp_example; // String | Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
        String filterexp = filterexp_example; // String | Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
        Boolean compress = true; // Boolean | Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
        Integer expiration = 56; // Integer | Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server.
        Integer generation = 56; // Integer | Expected generation. Generation is the number of times a record has been modified (including creation) on the server.
        Boolean durableDelete = true; // Boolean | If the transaction results in a record deletion, leave a tombstone for the record.
        Boolean respondAllOps = true; // Boolean | For client operate(), return a result for every operation.
        String commitLevel = commitLevel_example; // String | Desired consistency guarantee when committing a transaction on the server.
        String generationPolicy = generationPolicy_example; // String | Qualify how to handle record writes based on record generation.
        String recordExistsAction = recordExistsAction_example; // String | How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods.
        try {
            apiInstance.deleteDocumentObject(namespace, key, recordBins, jsonPath, authorization, sendKey, replica, keytype, readModeSC, readModeAP, totalTimeout, socketTimeout, sleepBetweenRetries, maxRetries, predexp, filterexp, compress, expiration, generation, durableDelete, respondAllOps, commitLevel, generationPolicy, recordExistsAction);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentAPIOperationsApi#deleteDocumentObject");
            e.printStackTrace();
        }
    }
}
String *namespace = namespace_example; // Namespace for the record; equivalent to database name.
String *key = key_example; // User key for the record.
array[String] *recordBins = ; // Specify a set of bins to handle the JSONPath query.
String *jsonPath = jsonPath_example; // JSONPath query parameter.
String *authorization = authorization_example; //  (optional)
Boolean *sendKey = true; // Send user defined key in addition to hash digest on both reads and writes. (optional)
String *replica = replica_example; // Replica algorithm used to determine the target node for a single record command. (optional)
String *keytype = keytype_example; // The Type of the userKey. (optional)
String *readModeSC = readModeSC_example; // Read policy for SC (strong consistency) namespaces. Determines SC read consistency options. (optional)
String *readModeAP = readModeAP_example; // Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode. (optional)
Integer *totalTimeout = 56; // Total transaction timeout in milliseconds. (optional)
Integer *socketTimeout = 56; // Socket idle timeout in milliseconds when processing a database command. (optional)
Integer *sleepBetweenRetries = 56; // Milliseconds to sleep between retries. (optional)
Integer *maxRetries = 56; // Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry. (optional)
String *predexp = predexp_example; // Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored. (optional)
String *filterexp = filterexp_example; // Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL. (optional)
Boolean *compress = true; // Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes. (optional)
Integer *expiration = 56; // Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server. (optional)
Integer *generation = 56; // Expected generation. Generation is the number of times a record has been modified (including creation) on the server. (optional)
Boolean *durableDelete = true; // If the transaction results in a record deletion, leave a tombstone for the record. (optional)
Boolean *respondAllOps = true; // For client operate(), return a result for every operation. (optional)
String *commitLevel = commitLevel_example; // Desired consistency guarantee when committing a transaction on the server. (optional)
String *generationPolicy = generationPolicy_example; // Qualify how to handle record writes based on record generation. (optional)
String *recordExistsAction = recordExistsAction_example; // How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods. (optional)

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

// Delete an object in a document specified by a JSON path.
[apiInstance deleteDocumentObjectWith:namespace
    key:key
    recordBins:recordBins
    jsonPath:jsonPath
    authorization:authorization
    sendKey:sendKey
    replica:replica
    keytype:keytype
    readModeSC:readModeSC
    readModeAP:readModeAP
    totalTimeout:totalTimeout
    socketTimeout:socketTimeout
    sleepBetweenRetries:sleepBetweenRetries
    maxRetries:maxRetries
    predexp:predexp
    filterexp:filterexp
    compress:compress
    expiration:expiration
    generation:generation
    durableDelete:durableDelete
    respondAllOps:respondAllOps
    commitLevel:commitLevel
    generationPolicy:generationPolicy
    recordExistsAction:recordExistsAction
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AerospikeRestClient = require('aerospike_rest_client');

var api = new AerospikeRestClient.DocumentAPIOperationsApi()
var namespace = namespace_example; // {{String}} Namespace for the record; equivalent to database name.
var key = key_example; // {{String}} User key for the record.
var recordBins = ; // {{array[String]}} Specify a set of bins to handle the JSONPath query.
var jsonPath = jsonPath_example; // {{String}} JSONPath query parameter.
var opts = { 
  'authorization': authorization_example, // {{String}} 
  'sendKey': true, // {{Boolean}} Send user defined key in addition to hash digest on both reads and writes.
  'replica': replica_example, // {{String}} Replica algorithm used to determine the target node for a single record command.
  'keytype': keytype_example, // {{String}} The Type of the userKey.
  'readModeSC': readModeSC_example, // {{String}} Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
  'readModeAP': readModeAP_example, // {{String}} Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
  'totalTimeout': 56, // {{Integer}} Total transaction timeout in milliseconds.
  'socketTimeout': 56, // {{Integer}} Socket idle timeout in milliseconds when processing a database command.
  'sleepBetweenRetries': 56, // {{Integer}} Milliseconds to sleep between retries.
  'maxRetries': 56, // {{Integer}} Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry.
  'predexp': predexp_example, // {{String}} Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
  'filterexp': filterexp_example, // {{String}} Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
  'compress': true, // {{Boolean}} Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
  'expiration': 56, // {{Integer}} Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server.
  'generation': 56, // {{Integer}} Expected generation. Generation is the number of times a record has been modified (including creation) on the server.
  'durableDelete': true, // {{Boolean}} If the transaction results in a record deletion, leave a tombstone for the record.
  'respondAllOps': true, // {{Boolean}} For client operate(), return a result for every operation.
  'commitLevel': commitLevel_example, // {{String}} Desired consistency guarantee when committing a transaction on the server.
  'generationPolicy': generationPolicy_example, // {{String}} Qualify how to handle record writes based on record generation.
  'recordExistsAction': recordExistsAction_example // {{String}} How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteDocumentObject(namespace, key, recordBins, jsonPath, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DocumentAPIOperationsApi();
            var namespace = namespace_example;  // String | Namespace for the record; equivalent to database name.
            var key = key_example;  // String | User key for the record.
            var recordBins = new array[String](); // array[String] | Specify a set of bins to handle the JSONPath query.
            var jsonPath = jsonPath_example;  // String | JSONPath query parameter.
            var authorization = authorization_example;  // String |  (optional) 
            var sendKey = true;  // Boolean | Send user defined key in addition to hash digest on both reads and writes. (optional) 
            var replica = replica_example;  // String | Replica algorithm used to determine the target node for a single record command. (optional) 
            var keytype = keytype_example;  // String | The Type of the userKey. (optional) 
            var readModeSC = readModeSC_example;  // String | Read policy for SC (strong consistency) namespaces. Determines SC read consistency options. (optional) 
            var readModeAP = readModeAP_example;  // String | Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode. (optional) 
            var totalTimeout = 56;  // Integer | Total transaction timeout in milliseconds. (optional) 
            var socketTimeout = 56;  // Integer | Socket idle timeout in milliseconds when processing a database command. (optional) 
            var sleepBetweenRetries = 56;  // Integer | Milliseconds to sleep between retries. (optional) 
            var maxRetries = 56;  // Integer | Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry. (optional) 
            var predexp = predexp_example;  // String | Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored. (optional) 
            var filterexp = filterexp_example;  // String | Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL. (optional) 
            var compress = true;  // Boolean | Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes. (optional) 
            var expiration = 56;  // Integer | Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server. (optional) 
            var generation = 56;  // Integer | Expected generation. Generation is the number of times a record has been modified (including creation) on the server. (optional) 
            var durableDelete = true;  // Boolean | If the transaction results in a record deletion, leave a tombstone for the record. (optional) 
            var respondAllOps = true;  // Boolean | For client operate(), return a result for every operation. (optional) 
            var commitLevel = commitLevel_example;  // String | Desired consistency guarantee when committing a transaction on the server. (optional) 
            var generationPolicy = generationPolicy_example;  // String | Qualify how to handle record writes based on record generation. (optional) 
            var recordExistsAction = recordExistsAction_example;  // String | How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods. (optional) 

            try
            {
                // Delete an object in a document specified by a JSON path.
                apiInstance.deleteDocumentObject(namespace, key, recordBins, jsonPath, authorization, sendKey, replica, keytype, readModeSC, readModeAP, totalTimeout, socketTimeout, sleepBetweenRetries, maxRetries, predexp, filterexp, compress, expiration, generation, durableDelete, respondAllOps, commitLevel, generationPolicy, recordExistsAction);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DocumentAPIOperationsApi.deleteDocumentObject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDocumentAPIOperationsApi();
$namespace = namespace_example; // String | Namespace for the record; equivalent to database name.
$key = key_example; // String | User key for the record.
$recordBins = ; // array[String] | Specify a set of bins to handle the JSONPath query.
$jsonPath = jsonPath_example; // String | JSONPath query parameter.
$authorization = authorization_example; // String | 
$sendKey = true; // Boolean | Send user defined key in addition to hash digest on both reads and writes.
$replica = replica_example; // String | Replica algorithm used to determine the target node for a single record command.
$keytype = keytype_example; // String | The Type of the userKey.
$readModeSC = readModeSC_example; // String | Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
$readModeAP = readModeAP_example; // String | Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
$totalTimeout = 56; // Integer | Total transaction timeout in milliseconds.
$socketTimeout = 56; // Integer | Socket idle timeout in milliseconds when processing a database command.
$sleepBetweenRetries = 56; // Integer | Milliseconds to sleep between retries.
$maxRetries = 56; // Integer | Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry.
$predexp = predexp_example; // String | Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
$filterexp = filterexp_example; // String | Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
$compress = true; // Boolean | Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
$expiration = 56; // Integer | Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server.
$generation = 56; // Integer | Expected generation. Generation is the number of times a record has been modified (including creation) on the server.
$durableDelete = true; // Boolean | If the transaction results in a record deletion, leave a tombstone for the record.
$respondAllOps = true; // Boolean | For client operate(), return a result for every operation.
$commitLevel = commitLevel_example; // String | Desired consistency guarantee when committing a transaction on the server.
$generationPolicy = generationPolicy_example; // String | Qualify how to handle record writes based on record generation.
$recordExistsAction = recordExistsAction_example; // String | How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods.

try {
    $api_instance->deleteDocumentObject($namespace, $key, $recordBins, $jsonPath, $authorization, $sendKey, $replica, $keytype, $readModeSC, $readModeAP, $totalTimeout, $socketTimeout, $sleepBetweenRetries, $maxRetries, $predexp, $filterexp, $compress, $expiration, $generation, $durableDelete, $respondAllOps, $commitLevel, $generationPolicy, $recordExistsAction);
} catch (Exception $e) {
    echo 'Exception when calling DocumentAPIOperationsApi->deleteDocumentObject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DocumentAPIOperationsApi;

my $api_instance = WWW::SwaggerClient::DocumentAPIOperationsApi->new();
my $namespace = namespace_example; # String | Namespace for the record; equivalent to database name.
my $key = key_example; # String | User key for the record.
my $recordBins = []; # array[String] | Specify a set of bins to handle the JSONPath query.
my $jsonPath = jsonPath_example; # String | JSONPath query parameter.
my $authorization = authorization_example; # String | 
my $sendKey = true; # Boolean | Send user defined key in addition to hash digest on both reads and writes.
my $replica = replica_example; # String | Replica algorithm used to determine the target node for a single record command.
my $keytype = keytype_example; # String | The Type of the userKey.
my $readModeSC = readModeSC_example; # String | Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
my $readModeAP = readModeAP_example; # String | Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
my $totalTimeout = 56; # Integer | Total transaction timeout in milliseconds.
my $socketTimeout = 56; # Integer | Socket idle timeout in milliseconds when processing a database command.
my $sleepBetweenRetries = 56; # Integer | Milliseconds to sleep between retries.
my $maxRetries = 56; # Integer | Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry.
my $predexp = predexp_example; # String | Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
my $filterexp = filterexp_example; # String | Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
my $compress = true; # Boolean | Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
my $expiration = 56; # Integer | Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server.
my $generation = 56; # Integer | Expected generation. Generation is the number of times a record has been modified (including creation) on the server.
my $durableDelete = true; # Boolean | If the transaction results in a record deletion, leave a tombstone for the record.
my $respondAllOps = true; # Boolean | For client operate(), return a result for every operation.
my $commitLevel = commitLevel_example; # String | Desired consistency guarantee when committing a transaction on the server.
my $generationPolicy = generationPolicy_example; # String | Qualify how to handle record writes based on record generation.
my $recordExistsAction = recordExistsAction_example; # String | How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods.

eval { 
    $api_instance->deleteDocumentObject(namespace => $namespace, key => $key, recordBins => $recordBins, jsonPath => $jsonPath, authorization => $authorization, sendKey => $sendKey, replica => $replica, keytype => $keytype, readModeSC => $readModeSC, readModeAP => $readModeAP, totalTimeout => $totalTimeout, socketTimeout => $socketTimeout, sleepBetweenRetries => $sleepBetweenRetries, maxRetries => $maxRetries, predexp => $predexp, filterexp => $filterexp, compress => $compress, expiration => $expiration, generation => $generation, durableDelete => $durableDelete, respondAllOps => $respondAllOps, commitLevel => $commitLevel, generationPolicy => $generationPolicy, recordExistsAction => $recordExistsAction);
};
if ($@) {
    warn "Exception when calling DocumentAPIOperationsApi->deleteDocumentObject: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DocumentAPIOperationsApi()
namespace = namespace_example # String | Namespace for the record; equivalent to database name.
key = key_example # String | User key for the record.
recordBins =  # array[String] | Specify a set of bins to handle the JSONPath query.
jsonPath = jsonPath_example # String | JSONPath query parameter.
authorization = authorization_example # String |  (optional)
sendKey = true # Boolean | Send user defined key in addition to hash digest on both reads and writes. (optional)
replica = replica_example # String | Replica algorithm used to determine the target node for a single record command. (optional)
keytype = keytype_example # String | The Type of the userKey. (optional)
readModeSC = readModeSC_example # String | Read policy for SC (strong consistency) namespaces. Determines SC read consistency options. (optional)
readModeAP = readModeAP_example # String | Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode. (optional)
totalTimeout = 56 # Integer | Total transaction timeout in milliseconds. (optional)
socketTimeout = 56 # Integer | Socket idle timeout in milliseconds when processing a database command. (optional)
sleepBetweenRetries = 56 # Integer | Milliseconds to sleep between retries. (optional)
maxRetries = 56 # Integer | Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry. (optional)
predexp = predexp_example # String | Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored. (optional)
filterexp = filterexp_example # String | Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL. (optional)
compress = true # Boolean | Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes. (optional)
expiration = 56 # Integer | Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server. (optional)
generation = 56 # Integer | Expected generation. Generation is the number of times a record has been modified (including creation) on the server. (optional)
durableDelete = true # Boolean | If the transaction results in a record deletion, leave a tombstone for the record. (optional)
respondAllOps = true # Boolean | For client operate(), return a result for every operation. (optional)
commitLevel = commitLevel_example # String | Desired consistency guarantee when committing a transaction on the server. (optional)
generationPolicy = generationPolicy_example # String | Qualify how to handle record writes based on record generation. (optional)
recordExistsAction = recordExistsAction_example # String | How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods. (optional)

try: 
    # Delete an object in a document specified by a JSON path.
    api_instance.delete_document_object(namespace, key, recordBins, jsonPath, authorization=authorization, sendKey=sendKey, replica=replica, keytype=keytype, readModeSC=readModeSC, readModeAP=readModeAP, totalTimeout=totalTimeout, socketTimeout=socketTimeout, sleepBetweenRetries=sleepBetweenRetries, maxRetries=maxRetries, predexp=predexp, filterexp=filterexp, compress=compress, expiration=expiration, generation=generation, durableDelete=durableDelete, respondAllOps=respondAllOps, commitLevel=commitLevel, generationPolicy=generationPolicy, recordExistsAction=recordExistsAction)
except ApiException as e:
    print("Exception when calling DocumentAPIOperationsApi->deleteDocumentObject: %s\n" % e)

Parameters

Path parameters
Name Description
namespace*
String
Namespace for the record; equivalent to database name.
Required
key*
String
User key for the record.
Required
Header parameters
Name Description
Authorization
String
Query parameters
Name Description
sendKey
Boolean
Send user defined key in addition to hash digest on both reads and writes.
replica
String
Replica algorithm used to determine the target node for a single record command.
keytype
String
The Type of the userKey.
recordBins*
array[String]
Specify a set of bins to handle the JSONPath query.
Required
readModeSC
String
Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
readModeAP
String
Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
totalTimeout
Integer
Total transaction timeout in milliseconds.
socketTimeout
Integer
Socket idle timeout in milliseconds when processing a database command.
sleepBetweenRetries
Integer
Milliseconds to sleep between retries.
maxRetries
Integer
Maximum number of retries before aborting the current transaction. The initial attempt is not counted as a retry.
predexp
String
Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
filterexp
String
Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
compress
Boolean
Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
jsonPath*
String
JSONPath query parameter.
Required
expiration
Integer
Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server.
generation
Integer
Expected generation. Generation is the number of times a record has been modified (including creation) on the server.
durableDelete
Boolean
If the transaction results in a record deletion, leave a tombstone for the record.
respondAllOps
Boolean
For client operate(), return a result for every operation.
commitLevel
String
Desired consistency guarantee when committing a transaction on the server.
generationPolicy
String
Qualify how to handle record writes based on record generation.
recordExistsAction
String
How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods.

Responses

Status: 400 - Invalid parameters or request.

{"inDoubt":false,"message":"A message"}

Status: 403 - Not authorized to access the resource.

{"inDoubt":false,"message":"A message"}

Status: 404 - Record not found.

{"inDoubt":false,"message":"A message"}

deleteDocumentObjectSet

Delete an object in a document specified by a JSON path.


/v1/document/{namespace}/{set}/{key}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json,application/msgpack"\
"http://localhost:8080/v1/document/{namespace}/{set}/{key}?sendKey=&replica=&keytype=&recordBins=&readModeSC=&readModeAP=&totalTimeout=&socketTimeout=&sleepBetweenRetries=&maxRetries=&predexp=&filterexp=&compress=&jsonPath=&expiration=&generation=&durableDelete=&respondAllOps=&commitLevel=&generationPolicy=&recordExistsAction="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DocumentAPIOperationsApi;

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

public class DocumentAPIOperationsApiExample {

    public static void main(String[] args) {
        
        DocumentAPIOperationsApi apiInstance = new DocumentAPIOperationsApi();
        String namespace = namespace_example; // String | Namespace for the record; equivalent to database name.
        String set = set_example; // String | Set for the record; equivalent to database table.
        String key = key_example; // String | User key for the record.
        array[String] recordBins = ; // array[String] | Specify a set of bins to handle the JSONPath query.
        String jsonPath = jsonPath_example; // String | JSONPath query parameter.
        String authorization = authorization_example; // String | 
        Boolean sendKey = true; // Boolean | Send user defined key in addition to hash digest on both reads and writes.
        String replica = replica_example; // String | Replica algorithm used to determine the target node for a single record command.
        String keytype = keytype_example; // String | The Type of the userKey.
        String readModeSC = readModeSC_example; // String | Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
        String readModeAP = readModeAP_example; // String | Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
        Integer totalTimeout = 56; // Integer | Total transaction timeout in milliseconds.
        Integer socketTimeout = 56; // Integer | Socket idle timeout in milliseconds when processing a database command.
        Integer sleepBetweenRetries = 56; // Integer | Milliseconds to sleep between retries.
        Integer maxRetries = 56; // Integer | Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry.
        String predexp = predexp_example; // String | Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
        String filterexp = filterexp_example; // String | Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
        Boolean compress = true; // Boolean | Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
        Integer expiration = 56; // Integer | Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server.
        Integer generation = 56; // Integer | Expected generation. Generation is the number of times a record has been modified (including creation) on the server.
        Boolean durableDelete = true; // Boolean | If the transaction results in a record deletion, leave a tombstone for the record.
        Boolean respondAllOps = true; // Boolean | For client operate(), return a result for every operation.
        String commitLevel = commitLevel_example; // String | Desired consistency guarantee when committing a transaction on the server.
        String generationPolicy = generationPolicy_example; // String | Qualify how to handle record writes based on record generation.
        String recordExistsAction = recordExistsAction_example; // String | How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods.
        try {
            apiInstance.deleteDocumentObjectSet(namespace, set, key, recordBins, jsonPath, authorization, sendKey, replica, keytype, readModeSC, readModeAP, totalTimeout, socketTimeout, sleepBetweenRetries, maxRetries, predexp, filterexp, compress, expiration, generation, durableDelete, respondAllOps, commitLevel, generationPolicy, recordExistsAction);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentAPIOperationsApi#deleteDocumentObjectSet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DocumentAPIOperationsApi;

public class DocumentAPIOperationsApiExample {

    public static void main(String[] args) {
        DocumentAPIOperationsApi apiInstance = new DocumentAPIOperationsApi();
        String namespace = namespace_example; // String | Namespace for the record; equivalent to database name.
        String set = set_example; // String | Set for the record; equivalent to database table.
        String key = key_example; // String | User key for the record.
        array[String] recordBins = ; // array[String] | Specify a set of bins to handle the JSONPath query.
        String jsonPath = jsonPath_example; // String | JSONPath query parameter.
        String authorization = authorization_example; // String | 
        Boolean sendKey = true; // Boolean | Send user defined key in addition to hash digest on both reads and writes.
        String replica = replica_example; // String | Replica algorithm used to determine the target node for a single record command.
        String keytype = keytype_example; // String | The Type of the userKey.
        String readModeSC = readModeSC_example; // String | Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
        String readModeAP = readModeAP_example; // String | Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
        Integer totalTimeout = 56; // Integer | Total transaction timeout in milliseconds.
        Integer socketTimeout = 56; // Integer | Socket idle timeout in milliseconds when processing a database command.
        Integer sleepBetweenRetries = 56; // Integer | Milliseconds to sleep between retries.
        Integer maxRetries = 56; // Integer | Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry.
        String predexp = predexp_example; // String | Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
        String filterexp = filterexp_example; // String | Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
        Boolean compress = true; // Boolean | Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
        Integer expiration = 56; // Integer | Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server.
        Integer generation = 56; // Integer | Expected generation. Generation is the number of times a record has been modified (including creation) on the server.
        Boolean durableDelete = true; // Boolean | If the transaction results in a record deletion, leave a tombstone for the record.
        Boolean respondAllOps = true; // Boolean | For client operate(), return a result for every operation.
        String commitLevel = commitLevel_example; // String | Desired consistency guarantee when committing a transaction on the server.
        String generationPolicy = generationPolicy_example; // String | Qualify how to handle record writes based on record generation.
        String recordExistsAction = recordExistsAction_example; // String | How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods.
        try {
            apiInstance.deleteDocumentObjectSet(namespace, set, key, recordBins, jsonPath, authorization, sendKey, replica, keytype, readModeSC, readModeAP, totalTimeout, socketTimeout, sleepBetweenRetries, maxRetries, predexp, filterexp, compress, expiration, generation, durableDelete, respondAllOps, commitLevel, generationPolicy, recordExistsAction);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentAPIOperationsApi#deleteDocumentObjectSet");
            e.printStackTrace();
        }
    }
}
String *namespace = namespace_example; // Namespace for the record; equivalent to database name.
String *set = set_example; // Set for the record; equivalent to database table.
String *key = key_example; // User key for the record.
array[String] *recordBins = ; // Specify a set of bins to handle the JSONPath query.
String *jsonPath = jsonPath_example; // JSONPath query parameter.
String *authorization = authorization_example; //  (optional)
Boolean *sendKey = true; // Send user defined key in addition to hash digest on both reads and writes. (optional)
String *replica = replica_example; // Replica algorithm used to determine the target node for a single record command. (optional)
String *keytype = keytype_example; // The Type of the userKey. (optional)
String *readModeSC = readModeSC_example; // Read policy for SC (strong consistency) namespaces. Determines SC read consistency options. (optional)
String *readModeAP = readModeAP_example; // Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode. (optional)
Integer *totalTimeout = 56; // Total transaction timeout in milliseconds. (optional)
Integer *socketTimeout = 56; // Socket idle timeout in milliseconds when processing a database command. (optional)
Integer *sleepBetweenRetries = 56; // Milliseconds to sleep between retries. (optional)
Integer *maxRetries = 56; // Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry. (optional)
String *predexp = predexp_example; // Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored. (optional)
String *filterexp = filterexp_example; // Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL. (optional)
Boolean *compress = true; // Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes. (optional)
Integer *expiration = 56; // Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server. (optional)
Integer *generation = 56; // Expected generation. Generation is the number of times a record has been modified (including creation) on the server. (optional)
Boolean *durableDelete = true; // If the transaction results in a record deletion, leave a tombstone for the record. (optional)
Boolean *respondAllOps = true; // For client operate(), return a result for every operation. (optional)
String *commitLevel = commitLevel_example; // Desired consistency guarantee when committing a transaction on the server. (optional)
String *generationPolicy = generationPolicy_example; // Qualify how to handle record writes based on record generation. (optional)
String *recordExistsAction = recordExistsAction_example; // How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods. (optional)

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

// Delete an object in a document specified by a JSON path.
[apiInstance deleteDocumentObjectSetWith:namespace
    set:set
    key:key
    recordBins:recordBins
    jsonPath:jsonPath
    authorization:authorization
    sendKey:sendKey
    replica:replica
    keytype:keytype
    readModeSC:readModeSC
    readModeAP:readModeAP
    totalTimeout:totalTimeout
    socketTimeout:socketTimeout
    sleepBetweenRetries:sleepBetweenRetries
    maxRetries:maxRetries
    predexp:predexp
    filterexp:filterexp
    compress:compress
    expiration:expiration
    generation:generation
    durableDelete:durableDelete
    respondAllOps:respondAllOps
    commitLevel:commitLevel
    generationPolicy:generationPolicy
    recordExistsAction:recordExistsAction
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AerospikeRestClient = require('aerospike_rest_client');

var api = new AerospikeRestClient.DocumentAPIOperationsApi()
var namespace = namespace_example; // {{String}} Namespace for the record; equivalent to database name.
var set = set_example; // {{String}} Set for the record; equivalent to database table.
var key = key_example; // {{String}} User key for the record.
var recordBins = ; // {{array[String]}} Specify a set of bins to handle the JSONPath query.
var jsonPath = jsonPath_example; // {{String}} JSONPath query parameter.
var opts = { 
  'authorization': authorization_example, // {{String}} 
  'sendKey': true, // {{Boolean}} Send user defined key in addition to hash digest on both reads and writes.
  'replica': replica_example, // {{String}} Replica algorithm used to determine the target node for a single record command.
  'keytype': keytype_example, // {{String}} The Type of the userKey.
  'readModeSC': readModeSC_example, // {{String}} Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
  'readModeAP': readModeAP_example, // {{String}} Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
  'totalTimeout': 56, // {{Integer}} Total transaction timeout in milliseconds.
  'socketTimeout': 56, // {{Integer}} Socket idle timeout in milliseconds when processing a database command.
  'sleepBetweenRetries': 56, // {{Integer}} Milliseconds to sleep between retries.
  'maxRetries': 56, // {{Integer}} Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry.
  'predexp': predexp_example, // {{String}} Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
  'filterexp': filterexp_example, // {{String}} Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
  'compress': true, // {{Boolean}} Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
  'expiration': 56, // {{Integer}} Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server.
  'generation': 56, // {{Integer}} Expected generation. Generation is the number of times a record has been modified (including creation) on the server.
  'durableDelete': true, // {{Boolean}} If the transaction results in a record deletion, leave a tombstone for the record.
  'respondAllOps': true, // {{Boolean}} For client operate(), return a result for every operation.
  'commitLevel': commitLevel_example, // {{String}} Desired consistency guarantee when committing a transaction on the server.
  'generationPolicy': generationPolicy_example, // {{String}} Qualify how to handle record writes based on record generation.
  'recordExistsAction': recordExistsAction_example // {{String}} How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteDocumentObjectSet(namespace, set, key, recordBins, jsonPath, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DocumentAPIOperationsApi();
            var namespace = namespace_example;  // String | Namespace for the record; equivalent to database name.
            var set = set_example;  // String | Set for the record; equivalent to database table.
            var key = key_example;  // String | User key for the record.
            var recordBins = new array[String](); // array[String] | Specify a set of bins to handle the JSONPath query.
            var jsonPath = jsonPath_example;  // String | JSONPath query parameter.
            var authorization = authorization_example;  // String |  (optional) 
            var sendKey = true;  // Boolean | Send user defined key in addition to hash digest on both reads and writes. (optional) 
            var replica = replica_example;  // String | Replica algorithm used to determine the target node for a single record command. (optional) 
            var keytype = keytype_example;  // String | The Type of the userKey. (optional) 
            var readModeSC = readModeSC_example;  // String | Read policy for SC (strong consistency) namespaces. Determines SC read consistency options. (optional) 
            var readModeAP = readModeAP_example;  // String | Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode. (optional) 
            var totalTimeout = 56;  // Integer | Total transaction timeout in milliseconds. (optional) 
            var socketTimeout = 56;  // Integer | Socket idle timeout in milliseconds when processing a database command. (optional) 
            var sleepBetweenRetries = 56;  // Integer | Milliseconds to sleep between retries. (optional) 
            var maxRetries = 56;  // Integer | Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry. (optional) 
            var predexp = predexp_example;  // String | Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored. (optional) 
            var filterexp = filterexp_example;  // String | Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL. (optional) 
            var compress = true;  // Boolean | Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes. (optional) 
            var expiration = 56;  // Integer | Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server. (optional) 
            var generation = 56;  // Integer | Expected generation. Generation is the number of times a record has been modified (including creation) on the server. (optional) 
            var durableDelete = true;  // Boolean | If the transaction results in a record deletion, leave a tombstone for the record. (optional) 
            var respondAllOps = true;  // Boolean | For client operate(), return a result for every operation. (optional) 
            var commitLevel = commitLevel_example;  // String | Desired consistency guarantee when committing a transaction on the server. (optional) 
            var generationPolicy = generationPolicy_example;  // String | Qualify how to handle record writes based on record generation. (optional) 
            var recordExistsAction = recordExistsAction_example;  // String | How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods. (optional) 

            try
            {
                // Delete an object in a document specified by a JSON path.
                apiInstance.deleteDocumentObjectSet(namespace, set, key, recordBins, jsonPath, authorization, sendKey, replica, keytype, readModeSC, readModeAP, totalTimeout, socketTimeout, sleepBetweenRetries, maxRetries, predexp, filterexp, compress, expiration, generation, durableDelete, respondAllOps, commitLevel, generationPolicy, recordExistsAction);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DocumentAPIOperationsApi.deleteDocumentObjectSet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDocumentAPIOperationsApi();
$namespace = namespace_example; // String | Namespace for the record; equivalent to database name.
$set = set_example; // String | Set for the record; equivalent to database table.
$key = key_example; // String | User key for the record.
$recordBins = ; // array[String] | Specify a set of bins to handle the JSONPath query.
$jsonPath = jsonPath_example; // String | JSONPath query parameter.
$authorization = authorization_example; // String | 
$sendKey = true; // Boolean | Send user defined key in addition to hash digest on both reads and writes.
$replica = replica_example; // String | Replica algorithm used to determine the target node for a single record command.
$keytype = keytype_example; // String | The Type of the userKey.
$readModeSC = readModeSC_example; // String | Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
$readModeAP = readModeAP_example; // String | Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
$totalTimeout = 56; // Integer | Total transaction timeout in milliseconds.
$socketTimeout = 56; // Integer | Socket idle timeout in milliseconds when processing a database command.
$sleepBetweenRetries = 56; // Integer | Milliseconds to sleep between retries.
$maxRetries = 56; // Integer | Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry.
$predexp = predexp_example; // String | Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
$filterexp = filterexp_example; // String | Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
$compress = true; // Boolean | Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
$expiration = 56; // Integer | Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server.
$generation = 56; // Integer | Expected generation. Generation is the number of times a record has been modified (including creation) on the server.
$durableDelete = true; // Boolean | If the transaction results in a record deletion, leave a tombstone for the record.
$respondAllOps = true; // Boolean | For client operate(), return a result for every operation.
$commitLevel = commitLevel_example; // String | Desired consistency guarantee when committing a transaction on the server.
$generationPolicy = generationPolicy_example; // String | Qualify how to handle record writes based on record generation.
$recordExistsAction = recordExistsAction_example; // String | How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods.

try {
    $api_instance->deleteDocumentObjectSet($namespace, $set, $key, $recordBins, $jsonPath, $authorization, $sendKey, $replica, $keytype, $readModeSC, $readModeAP, $totalTimeout, $socketTimeout, $sleepBetweenRetries, $maxRetries, $predexp, $filterexp, $compress, $expiration, $generation, $durableDelete, $respondAllOps, $commitLevel, $generationPolicy, $recordExistsAction);
} catch (Exception $e) {
    echo 'Exception when calling DocumentAPIOperationsApi->deleteDocumentObjectSet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DocumentAPIOperationsApi;

my $api_instance = WWW::SwaggerClient::DocumentAPIOperationsApi->new();
my $namespace = namespace_example; # String | Namespace for the record; equivalent to database name.
my $set = set_example; # String | Set for the record; equivalent to database table.
my $key = key_example; # String | User key for the record.
my $recordBins = []; # array[String] | Specify a set of bins to handle the JSONPath query.
my $jsonPath = jsonPath_example; # String | JSONPath query parameter.
my $authorization = authorization_example; # String | 
my $sendKey = true; # Boolean | Send user defined key in addition to hash digest on both reads and writes.
my $replica = replica_example; # String | Replica algorithm used to determine the target node for a single record command.
my $keytype = keytype_example; # String | The Type of the userKey.
my $readModeSC = readModeSC_example; # String | Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
my $readModeAP = readModeAP_example; # String | Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
my $totalTimeout = 56; # Integer | Total transaction timeout in milliseconds.
my $socketTimeout = 56; # Integer | Socket idle timeout in milliseconds when processing a database command.
my $sleepBetweenRetries = 56; # Integer | Milliseconds to sleep between retries.
my $maxRetries = 56; # Integer | Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry.
my $predexp = predexp_example; # String | Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
my $filterexp = filterexp_example; # String | Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
my $compress = true; # Boolean | Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
my $expiration = 56; # Integer | Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server.
my $generation = 56; # Integer | Expected generation. Generation is the number of times a record has been modified (including creation) on the server.
my $durableDelete = true; # Boolean | If the transaction results in a record deletion, leave a tombstone for the record.
my $respondAllOps = true; # Boolean | For client operate(), return a result for every operation.
my $commitLevel = commitLevel_example; # String | Desired consistency guarantee when committing a transaction on the server.
my $generationPolicy = generationPolicy_example; # String | Qualify how to handle record writes based on record generation.
my $recordExistsAction = recordExistsAction_example; # String | How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods.

eval { 
    $api_instance->deleteDocumentObjectSet(namespace => $namespace, set => $set, key => $key, recordBins => $recordBins, jsonPath => $jsonPath, authorization => $authorization, sendKey => $sendKey, replica => $replica, keytype => $keytype, readModeSC => $readModeSC, readModeAP => $readModeAP, totalTimeout => $totalTimeout, socketTimeout => $socketTimeout, sleepBetweenRetries => $sleepBetweenRetries, maxRetries => $maxRetries, predexp => $predexp, filterexp => $filterexp, compress => $compress, expiration => $expiration, generation => $generation, durableDelete => $durableDelete, respondAllOps => $respondAllOps, commitLevel => $commitLevel, generationPolicy => $generationPolicy, recordExistsAction => $recordExistsAction);
};
if ($@) {
    warn "Exception when calling DocumentAPIOperationsApi->deleteDocumentObjectSet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DocumentAPIOperationsApi()
namespace = namespace_example # String | Namespace for the record; equivalent to database name.
set = set_example # String | Set for the record; equivalent to database table.
key = key_example # String | User key for the record.
recordBins =  # array[String] | Specify a set of bins to handle the JSONPath query.
jsonPath = jsonPath_example # String | JSONPath query parameter.
authorization = authorization_example # String |  (optional)
sendKey = true # Boolean | Send user defined key in addition to hash digest on both reads and writes. (optional)
replica = replica_example # String | Replica algorithm used to determine the target node for a single record command. (optional)
keytype = keytype_example # String | The Type of the userKey. (optional)
readModeSC = readModeSC_example # String | Read policy for SC (strong consistency) namespaces. Determines SC read consistency options. (optional)
readModeAP = readModeAP_example # String | Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode. (optional)
totalTimeout = 56 # Integer | Total transaction timeout in milliseconds. (optional)
socketTimeout = 56 # Integer | Socket idle timeout in milliseconds when processing a database command. (optional)
sleepBetweenRetries = 56 # Integer | Milliseconds to sleep between retries. (optional)
maxRetries = 56 # Integer | Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry. (optional)
predexp = predexp_example # String | Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored. (optional)
filterexp = filterexp_example # String | Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL. (optional)
compress = true # Boolean | Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes. (optional)
expiration = 56 # Integer | Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server. (optional)
generation = 56 # Integer | Expected generation. Generation is the number of times a record has been modified (including creation) on the server. (optional)
durableDelete = true # Boolean | If the transaction results in a record deletion, leave a tombstone for the record. (optional)
respondAllOps = true # Boolean | For client operate(), return a result for every operation. (optional)
commitLevel = commitLevel_example # String | Desired consistency guarantee when committing a transaction on the server. (optional)
generationPolicy = generationPolicy_example # String | Qualify how to handle record writes based on record generation. (optional)
recordExistsAction = recordExistsAction_example # String | How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods. (optional)

try: 
    # Delete an object in a document specified by a JSON path.
    api_instance.delete_document_object_set(namespace, set, key, recordBins, jsonPath, authorization=authorization, sendKey=sendKey, replica=replica, keytype=keytype, readModeSC=readModeSC, readModeAP=readModeAP, totalTimeout=totalTimeout, socketTimeout=socketTimeout, sleepBetweenRetries=sleepBetweenRetries, maxRetries=maxRetries, predexp=predexp, filterexp=filterexp, compress=compress, expiration=expiration, generation=generation, durableDelete=durableDelete, respondAllOps=respondAllOps, commitLevel=commitLevel, generationPolicy=generationPolicy, recordExistsAction=recordExistsAction)
except ApiException as e:
    print("Exception when calling DocumentAPIOperationsApi->deleteDocumentObjectSet: %s\n" % e)

Parameters

Path parameters
Name Description
namespace*
String
Namespace for the record; equivalent to database name.
Required
set*
String
Set for the record; equivalent to database table.
Required
key*
String
User key for the record.
Required
Header parameters
Name Description
Authorization
String
Query parameters
Name Description
sendKey
Boolean
Send user defined key in addition to hash digest on both reads and writes.
replica
String
Replica algorithm used to determine the target node for a single record command.
keytype
String
The Type of the userKey.
recordBins*
array[String]
Specify a set of bins to handle the JSONPath query.
Required
readModeSC
String
Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
readModeAP
String
Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
totalTimeout
Integer
Total transaction timeout in milliseconds.
socketTimeout
Integer
Socket idle timeout in milliseconds when processing a database command.
sleepBetweenRetries
Integer
Milliseconds to sleep between retries.
maxRetries
Integer
Maximum number of retries before aborting the current transaction. The initial attempt is not counted as a retry.
predexp
String
Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
filterexp
String
Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
compress
Boolean
Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
jsonPath*
String
JSONPath query parameter.
Required
expiration
Integer
Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server.
generation
Integer
Expected generation. Generation is the number of times a record has been modified (including creation) on the server.
durableDelete
Boolean
If the transaction results in a record deletion, leave a tombstone for the record.
respondAllOps
Boolean
For client operate(), return a result for every operation.
commitLevel
String
Desired consistency guarantee when committing a transaction on the server.
generationPolicy
String
Qualify how to handle record writes based on record generation.
recordExistsAction
String
How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods.

Responses

Status: 400 - Invalid parameters or request.

{"inDoubt":false,"message":"A message"}

Status: 403 - Not authorized to access the resource.

{"inDoubt":false,"message":"A message"}

Status: 404 - Record not found.

{"inDoubt":false,"message":"A message"}

getDocumentObject

Retrieve the object in the document with key documentKey that is referenced by the JSON path.


/v1/document/{namespace}/{key}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json,application/msgpack"\
"http://localhost:8080/v1/document/{namespace}/{key}?sendKey=&replica=&keytype=&recordBins=&readModeSC=&readModeAP=&totalTimeout=&socketTimeout=&sleepBetweenRetries=&maxRetries=&predexp=&filterexp=&compress=&jsonPath="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DocumentAPIOperationsApi;

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

public class DocumentAPIOperationsApiExample {

    public static void main(String[] args) {
        
        DocumentAPIOperationsApi apiInstance = new DocumentAPIOperationsApi();
        String namespace = namespace_example; // String | Namespace for the record; equivalent to database name.
        String key = key_example; // String | User key for the record.
        array[String] recordBins = ; // array[String] | Specify a set of bins to handle the JSONPath query.
        String jsonPath = jsonPath_example; // String | JSONPath query parameter.
        String authorization = authorization_example; // String | 
        Boolean sendKey = true; // Boolean | Send user defined key in addition to hash digest on both reads and writes.
        String replica = replica_example; // String | Replica algorithm used to determine the target node for a single record command.
        String keytype = keytype_example; // String | The Type of the userKey.
        String readModeSC = readModeSC_example; // String | Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
        String readModeAP = readModeAP_example; // String | Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
        Integer totalTimeout = 56; // Integer | Total transaction timeout in milliseconds.
        Integer socketTimeout = 56; // Integer | Socket idle timeout in milliseconds when processing a database command.
        Integer sleepBetweenRetries = 56; // Integer | Milliseconds to sleep between retries.
        Integer maxRetries = 56; // Integer | Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry.
        String predexp = predexp_example; // String | Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
        String filterexp = filterexp_example; // String | Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
        Boolean compress = true; // Boolean | Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
        try {
            apiInstance.getDocumentObject(namespace, key, recordBins, jsonPath, authorization, sendKey, replica, keytype, readModeSC, readModeAP, totalTimeout, socketTimeout, sleepBetweenRetries, maxRetries, predexp, filterexp, compress);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentAPIOperationsApi#getDocumentObject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DocumentAPIOperationsApi;

public class DocumentAPIOperationsApiExample {

    public static void main(String[] args) {
        DocumentAPIOperationsApi apiInstance = new DocumentAPIOperationsApi();
        String namespace = namespace_example; // String | Namespace for the record; equivalent to database name.
        String key = key_example; // String | User key for the record.
        array[String] recordBins = ; // array[String] | Specify a set of bins to handle the JSONPath query.
        String jsonPath = jsonPath_example; // String | JSONPath query parameter.
        String authorization = authorization_example; // String | 
        Boolean sendKey = true; // Boolean | Send user defined key in addition to hash digest on both reads and writes.
        String replica = replica_example; // String | Replica algorithm used to determine the target node for a single record command.
        String keytype = keytype_example; // String | The Type of the userKey.
        String readModeSC = readModeSC_example; // String | Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
        String readModeAP = readModeAP_example; // String | Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
        Integer totalTimeout = 56; // Integer | Total transaction timeout in milliseconds.
        Integer socketTimeout = 56; // Integer | Socket idle timeout in milliseconds when processing a database command.
        Integer sleepBetweenRetries = 56; // Integer | Milliseconds to sleep between retries.
        Integer maxRetries = 56; // Integer | Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry.
        String predexp = predexp_example; // String | Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
        String filterexp = filterexp_example; // String | Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
        Boolean compress = true; // Boolean | Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
        try {
            apiInstance.getDocumentObject(namespace, key, recordBins, jsonPath, authorization, sendKey, replica, keytype, readModeSC, readModeAP, totalTimeout, socketTimeout, sleepBetweenRetries, maxRetries, predexp, filterexp, compress);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentAPIOperationsApi#getDocumentObject");
            e.printStackTrace();
        }
    }
}
String *namespace = namespace_example; // Namespace for the record; equivalent to database name.
String *key = key_example; // User key for the record.
array[String] *recordBins = ; // Specify a set of bins to handle the JSONPath query.
String *jsonPath = jsonPath_example; // JSONPath query parameter.
String *authorization = authorization_example; //  (optional)
Boolean *sendKey = true; // Send user defined key in addition to hash digest on both reads and writes. (optional)
String *replica = replica_example; // Replica algorithm used to determine the target node for a single record command. (optional)
String *keytype = keytype_example; // The Type of the userKey. (optional)
String *readModeSC = readModeSC_example; // Read policy for SC (strong consistency) namespaces. Determines SC read consistency options. (optional)
String *readModeAP = readModeAP_example; // Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode. (optional)
Integer *totalTimeout = 56; // Total transaction timeout in milliseconds. (optional)
Integer *socketTimeout = 56; // Socket idle timeout in milliseconds when processing a database command. (optional)
Integer *sleepBetweenRetries = 56; // Milliseconds to sleep between retries. (optional)
Integer *maxRetries = 56; // Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry. (optional)
String *predexp = predexp_example; // Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored. (optional)
String *filterexp = filterexp_example; // Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL. (optional)
Boolean *compress = true; // Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes. (optional)

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

// Retrieve the object in the document with key documentKey that is referenced by the JSON path.
[apiInstance getDocumentObjectWith:namespace
    key:key
    recordBins:recordBins
    jsonPath:jsonPath
    authorization:authorization
    sendKey:sendKey
    replica:replica
    keytype:keytype
    readModeSC:readModeSC
    readModeAP:readModeAP
    totalTimeout:totalTimeout
    socketTimeout:socketTimeout
    sleepBetweenRetries:sleepBetweenRetries
    maxRetries:maxRetries
    predexp:predexp
    filterexp:filterexp
    compress:compress
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AerospikeRestClient = require('aerospike_rest_client');

var api = new AerospikeRestClient.DocumentAPIOperationsApi()
var namespace = namespace_example; // {{String}} Namespace for the record; equivalent to database name.
var key = key_example; // {{String}} User key for the record.
var recordBins = ; // {{array[String]}} Specify a set of bins to handle the JSONPath query.
var jsonPath = jsonPath_example; // {{String}} JSONPath query parameter.
var opts = { 
  'authorization': authorization_example, // {{String}} 
  'sendKey': true, // {{Boolean}} Send user defined key in addition to hash digest on both reads and writes.
  'replica': replica_example, // {{String}} Replica algorithm used to determine the target node for a single record command.
  'keytype': keytype_example, // {{String}} The Type of the userKey.
  'readModeSC': readModeSC_example, // {{String}} Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
  'readModeAP': readModeAP_example, // {{String}} Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
  'totalTimeout': 56, // {{Integer}} Total transaction timeout in milliseconds.
  'socketTimeout': 56, // {{Integer}} Socket idle timeout in milliseconds when processing a database command.
  'sleepBetweenRetries': 56, // {{Integer}} Milliseconds to sleep between retries.
  'maxRetries': 56, // {{Integer}} Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry.
  'predexp': predexp_example, // {{String}} Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
  'filterexp': filterexp_example, // {{String}} Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
  'compress': true // {{Boolean}} Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getDocumentObject(namespace, key, recordBins, jsonPath, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DocumentAPIOperationsApi();
            var namespace = namespace_example;  // String | Namespace for the record; equivalent to database name.
            var key = key_example;  // String | User key for the record.
            var recordBins = new array[String](); // array[String] | Specify a set of bins to handle the JSONPath query.
            var jsonPath = jsonPath_example;  // String | JSONPath query parameter.
            var authorization = authorization_example;  // String |  (optional) 
            var sendKey = true;  // Boolean | Send user defined key in addition to hash digest on both reads and writes. (optional) 
            var replica = replica_example;  // String | Replica algorithm used to determine the target node for a single record command. (optional) 
            var keytype = keytype_example;  // String | The Type of the userKey. (optional) 
            var readModeSC = readModeSC_example;  // String | Read policy for SC (strong consistency) namespaces. Determines SC read consistency options. (optional) 
            var readModeAP = readModeAP_example;  // String | Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode. (optional) 
            var totalTimeout = 56;  // Integer | Total transaction timeout in milliseconds. (optional) 
            var socketTimeout = 56;  // Integer | Socket idle timeout in milliseconds when processing a database command. (optional) 
            var sleepBetweenRetries = 56;  // Integer | Milliseconds to sleep between retries. (optional) 
            var maxRetries = 56;  // Integer | Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry. (optional) 
            var predexp = predexp_example;  // String | Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored. (optional) 
            var filterexp = filterexp_example;  // String | Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL. (optional) 
            var compress = true;  // Boolean | Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes. (optional) 

            try
            {
                // Retrieve the object in the document with key documentKey that is referenced by the JSON path.
                apiInstance.getDocumentObject(namespace, key, recordBins, jsonPath, authorization, sendKey, replica, keytype, readModeSC, readModeAP, totalTimeout, socketTimeout, sleepBetweenRetries, maxRetries, predexp, filterexp, compress);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DocumentAPIOperationsApi.getDocumentObject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDocumentAPIOperationsApi();
$namespace = namespace_example; // String | Namespace for the record; equivalent to database name.
$key = key_example; // String | User key for the record.
$recordBins = ; // array[String] | Specify a set of bins to handle the JSONPath query.
$jsonPath = jsonPath_example; // String | JSONPath query parameter.
$authorization = authorization_example; // String | 
$sendKey = true; // Boolean | Send user defined key in addition to hash digest on both reads and writes.
$replica = replica_example; // String | Replica algorithm used to determine the target node for a single record command.
$keytype = keytype_example; // String | The Type of the userKey.
$readModeSC = readModeSC_example; // String | Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
$readModeAP = readModeAP_example; // String | Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
$totalTimeout = 56; // Integer | Total transaction timeout in milliseconds.
$socketTimeout = 56; // Integer | Socket idle timeout in milliseconds when processing a database command.
$sleepBetweenRetries = 56; // Integer | Milliseconds to sleep between retries.
$maxRetries = 56; // Integer | Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry.
$predexp = predexp_example; // String | Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
$filterexp = filterexp_example; // String | Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
$compress = true; // Boolean | Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.

try {
    $api_instance->getDocumentObject($namespace, $key, $recordBins, $jsonPath, $authorization, $sendKey, $replica, $keytype, $readModeSC, $readModeAP, $totalTimeout, $socketTimeout, $sleepBetweenRetries, $maxRetries, $predexp, $filterexp, $compress);
} catch (Exception $e) {
    echo 'Exception when calling DocumentAPIOperationsApi->getDocumentObject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DocumentAPIOperationsApi;

my $api_instance = WWW::SwaggerClient::DocumentAPIOperationsApi->new();
my $namespace = namespace_example; # String | Namespace for the record; equivalent to database name.
my $key = key_example; # String | User key for the record.
my $recordBins = []; # array[String] | Specify a set of bins to handle the JSONPath query.
my $jsonPath = jsonPath_example; # String | JSONPath query parameter.
my $authorization = authorization_example; # String | 
my $sendKey = true; # Boolean | Send user defined key in addition to hash digest on both reads and writes.
my $replica = replica_example; # String | Replica algorithm used to determine the target node for a single record command.
my $keytype = keytype_example; # String | The Type of the userKey.
my $readModeSC = readModeSC_example; # String | Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
my $readModeAP = readModeAP_example; # String | Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
my $totalTimeout = 56; # Integer | Total transaction timeout in milliseconds.
my $socketTimeout = 56; # Integer | Socket idle timeout in milliseconds when processing a database command.
my $sleepBetweenRetries = 56; # Integer | Milliseconds to sleep between retries.
my $maxRetries = 56; # Integer | Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry.
my $predexp = predexp_example; # String | Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
my $filterexp = filterexp_example; # String | Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
my $compress = true; # Boolean | Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.

eval { 
    $api_instance->getDocumentObject(namespace => $namespace, key => $key, recordBins => $recordBins, jsonPath => $jsonPath, authorization => $authorization, sendKey => $sendKey, replica => $replica, keytype => $keytype, readModeSC => $readModeSC, readModeAP => $readModeAP, totalTimeout => $totalTimeout, socketTimeout => $socketTimeout, sleepBetweenRetries => $sleepBetweenRetries, maxRetries => $maxRetries, predexp => $predexp, filterexp => $filterexp, compress => $compress);
};
if ($@) {
    warn "Exception when calling DocumentAPIOperationsApi->getDocumentObject: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DocumentAPIOperationsApi()
namespace = namespace_example # String | Namespace for the record; equivalent to database name.
key = key_example # String | User key for the record.
recordBins =  # array[String] | Specify a set of bins to handle the JSONPath query.
jsonPath = jsonPath_example # String | JSONPath query parameter.
authorization = authorization_example # String |  (optional)
sendKey = true # Boolean | Send user defined key in addition to hash digest on both reads and writes. (optional)
replica = replica_example # String | Replica algorithm used to determine the target node for a single record command. (optional)
keytype = keytype_example # String | The Type of the userKey. (optional)
readModeSC = readModeSC_example # String | Read policy for SC (strong consistency) namespaces. Determines SC read consistency options. (optional)
readModeAP = readModeAP_example # String | Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode. (optional)
totalTimeout = 56 # Integer | Total transaction timeout in milliseconds. (optional)
socketTimeout = 56 # Integer | Socket idle timeout in milliseconds when processing a database command. (optional)
sleepBetweenRetries = 56 # Integer | Milliseconds to sleep between retries. (optional)
maxRetries = 56 # Integer | Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry. (optional)
predexp = predexp_example # String | Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored. (optional)
filterexp = filterexp_example # String | Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL. (optional)
compress = true # Boolean | Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes. (optional)

try: 
    # Retrieve the object in the document with key documentKey that is referenced by the JSON path.
    api_instance.get_document_object(namespace, key, recordBins, jsonPath, authorization=authorization, sendKey=sendKey, replica=replica, keytype=keytype, readModeSC=readModeSC, readModeAP=readModeAP, totalTimeout=totalTimeout, socketTimeout=socketTimeout, sleepBetweenRetries=sleepBetweenRetries, maxRetries=maxRetries, predexp=predexp, filterexp=filterexp, compress=compress)
except ApiException as e:
    print("Exception when calling DocumentAPIOperationsApi->getDocumentObject: %s\n" % e)

Parameters

Path parameters
Name Description
namespace*
String
Namespace for the record; equivalent to database name.
Required
key*
String
User key for the record.
Required
Header parameters
Name Description
Authorization
String
Query parameters
Name Description
sendKey
Boolean
Send user defined key in addition to hash digest on both reads and writes.
replica
String
Replica algorithm used to determine the target node for a single record command.
keytype
String
The Type of the userKey.
recordBins*
array[String]
Specify a set of bins to handle the JSONPath query.
Required
readModeSC
String